-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(openapi): adding a command to resolve circular and recursive references #1063
Open
olehshh
wants to merge
63
commits into
v9
Choose a base branch
from
oleh/openapi-adding-command-to-solve-circularity-and-recursiveness
base: v9
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,340
−2
Open
Changes from 1 commit
Commits
Show all changes
63 commits
Select commit
Hold shift + click to select a range
59bb8f2
Adding refs to the list of openapi commands
d82700a
Code to execute the openapi:refs command
099a6f1
style: apply Prettier formatting
95208cf
Add 'openapi:refs' command and update related test snapshots
6249347
docs(openapi) command description
0a5f141
fix(openapi) use of a premade solution for processing a file
03c092c
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 3660917
chore: update package-lock.json
7ca5197
Merge branch 'next' of https://github.com/readmeio/rdme into oleh/ope…
597ece5
refactor: align code with recent updates
0b87569
Merge branch 'oleh/openapi-adding-command-to-solve-circularity-and-re…
3039ea0
chore: minor correction
dca7b9f
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 349b9f8
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 88bd34e
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 0a3c4e0
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 0c0027e
test: openapi:refs
18f7b4e
Merge branch 'oleh/openapi-adding-command-to-solve-circularity-and-re…
8fcc065
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 9fa0ca3
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh a4b1fc0
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh c0aa486
Merge remote-tracking branch 'origin/next' into oleh/openapi-adding-c…
d938932
docs: updating documentation after merge
44571ae
chore: small text change
3f1795b
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh b01b18a
refactor: align code with recent updates
1d1c7e2
feat: add check and display appropriate message for files that cannot…
1a25b65
test: unresolvable files
751c52a
chore: gaps
19875c1
feat: processing of circularity that cannot be processed
43f2c82
test: unprocessable files
37f4d5b
chore: correction
e8d2b9a
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh b293e72
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
e2a0948
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 87bdd5e
refactor: requested changes
91dbb5a
chore: deleting a file
6de2193
chore: oops
a55dd14
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
ce09500
refactor: requested changes
b224ec6
fix: `openapi:refs` touch ups (#1103)
kanadgupta 9c037c9
test: schemes without properties
da5b0ad
Merge remote-tracking branch 'origin' into oleh/openapi-adding-comman…
9249d2a
chore: minor updates
dd02080
Revert "chore: minor updates"
4355f9c
chore: minor updates
a7d8555
chore: lint
f010a7d
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh f7e52bf
feat: processing schemas with only (beta)
8bcf655
Merge branch 'oleh/openapi-adding-command-to-solve-circularity-and-re…
2667d1b
chore: lint
1d119f2
chore: cleanup
e790dec
chore: cleanup
ae39d1e
test: complex case
6e65d9f
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 91958bd
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 09b8039
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 4011248
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 0400bae
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
olehshh 5df03c2
Merge branch 'v9' into oleh/openapi-adding-command-to-solve-circulari…
olehshh 3721546
Merge branch 'v9' into oleh/openapi-adding-command-to-solve-circulari…
olehshh 304072d
chore: suggestion to contact support in case of certain errors
ec3768a
chore: cleanup
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading status checks…
Merge branch 'next' into oleh/openapi-adding-command-to-solve-circula…
…rity-and-recursiveness
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,186 +0,0 @@ | ||
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html | ||
|
||
exports[`cli > --help > should not surface args that are designated as hidden 1`] = ` | ||
" | ||
Upload, or resync, your OpenAPI/Swagger definition to ReadMe. | ||
|
||
Usage | ||
|
||
rdme openapi [file|url] [options] | ||
|
||
Options | ||
|
||
--key string Project API key | ||
--id string Unique identifier for your API definition. Use | ||
this if you're re-uploading an existing API | ||
definition. | ||
--version string Project version. If running command in a CI | ||
environment and this option is not passed, the | ||
main project version will be used. | ||
--workingDirectory string Working directory (for usage with relative | ||
external references) | ||
--useSpecVersion Uses the version listed in the \`info.version\` | ||
field in the API definition for the project | ||
version parameter. | ||
--raw Return the command results as a JSON object | ||
instead of a pretty output. | ||
--github Create a new GitHub Actions workflow for this | ||
command. | ||
--create Bypasses the create/update prompt and creates a | ||
new API definition. | ||
--update Automatically update an existing API definition | ||
in ReadMe if it's the only one associated with | ||
the current version. | ||
--title string An override value for the \`info.title\` field in | ||
the API definition | ||
--dryRun Runs the command without creating/updating any | ||
API Definitions in ReadMe. Useful for debugging. | ||
-h, --help Display this usage guide | ||
|
||
Related commands | ||
|
||
$ rdme openapi:convert Convert an API definition to OpenAPI and bundle any | ||
external references. | ||
$ rdme openapi:inspect Analyze an OpenAPI/Swagger definition for various | ||
OpenAPI and ReadMe feature usage. | ||
$ rdme openapi:reduce Reduce an OpenAPI definition into a smaller subset. | ||
$ rdme openapi:refs The script resolves circular and recursive | ||
references in OpenAPI by replacing them with object | ||
schemas. However, not all circular references can | ||
be resolved. You can run the openapi:inspect | ||
command to identify which references remain | ||
unresolved. | ||
$ rdme openapi:validate Validate your OpenAPI/Swagger definition. | ||
" | ||
`; | ||
|
||
exports[`cli > --help > should print usage for a given command 1`] = ` | ||
" | ||
Upload, or resync, your OpenAPI/Swagger definition to ReadMe. | ||
|
||
Usage | ||
|
||
rdme openapi [file|url] [options] | ||
|
||
Options | ||
|
||
--key string Project API key | ||
--id string Unique identifier for your API definition. Use | ||
this if you're re-uploading an existing API | ||
definition. | ||
--version string Project version. If running command in a CI | ||
environment and this option is not passed, the | ||
main project version will be used. | ||
--workingDirectory string Working directory (for usage with relative | ||
external references) | ||
--useSpecVersion Uses the version listed in the \`info.version\` | ||
field in the API definition for the project | ||
version parameter. | ||
--raw Return the command results as a JSON object | ||
instead of a pretty output. | ||
--github Create a new GitHub Actions workflow for this | ||
command. | ||
--create Bypasses the create/update prompt and creates a | ||
new API definition. | ||
--update Automatically update an existing API definition | ||
in ReadMe if it's the only one associated with | ||
the current version. | ||
--title string An override value for the \`info.title\` field in | ||
the API definition | ||
--dryRun Runs the command without creating/updating any | ||
API Definitions in ReadMe. Useful for debugging. | ||
-h, --help Display this usage guide | ||
|
||
Related commands | ||
|
||
$ rdme openapi:convert Convert an API definition to OpenAPI and bundle any | ||
external references. | ||
$ rdme openapi:inspect Analyze an OpenAPI/Swagger definition for various | ||
OpenAPI and ReadMe feature usage. | ||
$ rdme openapi:reduce Reduce an OpenAPI definition into a smaller subset. | ||
$ rdme openapi:refs The script resolves circular and recursive | ||
references in OpenAPI by replacing them with object | ||
schemas. However, not all circular references can | ||
be resolved. You can run the openapi:inspect | ||
command to identify which references remain | ||
unresolved. | ||
$ rdme openapi:validate Validate your OpenAPI/Swagger definition. | ||
" | ||
`; | ||
|
||
exports[`cli > --help > should print usage for a given command if supplied as \`help <command>\` 1`] = ` | ||
" | ||
Upload, or resync, your OpenAPI/Swagger definition to ReadMe. | ||
|
||
Usage | ||
|
||
rdme openapi [file|url] [options] | ||
|
||
Options | ||
|
||
--key string Project API key | ||
--id string Unique identifier for your API definition. Use | ||
this if you're re-uploading an existing API | ||
definition. | ||
--version string Project version. If running command in a CI | ||
environment and this option is not passed, the | ||
main project version will be used. | ||
--workingDirectory string Working directory (for usage with relative | ||
external references) | ||
--useSpecVersion Uses the version listed in the \`info.version\` | ||
field in the API definition for the project | ||
version parameter. | ||
--raw Return the command results as a JSON object | ||
instead of a pretty output. | ||
--github Create a new GitHub Actions workflow for this | ||
command. | ||
--create Bypasses the create/update prompt and creates a | ||
new API definition. | ||
--update Automatically update an existing API definition | ||
in ReadMe if it's the only one associated with | ||
the current version. | ||
--title string An override value for the \`info.title\` field in | ||
the API definition | ||
--dryRun Runs the command without creating/updating any | ||
API Definitions in ReadMe. Useful for debugging. | ||
-h, --help Display this usage guide | ||
|
||
Related commands | ||
|
||
$ rdme openapi:convert Convert an API definition to OpenAPI and bundle any | ||
external references. | ||
$ rdme openapi:inspect Analyze an OpenAPI/Swagger definition for various | ||
OpenAPI and ReadMe feature usage. | ||
$ rdme openapi:reduce Reduce an OpenAPI definition into a smaller subset. | ||
$ rdme openapi:refs The script resolves circular and recursive | ||
references in OpenAPI by replacing them with object | ||
schemas. However, not all circular references can | ||
be resolved. You can run the openapi:inspect | ||
command to identify which references remain | ||
unresolved. | ||
$ rdme openapi:validate Validate your OpenAPI/Swagger definition. | ||
" | ||
`; | ||
|
||
exports[`cli > --help > should show related commands for a subcommands help menu 1`] = ` | ||
" | ||
List versions available in your project or get a version by SemVer (https://semver.org/). | ||
|
||
Usage | ||
|
||
rdme versions [options] | ||
|
||
Options | ||
|
||
--key string Project API key | ||
--version string A specific project version to view. | ||
-h, --help Display this usage guide | ||
|
||
Related commands | ||
|
||
$ rdme versions:create Create a new version for your project. | ||
$ rdme versions:delete Delete a version associated with your ReadMe | ||
project. | ||
$ rdme versions:update Update an existing version for your project. | ||
" | ||
`; | ||
Oops, something went wrong.
You are viewing a condensed version of this merge commit. You can view the full changes here.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you delete this file?