Http API Referene Docs#945
Merged
Merged
Conversation
hansent
requested review from
EmilyGavrilenko,
PawelPeczek-Roboflow,
capjamesg,
grzegorz-roboflow,
probicheaux and
yeldarby
as code owners
yeldarby
approved these changes
Jan 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
We are currently serving a very outdated version (from v0.9.2) of the http / openAPI swagger docs at https://inference.roboflow.com/api/
This PR adds a script to generate the
openapi.jsonspec as part of docs build and also links the http api page in a new subsection calledHTTP APIunder the reference sectionType of change
Docs update
How has this change been tested, please provide a testcase or example of how you tested the change?
locally
Any specific deployment considerations
docs update
Docs
yes, see above