5ebc8ad418
As discussed in #764 there are quite a lot of outdated links in the mastodon documentation. In basically all cases this was resolved by simply wrapping the old plain markdown link in hugos `relref` function[^0]. While quite a lot of links on the `/zh-cn/` also appear to be broken, these can not be fixed by just wrapping them in `relref`[^0]. Those are all links to `/spec/` subpages which are just not translated to `/zh-cn/` version. Therefore, `/zh-cn/spec/` has been excluded from the automated checking as described in the next section. The page has been checked using the linkchecker[^1] utility. One process is running `hugo serve` in order to see all changes in real time and notice errors directly in your browser. In a separate command prompt the command `linkchecker http://localhost:1313 --ignore-url=/zh-cn/spec` is being fired up. Note the `--ignore-url=/zh-cn/spe` to exclude the just not existing parts of the page as mentioned in the previous paragraph. There still is some ToDo on the table since quite a lot of the anchors appear to not be set or at least differ from previous versions. One example: on `/client/authorized/` is a link to `/client/token/#creating-our-application` while the id of referenced heading is `app`. These changes **do not** fix those Issues as it would require way more time. [^0]: https://gohugo.io/functions/relref/ [^1]: https://github.com/linkchecker/linkchecker Close #764
1.7 KiB
| title | description | menu | ||||
|---|---|---|---|---|---|---|
| Application | Represents an application that interfaces with the REST API to access accounts or post statuses. |
|
Example
{
"name": "test app",
"website": null,
"vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}
Required attributes
name
Description: The name of your application.
Type: String
Version history: Added in 0.9.9
Optional attributes
website
Description: The website associated with your application.
Type: String (URL)
Version history: Added in 0.9.9
vapid_key
Description: Used for Push Streaming API. Returned with [POST /api/v1/apps]({{< relref "../methods/apps/#create-an-application" >}}). Equivalent to [PushSubscription#server_key]({{< relref "pushsubscription.md#server_key" >}})
Type: String
Version history: Added in 2.8.0
Client attributes
client_id
Description: Client ID key, to be used for obtaining OAuth tokens
Type: String
Version history: Added in 0.9.9
client_secret
Description: Client secret key, to be used for obtaining OAuth tokens
Type: String
Version history: Added in 0.9.9
See also
- [Status#application]({{< relref "status.md#application" >}})
- [Create an application (POST /api/v1/apps)]({{< relref "../methods/apps/#create-an-application" >}})
{{< page-ref page="status.md" >}}
{{< page-ref page="methods/apps.md" >}}
{{< caption-link url="https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/application_serializer.rb" caption="app/serializers/rest/application_serializer.rb" >}}