diff options
Diffstat (limited to 'api-conventions.md')
| -rw-r--r-- | api-conventions.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/api-conventions.md b/api-conventions.md index f505bd1..e7c1591 100644 --- a/api-conventions.md +++ b/api-conventions.md @@ -70,7 +70,7 @@ All requests and response bodies shall be encoded with Content-Type Each resource returned by the API has its own schema, and may be given in two forms: *full form* and *short form*. The full form is always returned when retrieving a resource by ID, and contains the maximum amount of detail. The -short form contains less information - an ID at the minimum, but often more - +short form contains less information — an ID at the minimum, but often more - and is returned where the long form would be inconvenient, such as from a list endpoint or for singletons embedded in a parent resource. @@ -134,7 +134,7 @@ versioning, each version being of the format "major.minor.patch". The patch number increments with every release, the minor number increments when new features are added, and the major version increments on breaking changes. Note that the minor and patch versions may increment when changes are made to the web -frontend - which may not necessarily affect the API - but major versions only +frontend — which may not necessarily affect the API — but major versions only increment on breaking API changes. Any API whose major version is 0 makes no guarantees about interface stability. @@ -184,7 +184,7 @@ meta.sr.ht) `profile:update` or `ssh-key:remove`. These require the same OAuth scopes to configure as are necessary to obtain these resources through polling - there's no separate OAuth scope for webhooks. -Periodically polling the API is discouraged - use webhooks instead. +Periodically polling the API is discouraged — use webhooks instead. ### Webhook delivery |