Update content for 4.0 (part 1) (#991)

* add rules * join date on profiles * deprecate follow scope * deprecate identity proofs * familiar followers * use definition lists instead of tables for defining activitypub properties * reformat notifications page into markdown * fix broken links to publicKey header * Application website is now nullable * update environment variables added and removed * fix typo * fix heading level * min_id and max_id can be used at the same time (3.3) * fix typo * new tootctl options * reformat tootctl page to use definition lists for params * add rules and configuration to Instance * fix typo * refactor instance api page * 3.3.0 duration on mutes * 3.3.0 mute_expires_at * improve section headings * 3.4.0 resend email confirmation api * 3.4.0 policy on push subscriptions * 3.4.0 add details to account registration error * refactor accounts api page and start adding relrefs to entity pages * 3.4.0 accounts/lookup api * add see also to accounts methods * add more see-also links * 3.5.0 appeal mod decisions * 3.5.0 reformat reports and add category/rule_ids params * document report entity and missing responses * fix typos * fix relrefs and url schema, add aliases to old urls * add archetypes for new methods/entities * update archetypes with see-also stubs * clearer presentation of rate limits * announcements api methods * refactor apps methods * refactor bookmarks methods + some anchors * refactor conversations methods * custom_emojis methods refactor * anchors * refactor directory methods * refactor domain_blocks methods * add see also to emails methods * fix page relref shortcodes to specific methods + refactor endorsements methods * min_id max_id * refactor favourites methods * refactor featured_tags methods * refactor filters methods, make path params consistent, i18n required shortcode * follow_requests methods * lists methods * markers methods * forgot to add entity links * media methods, also fix formatting of some json errors * mutes methods, add more see-also links * oembed methods * preferences methods * proofs methods * push methods * suggestions methods * 3.5.0 add new trend types, fix formatting * refactor streaming methods * refactor oauth methods * note that streaming api casts payload to string * refactor search methods * refactor polls methods * remove unnecessary link * reformat scheduled_statuses methods * reformat timelines methods * reformat statuses methods * 3.5.0 editing statuses * consistent use of array brackets in form data parameters * update dev setup guide, add vagrant and clean up text * add admin/accounts methods * 3.6 role entity * admin/accounts methods v2 * minor fix * stub admin/reports methods * document admin reports * add 403 example to methods archetype * cleanup entities for admin reports and add new attrs * 3.6.0 domain allows methods + normalize admin entity namespace * fix search-and-replace error * add aliases for admin entities * 3.6.0 canonical email blocks entity * 3.5.0 admin/retention api * 3.5.0 add admin::ip doc * 3.5.0 admin/reports * 3.6.0 admin/domain_allows * 3.5.0 admin/dimensions * 3.6.0 permissions and roles * minor formatting fix * add anchor link to headings * checkpoint * add update commands to dev env setup guide * change mentions of v3.6 to v4.0 * tootctl now uses custom roles * fix formatting * v2 instance api * update frontmatter, add better titles to pages * minor wording change * consistency * add more aliases * add placeholders and WIP notices * explain link pagination and stub out todos * switch baseURL to https * 422 on reports with rules but category!=violation * document bug fixes * fix typo * remove duplicate API method definition * s/tootsuite/mastodon for github links * remove unnecessary escaping * s/tootsuite/mastodon in Entity archetype * add missing nullable shortcode * clarify oauth scope when requesting a user token * api/v2/media now synchronous for images * DISALLOW_UNAUTHENTICATED_API_ACCESS * add undocumented env variables * add instance domain blocks and extended description api * add SMTP_ENABLE_STARTTLS * add description to SMTP_ENABLE_STARTTLS * take suggestions from open PRs * normalize links and flavour language * Fully document streaming API based on source code * Add mention of MIME types * bump to ruby 3.0.4 * clarify how to check on async media processing * validation of replies_policy * remove TODOs on admin account action * EmailDomainBlocks * IpBlocks * Admin::DomainBlock * remove TODOs * following hashtags * followed_tags * remove reference to unused parameter * add new oauth scopes for admin blocks and allows * fix command signature for i18n-tasks normalize * reformat code structure page * document fixes for following tags (assume 4.0.3) * Add warning about pre-4.0 hardcoded roles * add note about case sensitivity * remove use of 'simply' from docs * remove reference to silencing * add reference to IDN normalization for verified links * add lang parameter
2022-11-20 00:34:38 -06:00 · 2022-11-20 00:34:38 -06:00 · 3628b6d434
commit 3628b6d434
parent 69e9017730
225 changed files with 22675 additions and 11631 deletions
--- a/archetypes/entities.md
+++ b/archetypes/entities.md
@ -0,0 +1,27 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+description: 
+menu:
+  docs:
+    parent: entities
+---
+
+## Example
+
+```json
+```
+
+## Attributes
+
+### `id` {#id}
+
+**Description:** The ID of the SOMETHING in the database.\
+**Type:** String (cast from an integer, but not guaranteed to be a number)\
+**Version history:**\
+x.x.x - added
+
+## See also
+
+{{< page-relref ref="methods/SOMETHING#anchor" caption="POST /api/v1/something/" >}}
+
+{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/SOMETHING_serializer.rb" caption="app/serializers/rest/SOMETHING_serializer.rb" >}}
--- a/archetypes/methods.md
+++ b/archetypes/methods.md
@ -0,0 +1,123 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+description: 
+menu:
+  docs:
+    parent: methods
+---
+
+## What the method does {#anchor}
+
+```http
+GET https://mastodon.example/api/v1/example HTTP/1.1
+```
+
+**Returns:** [SOMETHING]({{< relref "entities/SOMETHING" >}})\
+**OAuth:** User token + `oauth:scope`\
+**Permissions:** Manage ???\
+**Version history:**\
+x.x.x - added
+
+#### Request
+
+##### Path parameters
+
+:id
+: {{<required>}} String. The ID of the SOMETHING in the database.
+
+##### Headers
+
+Authorization
+: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
+
+##### Query parameters
+
+**Internal parameter.** Use HTTP `Link` header for pagination.
+
+max_id 
+: String. Return results older than ID.
+
+since_id
+: String. Return results newer than ID.
+
+min_id
+: String. Return results immediately newer than ID.
+
+limit
+: Integer. Maximum number of results to return. Defaults to 20. Max 40.
+
+##### Form data parameters
+
+#### Response
+##### 200: OK
+
+```json
+```
+
+Because SOMETHING IDs are generally not exposed via any API responses, you will have to parse the HTTP `Link` header to load older or newer results. See [Paginating through API responses]({{<relref "api/guidelines#pagination">}}) for more information.
+
+```http
+Link:
+```
+
+##### 401: Unauthorized
+
+Invalid or missing Authorization header.
+
+```json
+{
+  "error": "The access token is invalid"
+}
+```
+
+##### 403: Forbidden
+
+Authorized user is missing a permission, or invalid or missing Authorization header
+
+```json
+{
+  "error": "This action is not allowed"
+}
+```
+
+##### 404: Not found
+
+SOMETHING is not owned by you or does not exist
+
+```json
+{
+  "error": "Record not found"
+}
+```
+
+##### 410: Gone
+
+##### 422: Unprocessable entity
+
+##### 429: Rate limited
+
+```json
+{
+  "error": "Too many requests"
+}
+```
+
+##### 503: Service unavailable
+
+```json
+{
+  "error": "There was a temporary problem serving your request, please try again"
+}
+```
+
+---
+
+## See also
+
+{{< page-relref ref="methods/SOMETHING#anchor" caption="POST /api/v1/something/" >}}
+
+{{< page-ref page="client/authorized" >}}
+
+{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/SOMETHING_controller.rb" caption="app/controllers/api/v1/SOMETHING_controller.rb" >}}
+
+{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/SOMETHING" caption="app/controllers/api/v1/SOMETHING/" >}}