diff options
author | Chocobozzz <chocobozzz@cpy.re> | 2021-05-27 15:59:55 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-05-27 15:59:55 +0200 |
commit | 2539932e16129992a2c0889b4ff527c265a8e2c7 (patch) | |
tree | fb5048e63e02a2485eb96d27455f43e4b22e8ae0 /support/doc/api | |
parent | eb34ec30e0b57286fc6f85160490d2e973a3b0b1 (diff) | |
download | PeerTube-2539932e16129992a2c0889b4ff527c265a8e2c7.tar.gz PeerTube-2539932e16129992a2c0889b4ff527c265a8e2c7.tar.zst PeerTube-2539932e16129992a2c0889b4ff527c265a8e2c7.zip |
Instance homepage support (#4007)
* Prepare homepage parsers
* Add ability to update instance hompage
* Add ability to set homepage as landing page
* Add homepage preview in admin
* Dynamically update left menu for homepage
* Inject home content in homepage
* Add videos list and channel miniature custom markup
* Remove unused elements in markup service
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 11adf078d..74910c313 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -247,6 +247,8 @@ tags: | |||
247 | 247 | ||
248 | Administrators can also enable the use of a remote search system, indexing | 248 | Administrators can also enable the use of a remote search system, indexing |
249 | videos and channels not could be not federated by the instance. | 249 | videos and channels not could be not federated by the instance. |
250 | - name: Homepage | ||
251 | description: Get and update the custom homepage | ||
250 | - name: Video Mirroring | 252 | - name: Video Mirroring |
251 | description: | | 253 | description: | |
252 | PeerTube instances can mirror videos from one another, and help distribute some videos. | 254 | PeerTube instances can mirror videos from one another, and help distribute some videos. |
@@ -281,6 +283,9 @@ x-tagGroups: | |||
281 | - name: Search | 283 | - name: Search |
282 | tags: | 284 | tags: |
283 | - Search | 285 | - Search |
286 | - name: Custom pages | ||
287 | tags: | ||
288 | - Homepage | ||
284 | - name: Moderation | 289 | - name: Moderation |
285 | tags: | 290 | tags: |
286 | - Abuses | 291 | - Abuses |
@@ -477,6 +482,40 @@ paths: | |||
477 | '200': | 482 | '200': |
478 | description: successful operation | 483 | description: successful operation |
479 | 484 | ||
485 | /custom-pages/homepage/instance: | ||
486 | get: | ||
487 | summary: Get instance custom homepage | ||
488 | tags: | ||
489 | - Homepage | ||
490 | responses: | ||
491 | '404': | ||
492 | description: No homepage set | ||
493 | '200': | ||
494 | description: successful operation | ||
495 | content: | ||
496 | application/json: | ||
497 | schema: | ||
498 | $ref: '#/components/schemas/CustomHomepage' | ||
499 | put: | ||
500 | summary: Set instance custom homepage | ||
501 | tags: | ||
502 | - Homepage | ||
503 | security: | ||
504 | - OAuth2: | ||
505 | - admin | ||
506 | requestBody: | ||
507 | content: | ||
508 | application/json: | ||
509 | schema: | ||
510 | type: object | ||
511 | properties: | ||
512 | content: | ||
513 | type: string | ||
514 | description: content of the homepage, that will be injected in the client | ||
515 | responses: | ||
516 | '204': | ||
517 | description: successful operation | ||
518 | |||
480 | /jobs/{state}: | 519 | /jobs/{state}: |
481 | get: | 520 | get: |
482 | summary: List instance jobs | 521 | summary: List instance jobs |
@@ -5740,6 +5779,12 @@ components: | |||
5740 | indexUrl: | 5779 | indexUrl: |
5741 | type: string | 5780 | type: string |
5742 | format: url | 5781 | format: url |
5782 | homepage: | ||
5783 | type: object | ||
5784 | properties: | ||
5785 | enabled: | ||
5786 | type: boolean | ||
5787 | |||
5743 | ServerConfigAbout: | 5788 | ServerConfigAbout: |
5744 | properties: | 5789 | properties: |
5745 | instance: | 5790 | instance: |
@@ -5930,6 +5975,12 @@ components: | |||
5930 | type: boolean | 5975 | type: boolean |
5931 | manualApproval: | 5976 | manualApproval: |
5932 | type: boolean | 5977 | type: boolean |
5978 | |||
5979 | CustomHomepage: | ||
5980 | properties: | ||
5981 | content: | ||
5982 | type: string | ||
5983 | |||
5933 | Follow: | 5984 | Follow: |
5934 | properties: | 5985 | properties: |
5935 | id: | 5986 | id: |