Add documentation for `api_versions` on `Instance` entity (#1514)
This commit is contained in:
parent
9b6dbb491e
commit
cff9085e39
|
@ -122,6 +122,9 @@ aliases: [
|
|||
"approval_required": false,
|
||||
"message": null
|
||||
},
|
||||
"api_versions": {
|
||||
"mastodon": 1,
|
||||
},
|
||||
"contact": {
|
||||
"email": "staff@mastodon.social",
|
||||
"account": {
|
||||
|
@ -500,6 +503,20 @@ aliases: [
|
|||
**Version history:**\
|
||||
4.0.0 - added
|
||||
|
||||
### `api_versions` {#api-versions}
|
||||
|
||||
**Description:** Information about which version of the API is implemented by this server. It contains at least a `mastodon` attribute, and other implementations may have their own additional attributes.\
|
||||
**Type:** Hash\
|
||||
**Version history:**\
|
||||
4.3.0 - added
|
||||
|
||||
### `api_versions[mastodon]`
|
||||
|
||||
**Description:** API version number that this server implements. Starting from Mastodon v4.3.0, API changes will come with a version number, which clients can check against this value.\
|
||||
**Type:** Integer\
|
||||
**Version history:**\
|
||||
4.3.0 - added
|
||||
|
||||
### `contact` {#contact}
|
||||
|
||||
**Description:** Hints related to contacting a representative of the website.\
|
||||
|
|
Loading…
Reference in New Issue