Implemented the GET /users/{username}/lists endpoint for the Open API specification document in the library target.
This commit is contained in:
@@ -1601,13 +1601,13 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
description: A type that contains a list of releases in a wantlist.
|
description: A type that contains a list of lists of a user.
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
pagination:
|
pagination:
|
||||||
$ref: '#/components/schemas/Pagination'
|
$ref: '#/components/schemas/Pagination'
|
||||||
wants:
|
wants:
|
||||||
description: A list of releases in a wantlist.
|
description: A list of lists of a user.
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/ReleaseInFolder'
|
$ref: '#/components/schemas/ReleaseInFolder'
|
||||||
@@ -1739,6 +1739,52 @@ paths:
|
|||||||
$ref: '#/components/responses/NotFound'
|
$ref: '#/components/responses/NotFound'
|
||||||
'500':
|
'500':
|
||||||
$ref: '#/components/responses/InternalError'
|
$ref: '#/components/responses/InternalError'
|
||||||
|
/users/{username}/lists:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- User Lists
|
||||||
|
summary: Get a list of lists of a user.
|
||||||
|
description: |
|
||||||
|
Returns a list of lists created by a users.
|
||||||
|
|
||||||
|
This endpoints accepts pagination and, to show private lists it is required to be authenticated as a owner.
|
||||||
|
operationId: getLists
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Username'
|
||||||
|
- $ref: '#/components/parameters/Page'
|
||||||
|
- $ref: '#/components/parameters/PerPage'
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Successfully retrieved a list of lists of a user.
|
||||||
|
headers:
|
||||||
|
Link:
|
||||||
|
$ref: '#/components/headers/Link'
|
||||||
|
X-Discogs-RateLimit:
|
||||||
|
$ref: '#/components/headers/RateLimit'
|
||||||
|
X-Discogs-RateLimit-Used:
|
||||||
|
$ref: '#/components/headers/RateLimitUsed'
|
||||||
|
X-Discogs-RateLimit-Remaining:
|
||||||
|
$ref: '#/components/headers/RateLimitRemaining'
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
description: A type that contains a list of lists of a user.
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
pagination:
|
||||||
|
$ref: '#/components/schemas/Pagination'
|
||||||
|
lists:
|
||||||
|
description: A list of lists of a user.
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/ListId'
|
||||||
|
required:
|
||||||
|
- lists
|
||||||
|
- pagination
|
||||||
|
'404':
|
||||||
|
$ref: '#/components/responses/NotFound'
|
||||||
|
'500':
|
||||||
|
$ref: '#/components/responses/InternalError'
|
||||||
components:
|
components:
|
||||||
headers:
|
headers:
|
||||||
Link:
|
Link:
|
||||||
@@ -2555,6 +2601,50 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
enum: [label]
|
enum: [label]
|
||||||
|
ListId:
|
||||||
|
description: A type that references a list.
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: An identifier of a list.
|
||||||
|
type: integer
|
||||||
|
minimum: 0
|
||||||
|
readOnly: true
|
||||||
|
uri:
|
||||||
|
description: A URI representation of a list.
|
||||||
|
type: string
|
||||||
|
format: uri
|
||||||
|
resource_url:
|
||||||
|
description: A URI resource of a list.
|
||||||
|
type: string
|
||||||
|
format: uri
|
||||||
|
readOnly: true
|
||||||
|
name:
|
||||||
|
description: A name of a list.
|
||||||
|
type: string
|
||||||
|
description:
|
||||||
|
description: A descriptive explanation of a list.
|
||||||
|
type: string
|
||||||
|
public:
|
||||||
|
description: A flag that indicates whether a list is public or not.
|
||||||
|
type: boolean
|
||||||
|
date_added:
|
||||||
|
description: A date and time in which a list was created.
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
date_changed:
|
||||||
|
description: A date and time in which a list was last changed.
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
required:
|
||||||
|
- date_added
|
||||||
|
- date_changed
|
||||||
|
- description
|
||||||
|
- id
|
||||||
|
- name
|
||||||
|
- public
|
||||||
|
- resource_url
|
||||||
|
- uri
|
||||||
Master:
|
Master:
|
||||||
description: A type that represents a set of similar releases.
|
description: A type that represents a set of similar releases.
|
||||||
type: object
|
type: object
|
||||||
|
|||||||
Reference in New Issue
Block a user