diff options
author | David Libeau <DavidLibeau@users.noreply.github.com> | 2018-07-28 14:38:49 -0400 |
---|---|---|
committer | Rigel Kent <par@rigelk.eu> | 2018-07-28 20:38:49 +0200 |
commit | fb72c19384192d57252e7cb73cdcf8d0876f37a0 (patch) | |
tree | f8c3b7ed616f0739d028dd14e9fbef32af7ad962 /support/doc/api/openapi.yaml | |
parent | 469b29087bd8f98d87a32b87dacb346b6bf61db1 (diff) | |
download | PeerTube-fb72c19384192d57252e7cb73cdcf8d0876f37a0.tar.gz PeerTube-fb72c19384192d57252e7cb73cdcf8d0876f37a0.tar.zst PeerTube-fb72c19384192d57252e7cb73cdcf8d0876f37a0.zip |
Correct API documentation for search (#878)
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r-- | support/doc/api/openapi.yaml | 43 |
1 files changed, 24 insertions, 19 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index c84dc3307..7e290a41e 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -512,25 +512,6 @@ paths: | |||
512 | type: array | 512 | type: array |
513 | items: | 513 | items: |
514 | type: string | 514 | type: string |
515 | /videos/search: | ||
516 | get: | ||
517 | tags: | ||
518 | - Video | ||
519 | consumes: | ||
520 | - application/json | ||
521 | produces: | ||
522 | - application/json | ||
523 | parameters: | ||
524 | - $ref: "commons.yaml#/parameters/start" | ||
525 | - $ref: "commons.yaml#/parameters/count" | ||
526 | - $ref: "commons.yaml#/parameters/sort" | ||
527 | responses: | ||
528 | '200': | ||
529 | description: successful operation | ||
530 | schema: | ||
531 | type: array | ||
532 | items: | ||
533 | $ref: '#/definitions/Video' | ||
534 | "/videos/{id}": | 515 | "/videos/{id}": |
535 | put: | 516 | put: |
536 | security: | 517 | security: |
@@ -957,6 +938,30 @@ paths: | |||
957 | responses: | 938 | responses: |
958 | '204': | 939 | '204': |
959 | $ref: "commons.yaml#/responses/emptySuccess" | 940 | $ref: "commons.yaml#/responses/emptySuccess" |
941 | /search/videos: | ||
942 | get: | ||
943 | tags: | ||
944 | - Search | ||
945 | consumes: | ||
946 | - application/json | ||
947 | produces: | ||
948 | - application/json | ||
949 | parameters: | ||
950 | - $ref: "commons.yaml#/parameters/start" | ||
951 | - $ref: "commons.yaml#/parameters/count" | ||
952 | - $ref: "commons.yaml#/parameters/sort" | ||
953 | - name: query | ||
954 | in: query | ||
955 | required: true | ||
956 | type: string | ||
957 | description: 'String to search' | ||
958 | responses: | ||
959 | '200': | ||
960 | description: successful operation | ||
961 | schema: | ||
962 | type: array | ||
963 | items: | ||
964 | $ref: '#/definitions/Video' | ||
960 | definitions: | 965 | definitions: |
961 | VideoConstantNumber: | 966 | VideoConstantNumber: |
962 | properties: | 967 | properties: |