This repository has been archived by the owner on Aug 14, 2024. It is now read-only.
docs(apis): Adding API basics #1027
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
sentaur-athena
commented
Aug 28, 2023
src/docs/api/design.mdx
Outdated
| Nested resources format like `api/0/organizations/{org}/projects/` is recommended over `api/0/projects/` for readability because it gives user an understanding of resource hierarchy but they can also make the URLs too long and hard to use. So at Sentry we’re going with 3-level nesting as a hybrid solution. | ||
|
|
||
| Here are some possible urls for values with this resource hierarchy: organization -> project -> tag -> value | ||
| ``` |
There was a problem hiding this comment.
@shanamatthews is there a better way to highlight a block? I used code block but this is not exactly code :/
There was a problem hiding this comment.
hmm, you could put it in a Note or a quote block, but that doesn't seem to fit the content. It might be best to just make it a bulleted list and format the URLs as code, like in my suggested edit
shanamatthews
approved these changes
Aug 28, 2023
apply suggested changes Co-authored-by: Shana Matthews <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Moving https://www.notion.so/sentry/WIP-API-Design-Standards-Expectations-5bb7ceb1266a4fbebf6cc14225fde7bb to api documentation.