initial server api docs #917
Merged
Conversation
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
docs/server_rest_api.md
Outdated
|
|
||
| |Status|Meaning|Description|Schema| | ||
| |---|---|---|---| | ||
| |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|A list of Guards.|Inline| |
There was a problem hiding this comment.
This isn't showing any of the actual schemas. Maybe try re-generating this with the fully hydrated OpenAPI Spec that's published as part of the guardrails_api module.
There was a problem hiding this comment.
you mean guardrails_api/open-api-spec.json?
There was a problem hiding this comment.
does that come from guardrails-api-client/service-specs/guardrails-service-spec.yml ?
There was a problem hiding this comment.
Kinda of, it's built from that but this one is fully hydrated. You're right that the proper source of truth would come from the guardrails_api_client module. Relative path would be guardrails_api_client/openapi-spec.json
CalebCourier
approved these changes
Jul 16, 2024
|
good catch can add at the top |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
inital docs for api endpoints
not sold on where i put it we currently have a references area
do we just put it in the api readme?
also looked into https://github.com/PaloAltoNetworks/docusaurus-openapi-docs which doesnt seem compatible and https://redocusaurus.vercel.app/examples/using-single-yaml/ which is redocly based and ads another section to the site and the click through behavior doesnt interact with our header properly