Skip to content

Commit 5a2b55d

Browse files
committed
Merge branch 'master' into scttcper/seer-docs
2 parents 984a1f8 + e93d744 commit 5a2b55d

File tree

254 files changed

+2967
-1308
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

254 files changed

+2967
-1308
lines changed

apps/changelog/src/client/components/editor.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ function Editor({name, defaultValue, minRows = 15}: EditorProps) {
169169
minRows={minRows}
170170
required
171171
value={value}
172-
className="w-full"
172+
className="form-textarea w-full"
173173
onChange={e => setValue(e.target.value)}
174174
// aria-invalid={actionData?.errors?.content ? true : undefined}
175175
// aria-errormessage={

develop-docs/backend/api/basics.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@ sidebar_order: 1
55
This section includes common terms and resources to learn more about API design. If you're new to API design, this is a good place to start.
66

77
## Common Terms
8+
89
- **Resource** is the object you’re performing the action on with your endpoint. For example, in ProjectEndpoint the resource is Project.
9-
- **Resource Identifier** can be an ID, like an event ID, or slug, like an organization slug. Note that it must be unique. For example, Sentry's project resource identifier is \{org_slug}/\{project_slug}, because projects are only unique within their organization. You can find more information about this in the slug vs. ID section.
10+
11+
- **Resource Identifier** can be an ID, like an event ID, or slug, like an organization slug. Note that it must be unique. For example, Sentry's project resource identifier is \{organization}/\{project}, because projects are only unique within their organization. You can find more information about this in the slug vs. ID section.
12+
1013
- **Method** is what you do with the resource. Each endpoint can have multiple methods. For example in ProjectEndpoint, you can have a GET method that returns details of a specific project.
14+
1115
- **Collection** is basically an object type. You can map them to a Django object type like an Organization or a text object like an error.
1216

13-
## Extra Resources
17+
## Additional Reading
18+
1419
The following resources are helpful to learn about general API design best practices:
1520

1621
- **[The Design of Web APIs](https://g.co/kgs/R7rXEk)** is an example-packed guide to designing APIs.
22+
1723
- **[API Design Patterns](https://g.co/kgs/Vfnpe5)** is comprehensive guide on key API patterns.

develop-docs/backend/api/concepts.mdx

Lines changed: 0 additions & 142 deletions
This file was deleted.

0 commit comments

Comments
 (0)