feat(openapi): adding a command to resolve circular and recursive references

[olehshh]

🚥 Resolves RM-10283

🧰 Changes

1. Adding a script to automate the workaround for circular and recursive references.
2. Adding this command to the list of existing ones.

🧬 QA & Testing

Take any file with circular references, for example

openapi: 3.0.0
info:
  title: Cyclic Reference Example
  version: 1.0.0
paths:
  /example:
    get:
      summary: Example endpoint with cyclic references
      responses:
        '200':
          description: Successful response
components:
  Schemas:
    ObjectC:
      type: object
      properties:
        test:
          type: string
    ObjectA:
      type: object
      properties:
        test:
          type: string
        relatedObject:
          $ref: '#/components/schemas/ObjectB'
    ObjectB:
      type: object
      properties:
        test:
          type: string
        relatedObject:
          type: array
          items:
            $ref: '#/components/schemas/ObjectA'
        test2:
          $ref: '#/components/schemas/ObjectC' 

Execute the rdme openapi:refs [path] command and use inspect to check for circular references after execution. The command also handles recursiveness.

[kanadgupta]

looks great so far! haven't had a chance to properly test this yet, but some preliminary feedback below! also if you could add some docs in README.md that'd be great. thanks!

[kanadgupta]

rather than using this static method to read the file, can you use our existing prepareOas function? see an example here:

rdme/src/cmds/openapi/convert.ts

Line 57 in 5db25a1

const { preparedSpec, specPath, specType } = await prepareOas(spec, 'openapi:convert', { convertToLatest: true });

[kanadgupta]

rather than overwriting the existing file, can you add a prompt (and a corresponding --out flag) so users can specify what the updated file path should be? see here for an example:

rdme/src/cmds/openapi/convert.ts

Lines 66 to 85 in 5db25a1

	prompts.override({
	outputPath: opts.out,
	});
	const promptResults = await promptTerminal([
	{
	type: 'text',
	name: 'outputPath',
	message: 'Enter the path to save your converted/bundled API definition to:',
	initial: () => {
	const extension = path.extname(specPath);
	return `${path.basename(specPath).split(extension)[0]}.openapi${extension}`;
	},
	validate: value => validateFilePath(value),
	},
	]);
	Command.debug(`saving converted/bundled spec to ${promptResults.outputPath}`);
	fs.writeFileSync(promptResults.outputPath, JSON.stringify(parsedPreparedSpec, null, 2));

[kanadgupta]

DM'd you about this but this has a few merge conflicts now with the changes that were shipped in #1068 — happy to help with these if you need a hand!

[olehshh]

A provisional approach to prevent modifications to files with unresolved references that cannot currently be addressed.