Skip to content

Comments

Created an OpenAPI spec document#276

Closed
pipewrk wants to merge 2 commits intoweaviate:mainfrom
pipewrk:main
Closed

Created an OpenAPI spec document#276
pipewrk wants to merge 2 commits intoweaviate:mainfrom
pipewrk:main

Conversation

@pipewrk
Copy link

@pipewrk pipewrk 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?

@pipewrk
Copy link
Author

pipewrk 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.

@pipewrk pipewrk closed this Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants