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

Generating an OpenAPI Schema automatically #90

Closed
wants to merge 1 commit into from
Closed

Generating an OpenAPI Schema automatically #90

wants to merge 1 commit into from

Conversation

Lugrim
Copy link
Contributor

@Lugrim Lugrim commented Oct 25, 2023

We may still want to tweak it a bit

  • Check if it is possible to sort in categories
  • Add the generation of the schema to the manual CI
  • Tweak all the auto-generated documentation to ensure it really represents the reality

Will close #89 when merged

@Lugrim Lugrim added documentation Improvements or additions to documentation enhancement New feature or request priority:medium Medium Priority labels Oct 25, 2023
@Lymkwi
Copy link
Collaborator

Lymkwi commented Oct 27, 2023

So how does this work? Is there a command to run? Is it supposed to expose a specific API endpoint?

@Lugrim
Copy link
Contributor Author

Lugrim commented Oct 29, 2023

So how does this work? Is there a command to run? Is it supposed to expose a specific API endpoint?

For now there's a command, I use docker exec -it infra-insalanfr-beta-backend-1 python manage.py generateschema --file openapi-schema.yml when pyyaml and uritemplate are installed in the docker, but I'm thinking about addind a CI to directly generate a schema then a swagger that would be deployed as every other documentation statics

@Lugrim
Copy link
Contributor Author

Lugrim commented Nov 19, 2023

Ok so exploring this a bit, it will require a lot of work to ensure everything in the existing code base is right and correctly documented since we do some serialization by hand. We can put this on hold for later.

@Lugrim Lugrim added priority:low Low Priority and removed priority:medium Medium Priority labels Nov 19, 2023
@Lugrim
Copy link
Contributor Author

Lugrim commented Feb 28, 2024

Done better in #145

@Lugrim Lugrim closed this Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority:low Low Priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate OpenApi documentation automatically
2 participants