Skip to content
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.

Sign up for GitHub

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

chore(deps): bump #782

Merged
merged 5 commits into from
Mar 23, 2023
Merged

chore(deps): bump #782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2d0d0a7
chore: bump deps
kanadgupta Mar 23, 2023
f09386e
test: fix snapshots
kanadgupta Mar 23, 2023
1fdc461
chore: add `open` to dependabot exclusions 😭
kanadgupta Mar 23, 2023
9e194cc
chore(deps): bump typescript
kanadgupta Mar 23, 2023
1f63a45
Revert "chore(deps): bump typescript"
kanadgupta Mar 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ updates:
- dependency-name: ora
versions:
- '>= 6'
- dependency-name: open
versions:
- '>= 9'
169 changes: 97 additions & 72 deletions __tests__/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,40 @@ Usage

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
--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 a Swagger or Postman Collection to OpenAPI.
$ 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:validate Validate your OpenAPI/Swagger definition.
$ rdme openapi:convert Convert a Swagger or Postman Collection to OpenAPI.
$ 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:validate Validate your OpenAPI/Swagger definition.
"
`;

Expand All @@ -49,32 +57,40 @@ Usage

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
--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 a Swagger or Postman Collection to OpenAPI.
$ 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:validate Validate your OpenAPI/Swagger definition.
$ rdme openapi:convert Convert a Swagger or Postman Collection to OpenAPI.
$ 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:validate Validate your OpenAPI/Swagger definition.
"
`;

Expand All @@ -88,32 +104,40 @@ Usage

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
--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 a Swagger or Postman Collection to OpenAPI.
$ 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:validate Validate your OpenAPI/Swagger definition.
$ rdme openapi:convert Convert a Swagger or Postman Collection to OpenAPI.
$ 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:validate Validate your OpenAPI/Swagger definition.
"
`;

Expand All @@ -133,8 +157,9 @@ Options

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.
$ 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.
"
`;
4 changes: 3 additions & 1 deletion __tests__/cmds/openapi/__snapshots__/inspect.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ exports[`rdme openapi:inspect feature reports should generate a report for @read
polymorphism:
· #/components/responses/authForbidden/content/application~1json/schema
· #/components/responses/authUnauthorized/content/application~1json/schema
· #/components/schemas/docSchemaPost
· #/components/schemas/error_APIKEY_EMPTY
· #/components/schemas/error_APIKEY_MISMATCH
· #/components/schemas/error_APIKEY_NOTFOUND
Expand All @@ -23,6 +24,7 @@ polymorphism:
· #/components/schemas/error_INTERNAL_ERROR
· #/components/schemas/error_PROJECT_NEEDSSTAGING
· #/components/schemas/error_PROJECT_NOTFOUND
· #/components/schemas/error_RATE_LIMITED
· #/components/schemas/error_REGISTRY_INVALID
· #/components/schemas/error_REGISTRY_NOTFOUND
· #/components/schemas/error_SPEC_FILE_EMPTY
Expand Down Expand Up @@ -255,7 +257,7 @@ OpenAPI Features
┌──────────────────────┬───────┬──────────────────────────────────────────────────────────────────────────────────┐
│ Feature │ Used? │ Description │
├──────────────────────┼───────┼──────────────────────────────────────────────────────────────────────────────────┤
│ additionalProperties │ │ additionalProperties allows you to document dictionaries where the keys are │
│ additionalProperties │ ✅ │ additionalProperties allows you to document dictionaries where the keys are │
│ │ │ user-supplied strings. │
│ │ │ │
│ │ │ https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema- │
Expand Down
Loading