Docs: revised the push command for openapi-cli #363
Merged
Conversation
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
ivana-isadora
previously requested changes
Sep 6, 2021
adamaltman
reviewed
Sep 21, 2021
13 tasks
| ::: | ||
|
|
||
| By default, the `push` command only updates an existing API definition version. If an API with the provided name and version doesn't exist in your organization, it will not be created automatically, and the command will exit with an error exit code. | ||
|
|
There was a problem hiding this comment.
suggestion: maybe reword this "..the command will display an error code before exiting"
There was a problem hiding this comment.
I think there may actually be a bug, because it should also have an exit code if there is an error... and it might not.
ivana-isadora
suggested changes
Oct 19, 2021
ivana-isadora
approved these changes
Oct 26, 2021
RomanHotsiy
reviewed
Oct 27, 2021
docs/commands/login.md
Outdated
| By default, the `push` command only updates an existing API definition version. If an API with the provided name and version doesn't exist in your organization, it will not be created automatically. Proceed to the [Create a new API with push](#create-a-new-api-with-push) section for more details on how to create an API manually. | ||
|
|
||
| :::warning | ||
| Note that only API definitions with a CI source can be updated with the `push` command. Attempting to update API definitions created from other sources will fail with an error. |
There was a problem hiding this comment.
I believe it's not how it works. I believe it will override the source type of the definition. Someone need to double check..
swapnilogale
approved these changes
Oct 27, 2021
adamaltman
requested changes
Oct 27, 2021
docs/commands/login.md
Outdated
|
|
||
| To work with the API registry without granting Redocly Workflows access to your repositories, you can use the OpenAPI CLI `push` command and set up your own CI pipeline to update API definitions without granting Redocly Workflows access to your repositories. This way, you can: | ||
|
|
||
| - Control the frequency of API definition updates. |
There was a problem hiding this comment.
How? I don't think it gives any additional control.
adamaltman
requested changes
Nov 23, 2021
adamaltman
reviewed
Nov 24, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What/Why/How?
Reference
Testing
Screenshots (optional)
Check yourself
Security