Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Created an OpenAPI spec document #276

Closed
wants to merge 2 commits into from
Closed

Conversation

jasonnathan
Copy link

@jasonnathan jasonnathan commented Sep 8, 2024

Please see Issue 275. You can use it to create API documentation, e.g.

openapi-generator-cli generate -i openapi.json -g markdown -o ./docs

Used `api.ts` for generating this document
@weaviate-git-bot
Copy link

To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge.

beep boop - the Weaviate bot 👋🤖

PS:
Are you already a member of the Weaviate Slack channel?

@jasonnathan
Copy link
Author

jasonnathan commented Sep 8, 2024

Yep, agree with the CLA

@thomashacker
Copy link
Collaborator

Hey @jasonnathan thanks for the PR ! Since we're using FastAPI, you already have access to an API specification through the /docs endpoint.

@jasonnathan jasonnathan closed this Nov 3, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants