[bugfix]: Add missing Link headers in Swagger spec (#2751)

* Adds Link headers to all endpoints that use it for paging
* Fixes the return type for listing what accounts someone follows
This commit is contained in:
Vyr Cossont 2024-03-13 04:23:26 -07:00 committed by GitHub
parent c27049ad15
commit 13b9fd5f92
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 47 additions and 3 deletions

View File

@ -2907,6 +2907,10 @@ paths:
responses: responses:
"200": "200":
description: Array of accounts that follow this account. description: Array of accounts that follow this account.
headers:
Link:
description: Links to the next and previous queries.
type: string
schema: schema:
items: items:
$ref: '#/definitions/account' $ref: '#/definitions/account'
@ -2967,6 +2971,14 @@ paths:
responses: responses:
"200": "200":
description: Array of accounts that are followed by this account. description: Array of accounts that are followed by this account.
headers:
Link:
description: Links to the next and previous queries.
type: string
schema:
items:
$ref: '#/definitions/account'
type: array
"400": "400":
description: bad request description: bad request
"401": "401":
@ -3109,6 +3121,10 @@ paths:
responses: responses:
"200": "200":
description: Array of statuses. description: Array of statuses.
headers:
Link:
description: Links to the next and previous queries.
type: string
schema: schema:
items: items:
$ref: '#/definitions/status' $ref: '#/definitions/status'
@ -4875,6 +4891,10 @@ paths:
responses: responses:
"200": "200":
description: Array of reports. description: Array of reports.
headers:
Link:
description: Links to the next and previous queries.
type: string
schema: schema:
items: items:
$ref: '#/definitions/adminReport' $ref: '#/definitions/adminReport'
@ -6614,6 +6634,10 @@ paths:
responses: responses:
"200": "200":
description: Array of reports. description: Array of reports.
headers:
Link:
description: Links to the next and previous queries.
type: string
schema: schema:
items: items:
$ref: '#/definitions/report' $ref: '#/definitions/report'

View File

@ -102,6 +102,10 @@ import (
// type: array // type: array
// items: // items:
// "$ref": "#/definitions/account" // "$ref": "#/definitions/account"
// headers:
// Link:
// type: string
// description: Links to the next and previous queries.
// '400': // '400':
// description: bad request // description: bad request
// '401': // '401':

View File

@ -99,9 +99,13 @@ import (
// name: accounts // name: accounts
// description: Array of accounts that are followed by this account. // description: Array of accounts that are followed by this account.
// schema: // schema:
// type: array // type: array
// items: // items:
// "$ref": "#/definitions/account" // "$ref": "#/definitions/account"
// headers:
// Link:
// type: string
// description: Links to the next and previous queries.
// '400': // '400':
// description: bad request // description: bad request
// '401': // '401':

View File

@ -119,6 +119,10 @@ import (
// type: array // type: array
// items: // items:
// "$ref": "#/definitions/status" // "$ref": "#/definitions/status"
// headers:
// Link:
// type: string
// description: Links to the next and previous queries.
// '400': // '400':
// description: bad request // description: bad request
// '401': // '401':

View File

@ -112,6 +112,10 @@ import (
// type: array // type: array
// items: // items:
// "$ref": "#/definitions/adminReport" // "$ref": "#/definitions/adminReport"
// headers:
// Link:
// type: string
// description: Links to the next and previous queries.
// '400': // '400':
// description: bad request // description: bad request
// '401': // '401':

View File

@ -108,6 +108,10 @@ import (
// type: array // type: array
// items: // items:
// "$ref": "#/definitions/report" // "$ref": "#/definitions/report"
// headers:
// Link:
// type: string
// description: Links to the next and previous queries.
// '400': // '400':
// description: bad request // description: bad request
// '401': // '401':