mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2024-08-17 09:20:26 +03:00
Fix activitypub doc URL
This commit is contained in:
parent
b708c9e464
commit
18c53ef949
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
@ -244,7 +244,7 @@ To test emails with PeerTube:
|
||||
|
||||
### 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:
|
||||
|
||||
```
|
||||
|
@ -15,4 +15,4 @@ body:
|
||||
description: |
|
||||
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
|
||||
* 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
|
||||
|
@ -450,7 +450,7 @@
|
||||
* **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
|
||||
* 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
|
||||
|
||||
|
@ -174,7 +174,7 @@ See the [architecture blueprint](https://docs.joinpeertube.org/contribute/archit
|
||||
|
||||
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)
|
||||
* 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).
|
||||
|
||||
|
@ -46,7 +46,7 @@ info:
|
||||
|
||||
{
|
||||
"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,
|
||||
"title": "Not Found",
|
||||
"type": "about:blank"
|
||||
@ -63,10 +63,10 @@ info:
|
||||
|
||||
{
|
||||
"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,
|
||||
"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",
|
||||
"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",
|
||||
"invalid-params": {
|
||||
"id": {
|
||||
@ -149,7 +149,7 @@ info:
|
||||
|
||||
In addition, all routes serving ActivityPub are CORS-enabled for all origins.
|
||||
externalDocs:
|
||||
url: https://docs.joinpeertube.org/api/rest-reference.html
|
||||
url: https://docs.joinpeertube.org/api-rest-reference.html
|
||||
tags:
|
||||
- name: Register
|
||||
description: |
|
||||
@ -6000,7 +6000,7 @@ components:
|
||||
required: false
|
||||
schema:
|
||||
$ref: '#/components/schemas/VideoPlaylistTypeSet'
|
||||
|
||||
|
||||
securitySchemes:
|
||||
OAuth2:
|
||||
description: |
|
||||
@ -6190,7 +6190,7 @@ components:
|
||||
- 2
|
||||
- 3
|
||||
description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'
|
||||
|
||||
|
||||
LiveVideoReplaySettings:
|
||||
type: object
|
||||
properties:
|
||||
|
@ -1,6 +1,6 @@
|
||||
# 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:
|
||||
|
||||
- API version: {{appVersion}}
|
||||
|
@ -1,6 +1,6 @@
|
||||
# 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:
|
||||
|
||||
- API version: {{appVersion}}
|
||||
|
Loading…
Reference in New Issue
Block a user