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

Overwriting docs doesn't update subpages (tags) #1173

Open
jarrodparkes opened this issue Feb 20, 2025 · 2 comments
Open

Overwriting docs doesn't update subpages (tags) #1173

jarrodparkes opened this issue Feb 20, 2025 · 2 comments
Labels
command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands question Further information is requested

Comments

@jarrodparkes
Copy link
Contributor

Whenever I run a command like...

openapi upload {spec} --key={key} --slug={slug} --useSpecVersion

I am able to see in the UI that the doc/spec is updated; however, the subpages do not update. The subpages appear to be determined by OAS tags, but if I introduce a new tag, a subpage does not appear after the update. If I remove a tag completely, the existing subpage is still shown.

Is this expected?

I have the impression that maybe I'm running into some strangeness because with the newest version of readme, we should be utilizing the new GitHub syncing functionality vs pushing up spec/docs with the CLI?

@kanadgupta kanadgupta added question Further information is requested command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands labels Feb 24, 2025
@kanadgupta
Copy link
Member

@jarrodparkes I'm not quite sure I'm following. Could you provide the following:

  • example commands, along with the corresponding OpenAPI files
  • links to pages in a ReadMe project (along with descriptions of the expected/unexpected behavior)

Thanks!

@jarrodparkes
Copy link
Contributor Author

@kanadgupta everything is available at https://test-api-abzf.readme.io/reference

with petstore-1.json I ran...

npx rdme@10 openapi upload petstore-1.json --key={key} --slug=Petstore

then, I modified the spec a little:

  • removed the user tag from the tags array
  • for paths using the old user tag, replaced them with the pet tag
  • the resulting spec is petstore-2.json

and I ran

npx rdme@10 openapi upload petstore-2.json --key={key} --slug=Petstore

the resulting docs still contain the user page with all the existing endpoints

Image

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