]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/commitdiff
Fix activitypub doc URL
authorChocobozzz <me@florianbigard.com>
Fri, 21 Apr 2023 13:03:36 +0000 (15:03 +0200)
committerChocobozzz <chocobozzz@cpy.re>
Tue, 9 May 2023 06:57:34 +0000 (08:57 +0200)
.github/CONTRIBUTING.md
.github/ISSUE_TEMPLATE/20-documentation-issue.yml
CHANGELOG.md
README.md
support/doc/api/openapi.yaml
support/openapi/go/README.mustache
support/openapi/python/README.mustache

index 7cc753b1a587624dc4264c7157d882daac574b8b..80b7cba3c5a740fa1f305468df4a6c4747fee9c0 100644 (file)
@@ -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:
 
 ```
index fc0cc6b4a867c374802a8bb17e8f61a3debcced2..354749ad5c7761313d3a04240d9a01d4196be31a 100644 (file)
@@ -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
index 8e6129adeac7fe49520f9d87257edf50dd1f00b4..7011d44dcd27256184a8c21cc0b868e9041e2255 100644 (file)
  * **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
 
index 8f3de1c97c1f62fcf7e5c3094db2033d0e80177c..0c2989c62fd0b3559ac620706f0bd9ffa314f3d1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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).
 
index a36ae0c7e1a4bb92eb4eacab892c5199e649a07c..0bf168044d5e1aea0b19b61307a1499fc9fcf340 100644 (file)
@@ -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:
index d58657b5bf738bba758766f6f35ccdec021fb113..d0fc0fa33a88ced59759655cacab4e890e0d2dc2 100644 (file)
@@ -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}}
index de41970e8cb9202f8b3b577b516ec78c665894ee..93dcd5ab64c75a28aa2aacca6361af783f2c6acd 100644 (file)
@@ -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}}