zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Improve deprecation messaging for Application#vapid_key

This commit is contained in:
Emelia Smith 2024-05-15 17:12:09 +02:00
parent 5f0bd3cb77
commit 71c2fd7176
No known key found for this signature in database
3 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
content/en/entities/Application.md
View File

@ -17,8 +17,7 @@ aliases: [
```json
{
"name": "test app",
"website": null,
"vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
"website": null
}
```
@ -60,8 +59,8 @@ aliases: [
**Description:** Used for Push Streaming API. Returned with [POST /api/v1/apps]({{< relref "methods/apps#create" >}}). Equivalent to [WebPushSubscription#server_key]({{< relref "entities/WebPushSubscription#server_key" >}}) and [Instance#vapid_public_key]({{< relref "entities/Instance#vapid_public_key" >}})\
**Type:** String\
**Version history:**\
2.8.0 - added
4.3.0 - deprecated pending removal
2.8.0 - added\
4.3.0 - deprecated pending removal, please see [api/v2/instance]({{< relref "methods/Instance#v2">}}) for this value (`configuration.vapid.public_key`)
## See also

9
content/en/methods/apps.md
View File

@ -29,9 +29,11 @@ Create a new application to obtain OAuth2 credentials.
**OAuth:** Public\
**Version history:**\
0.0.0 - added\
2.7.2 - now returns `vapid_key`
2.7.2 - now returns `vapid_key`\
4.3.0 - deprecated `vapid_key`, please see [api/v2/instance]({{< relref "methods/Instance#v2">}})
#### Request
##### Form data parameters
client_name
@ -47,6 +49,7 @@ website
: String. A URL to the homepage of your app
#### Response
##### 200: OK
Store the `client_id` and `client_secret` in your cache, as these will be used to obtain OAuth tokens.
@ -87,7 +90,8 @@ Confirm that the app's OAuth2 credentials work.
**OAuth level:** App token + `read`\
**Version history:**\
2.0.0 - added\
2.7.2 - now returns `vapid_key`
2.7.2 - now returns `vapid_key`\
4.3.0 - deprecated `vapid_key`, please see [api/v2/instance]({{< relref "methods/Instance#v2">}})
#### Request
@ -97,6 +101,7 @@ Authorization
: {{<required>}} Provide this header with `Bearer <app token>` to gain authorized access to this API method.
#### Response
##### 200: OK
If the Authorization header was provided with a valid token, you should see your app returned as an Application entity.

12
content/en/methods/instance.md
View File

@ -28,7 +28,8 @@ Obtain general information about the server.
**Returns:** [Instance]({{< relref "entities/Instance" >}})\
**OAuth:** Public\
**Version history:**\
4.0.0 - added
4.0.0 - added\
4.3.0 - added `configuration.vapid.public_key`
#### Response
@ -186,7 +187,6 @@ Obtain general information about the server.
}
```
---
## List of connected domains {#peers}
@ -252,6 +252,7 @@ Authorization
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
#### Response
##### 200: OK
Each hash in the array will contain the following attributes:
@ -359,7 +360,6 @@ If the instance is in whitelist mode and the Authorization header is missing or
## List of rules {#rules}
```http
GET /api/v1/instance/rules HTTP/1.1
```
@ -372,6 +372,7 @@ Rules that the users of this service should follow.
3.4.0 - added
#### Response
##### 200: OK
```json
@ -426,6 +427,7 @@ Authorization
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
#### Response
##### 200: OK
The complete list of domains blocked by this instance
@ -481,6 +483,7 @@ Obtain an extended description of this server
4.0.0 - added
#### Response
##### 200: OK
```json
@ -506,6 +509,7 @@ Translation language pairs supported by the translation engine used by the serve
4.2.0 - added
#### Response
##### 200: OK
All source and target language pairs supported by the server.
@ -528,7 +532,7 @@ In the following sample response showing support for translating a status writte
GET /api/v1/instance HTTP/1.1
```
Obtain general information about the server.
Obtain general information about the server. See [api/v2/instance]({{< relref "methods/Instance#v2">}}) instead.
**Returns:** [V1::Instance]({{< relref "entities/V1_Instance" >}})\
**OAuth:** Public\