[DOCS] add API structure documentation #176
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
juliasilge
reviewed
May 9, 2023
vetiver/server.py
Outdated
|
|
||
| ├──/ping (GET) | ||
| ├──/metadata (GET) | ||
| ├──/pin-url (GET, if model is pinned on Posit Connect) |
Member
There was a problem hiding this comment.
Does the URL not get added to the API if it is pinned elsewhere, like on S3 or Azure or similar?
Contributor
Author
There was a problem hiding this comment.
As of right now, it is only for Connect. I'll generalize that sentence in this documentation in case that changes later.
https://github.com/rstudio/pins-python/blob/c69db9ada539a9aa422ece50a484ccf6cab39d0c/pins/constructors.py#L57
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.
This outlines the generated endpoints in VetiverAPI