search

defenseunicorns / leapfrogai

Production-ready Generative AI for local, cloud native, airgap, and edge deployments.
https://leapfrog.ai
Apache License 2.0
250 stars 28 forks source link

docs: Public facing FastAPI docs #566

Open CollectiveUnicorn opened 3 months ago

CollectiveUnicorn commented 3 months ago

User Story

As a person interested in the LeapfrogAI api I want user friendly details about the API without having to run the API and hit the swagger docs So that I can debug, develop, utilize, or understand how the LeapfrogAI API works

Acceptance Criteria

Given a user wants to get details about the API When they go to some publicly accessible URL Then they can access the API docs

Additional context

We have a Swagger that is only accessible by running the API, which is a high barrier to entry to working against

barronstone commented 3 months ago

These should be added somewhere within the docs site

It might make sense as a subpage of the Component's API section, but I'm open to other location ideas

justinthelaw commented 3 weeks ago

This is actually somewhat tangential to the idea of nightly or weekly conformance testing. Maybe something @alekst23 can look into afterwards, since we can fire the job to update our endpoints + conformance metrics in the Hugo docs website...