aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--.github/CONTRIBUTING.md2
-rw-r--r--.github/ISSUE_TEMPLATE/20-documentation-issue.yml2
-rw-r--r--CHANGELOG.md2
-rw-r--r--README.md2
-rw-r--r--support/doc/api/openapi.yaml14
-rw-r--r--support/openapi/go/README.mustache2
-rw-r--r--support/openapi/python/README.mustache2
7 files changed, 13 insertions, 13 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 7cc753b1a..80b7cba3c 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -244,7 +244,7 @@ To test emails with PeerTube:
244 244
245### OpenAPI documentation 245### OpenAPI documentation
246 246
247The [REST API documentation](https://docs.joinpeertube.org/api/rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. 247The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file.
248To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command: 248To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command:
249 249
250``` 250```
diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.yml b/.github/ISSUE_TEMPLATE/20-documentation-issue.yml
index fc0cc6b4a..354749ad5 100644
--- a/.github/ISSUE_TEMPLATE/20-documentation-issue.yml
+++ b/.github/ISSUE_TEMPLATE/20-documentation-issue.yml
@@ -15,4 +15,4 @@ body:
15 description: | 15 description: |
16 Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try: 16 Are you up to submit a pull request? Chances are, only a small edit is required, so give it a try:
17 * Click "Edit this page" if on https://docs.joinpeertube.org 17 * Click "Edit this page" if on https://docs.joinpeertube.org
18 * Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api/rest-reference.html 18 * Edit https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml if on https://docs.joinpeertube.org/api-rest-reference.html
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8e6129ade..7011d44dc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -450,7 +450,7 @@
450 * **Important** SQL migrations (in particular `0685-multiple-actor-images`) can take several minutes to complete 450 * **Important** SQL migrations (in particular `0685-multiple-actor-images`) can take several minutes to complete
451 * **Important** You must update your nginx configuration to support video web editor: https://docs.joinpeertube.org/install/any-os#nginx 451 * **Important** You must update your nginx configuration to support video web editor: https://docs.joinpeertube.org/install/any-os#nginx
452 * REST API: 452 * REST API:
453 * `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 453 * `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
454 454
455### Maintenance 455### Maintenance
456 456
diff --git a/README.md b/README.md
index 8f3de1c97..0c2989c62 100644
--- a/README.md
+++ b/README.md
@@ -174,7 +174,7 @@ See the [architecture blueprint](https://docs.joinpeertube.org/contribute/archit
174 174
175See our REST API documentation: 175See our REST API documentation:
176 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) 176 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
177 * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api/rest-reference.html) 177 * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
178 178
179See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub). 179See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub).
180 180
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index a36ae0c7e..0bf168044 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -46,7 +46,7 @@ info:
46 46
47 { 47 {
48 "detail": "Video not found", 48 "detail": "Video not found",
49 "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", 49 "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
50 "status": 404, 50 "status": 404,
51 "title": "Not Found", 51 "title": "Not Found",
52 "type": "about:blank" 52 "type": "about:blank"
@@ -63,10 +63,10 @@ info:
63 63
64 { 64 {
65 "detail": "Cannot get this video regarding follow constraints", 65 "detail": "Cannot get this video regarding follow constraints",
66 "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", 66 "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
67 "status": 403, 67 "status": 403,
68 "title": "Forbidden", 68 "title": "Forbidden",
69 "type": "https://docs.joinpeertube.org/api/rest-reference.html#section/Errors/does_not_respect_follow_constraints" 69 "type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints"
70 } 70 }
71 ``` 71 ```
72 72
@@ -84,7 +84,7 @@ info:
84 84
85 { 85 {
86 "detail": "Incorrect request parameters: id", 86 "detail": "Incorrect request parameters: id",
87 "docs": "https://docs.joinpeertube.org/api/rest-reference.html#operation/getVideo", 87 "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
88 "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180", 88 "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180",
89 "invalid-params": { 89 "invalid-params": {
90 "id": { 90 "id": {
@@ -149,7 +149,7 @@ info:
149 149
150 In addition, all routes serving ActivityPub are CORS-enabled for all origins. 150 In addition, all routes serving ActivityPub are CORS-enabled for all origins.
151externalDocs: 151externalDocs:
152 url: https://docs.joinpeertube.org/api/rest-reference.html 152 url: https://docs.joinpeertube.org/api-rest-reference.html
153tags: 153tags:
154 - name: Register 154 - name: Register
155 description: | 155 description: |
@@ -6000,7 +6000,7 @@ components:
6000 required: false 6000 required: false
6001 schema: 6001 schema:
6002 $ref: '#/components/schemas/VideoPlaylistTypeSet' 6002 $ref: '#/components/schemas/VideoPlaylistTypeSet'
6003 6003
6004 securitySchemes: 6004 securitySchemes:
6005 OAuth2: 6005 OAuth2:
6006 description: | 6006 description: |
@@ -6190,7 +6190,7 @@ components:
6190 - 2 6190 - 2
6191 - 3 6191 - 3
6192 description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)' 6192 description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'
6193 6193
6194 LiveVideoReplaySettings: 6194 LiveVideoReplaySettings:
6195 type: object 6195 type: object
6196 properties: 6196 properties:
diff --git a/support/openapi/go/README.mustache b/support/openapi/go/README.mustache
index d58657b5b..d0fc0fa33 100644
--- a/support/openapi/go/README.mustache
+++ b/support/openapi/go/README.mustache
@@ -1,6 +1,6 @@
1# Go API client for {{appName}} 1# Go API client for {{appName}}
2 2
3This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), 3This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html),
4using the [OpenAPI Generator](https://openapi-generator.tech) project: 4using the [OpenAPI Generator](https://openapi-generator.tech) project:
5 5
6- API version: {{appVersion}} 6- API version: {{appVersion}}
diff --git a/support/openapi/python/README.mustache b/support/openapi/python/README.mustache
index de41970e8..93dcd5ab6 100644
--- a/support/openapi/python/README.mustache
+++ b/support/openapi/python/README.mustache
@@ -1,6 +1,6 @@
1# Python API client for {{appName}} 1# Python API client for {{appName}}
2 2
3This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api/rest-reference.html), 3This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html),
4using the [OpenAPI Generator](https://openapi-generator.tech) project: 4using the [OpenAPI Generator](https://openapi-generator.tech) project:
5 5
6- API version: {{appVersion}} 6- API version: {{appVersion}}