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

Added warning about OpenAPI definitions #9014

Conversation

Realmbird
Copy link
Contributor

Closes #8474

Add warning about OpenAPI definitions that swagger only includes subset of api and people should view developer's docs for the full set.

Technical

Adds more to open library swagger docs page adding disclaimer that it is not all of the docs.

Testing

  1. docker compose up
    2. http://localhost:8080/
  2. Go to add swagger/docs#/ to url or http://localhost:8080/swagger/docs#/
  3. View changed swagger docs page

Screenshot

Before
Screenshot from 2024-04-02 14-02-04
After
Screenshot from 2024-04-02 14-05-30

Stakeholders

@RayBB

Copy link
Collaborator

@RayBB RayBB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's just what we want. Nice job 👍
Now we just need staff to merge it.

@RayBB RayBB added the Needs: Staff / Internal Reviewed a PR but don't have merge powers? Use this. label Apr 2, 2024
@cdrini cdrini merged commit a8c037a into internetarchive:master Apr 8, 2024
4 checks passed
Achorn pushed a commit to Achorn/openlibrary that referenced this pull request Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Staff / Internal Reviewed a PR but don't have merge powers? Use this.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add warning about OpenAPI definitions
3 participants