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.

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

CLI does not respect upload vs update in ^v10 #1151

Open
nhall97 opened this issue Jan 22, 2025 · 1 comment
Open

CLI does not respect upload vs update in ^v10 #1151

nhall97 opened this issue Jan 22, 2025 · 1 comment
Labels
command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands question Further information is requested

Comments

@nhall97
Copy link

nhall97 commented Jan 22, 2025

Per the documentation on CLI V10, there is no longer a separate update functionality - and we should use upload.

First publish works fine, then proceeding updates do not work for the CLI. The CLI throws an error where it indicated where the updateAPI needs to be updated.

How is this meant to be handled by CLI users as we only have the upload command available in V10.

https://github.com/readmeio/rdme/blob/next/documentation/commands/openapi.md#rdme-openapi-upload-spec

readme-docs-automation $npx rdme@v10 openapi upload https://staging.XXX.com/api/docs/Public-APIs --key={REDACTED}              
✔ Creating your API definition to ReadMe... done!
🚀 Your API definition (Public-APIs) was successfully created in ReadMe!


readme-docs-automation $npx rdme@v10 openapi upload https://staging.XXX.com/api/docs/Public-APIs --key={REDACTED}
✖ Creating your API definition to ReadMe...
The ReadMe API returned the following error:

An API reference by that name already exists. Did you mean to update that one instead?

If you intended to update this API you should use the `updateAPI` operation instead.

We are on Gitlab and so Github Actions is not a viable solution as part of the V10 upgrade.

#1116

@kanadgupta kanadgupta added bug command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands question Further information is requested and removed bug labels Jan 22, 2025
@kanadgupta
Copy link
Member

Thanks for writing in @nhall97 — this is very likely a bug. Can you get in touch with us at [email protected] and send us your debug logs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants