Fix activitypub doc URL

pull/5593/head
Chocobozzz 2023-04-21 15:03:36 +02:00 committed by Chocobozzz
parent b708c9e464
commit 18c53ef949
7 changed files with 13 additions and 13 deletions

View File

@ -244,7 +244,7 @@ To test emails with PeerTube:
### OpenAPI documentation ### OpenAPI documentation
The [REST API documentation](https://docs.joinpeertube.org/api/rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file.
To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command: To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command:
``` ```

View File

@ -15,4 +15,4 @@ body:
description: | description: |
Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try: Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try:
* Click "Edit this page" if on https://docs.joinpeertube.org * Click "Edit this page" if on https://docs.joinpeertube.org
* Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api/rest-reference.html * Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api-rest-reference.html

View File

@ -450,7 +450,7 @@
* **Important** SQL migrations (in particular `0685-multiple-actor-images`) can take several minutes to complete * **Important** SQL migrations (in particular `0685-multiple-actor-images`) can take several minutes to complete
* **Important** You must update your nginx configuration to support video web editor: https://docs.joinpeertube.org/install/any-os#nginx * **Important** You must update your nginx configuration to support video web editor: https://docs.joinpeertube.org/install/any-os#nginx
* REST API: * REST API:
* `PUT /api/v1/videos/{id}/watching` is deprecated, use `POST /api/v1/videos/videos/{id}/views` instead: https://docs.joinpeertube.org/api/rest-reference.html#operation/addView * `PUT /api/v1/videos/{id}/watching` is deprecated, use `POST /api/v1/videos/videos/{id}/views` instead: https://docs.joinpeertube.org/api-rest-reference.html#operation/addView
### Maintenance ### Maintenance

View File

@ -174,7 +174,7 @@ See the [architecture blueprint](https://docs.joinpeertube.org/contribute/archit
See our REST API documentation: See our REST API documentation:
* OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
* Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api/rest-reference.html) * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub). See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub).

View File

@ -46,7 +46,7 @@ info:
{ {
"detail": "Video not found", "detail": "Video not found",
"docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
"status": 404, "status": 404,
"title": "Not Found", "title": "Not Found",
"type": "about:blank" "type": "about:blank"
@ -63,10 +63,10 @@ info:
{ {
"detail": "Cannot get this video regarding follow constraints", "detail": "Cannot get this video regarding follow constraints",
"docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
"status": 403, "status": 403,
"title": "Forbidden", "title": "Forbidden",
"type": "https://docs.joinpeertube.org/api/rest-reference.html#section/Errors/does_not_respect_follow_constraints" "type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints"
} }
``` ```
@ -84,7 +84,7 @@ info:
{ {
"detail": "Incorrect request parameters: id", "detail": "Incorrect request parameters: id",
"docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
"instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180", "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180",
"invalid-params": { "invalid-params": {
"id": { "id": {
@ -149,7 +149,7 @@ info:
In addition, all routes serving ActivityPub are CORS-enabled for all origins. In addition, all routes serving ActivityPub are CORS-enabled for all origins.
externalDocs: externalDocs:
url: https://docs.joinpeertube.org/api/rest-reference.html url: https://docs.joinpeertube.org/api-rest-reference.html
tags: tags:
- name: Register - name: Register
description: | description: |
@ -6000,7 +6000,7 @@ components:
required: false required: false
schema: schema:
$ref: '#/components/schemas/VideoPlaylistTypeSet' $ref: '#/components/schemas/VideoPlaylistTypeSet'
securitySchemes: securitySchemes:
OAuth2: OAuth2:
description: | description: |
@ -6190,7 +6190,7 @@ components:
- 2 - 2
- 3 - 3
description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)' description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'
LiveVideoReplaySettings: LiveVideoReplaySettings:
type: object type: object
properties: properties:

View File

@ -1,6 +1,6 @@
# Go API client for {{appName}} # Go API client for {{appName}}
This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html),
using the [OpenAPI Generator](https://openapi-generator.tech) project: using the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: {{appVersion}} - API version: {{appVersion}}

View File

@ -1,6 +1,6 @@
# Python API client for {{appName}} # Python API client for {{appName}}
This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html),
using the [OpenAPI Generator](https://openapi-generator.tech) project: using the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: {{appVersion}} - API version: {{appVersion}}