update swagger and add it to docs

[slashburygin]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the project's documentation by integrating the OpenAPI specification directly into the MkDocs site. This change makes the User API documentation more accessible and dynamic for developers, ensuring that API specifications are easily viewable alongside other project documentation.

Highlights

• OpenAPI Documentation: A new documentation page (docs/openapi/openapi.md) was added to display the OpenAPI specification for the User API using the !!swagger macro.
• MkDocs Integration: The mkdocs.yml configuration was updated to enable the render_swagger plugin and include the new OpenAPI page in the site's navigation.
• Dependency Updates: The pyproject.toml file was modified to include ruamel-yaml and mkdocs-render-swagger-plugin as new dependencies for the documentation build process.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the Swagger/OpenAPI specification and integrates it into the documentation using the mkdocs-render-swagger-plugin. The changes involve adding the plugin to pyproject.toml, including the OpenAPI specification in mkdocs.yml navigation, and creating a markdown file to display the Swagger UI. I have added a review comment to address a missing dependency.

[gemini-code-assist]

The ruamel-yaml dependency is added to the test group. While it might be used in tests, it's more directly related to the mkdocs-render-swagger-plugin which uses it to parse YAML files. It would be more appropriate to include it in the docs group to ensure it's available when building the documentation.

Consider moving this dependency to the docs group.

    "dnspython>=2.6.0,<3.0.0",  # ISC License
]

docs = [
    "mkdocs-material==9.1.0",
    "mkdocs-glightbox",
    "mkdocs-render-swagger-plugin",
    "ruamel-yaml==0.17.26",
]