feat(docs): add more collection schema updates
This commit is contained in:
parent
f412fee577
commit
2af0d2c5ff
|
@ -61,22 +61,20 @@ paths:
|
||||||
summary: "Add a new collection"
|
summary: "Add a new collection"
|
||||||
description: "Add a new collection to the server"
|
description: "Add a new collection to the server"
|
||||||
operationId: postCollection
|
operationId: postCollection
|
||||||
responses:
|
requestBody:
|
||||||
"200":
|
description: "The new metadata of the collection"
|
||||||
description: Successful operation
|
required: true
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
allOf:
|
$ref: "specs/collections/schema.yml#/NewCollection"
|
||||||
- $ref: "#/components/schemas/Pagination"
|
responses:
|
||||||
- type: object
|
"201":
|
||||||
required:
|
description: Created
|
||||||
- results
|
content:
|
||||||
properties:
|
application/json:
|
||||||
results:
|
schema:
|
||||||
type: array
|
$ref: "specs/collections/schema.yml#/SimpleCollection"
|
||||||
items:
|
|
||||||
$ref: "specs/collections/schema.yml#/Collection"
|
|
||||||
/api/v2/collections/{guid}:
|
/api/v2/collections/{guid}:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
|
@ -99,6 +97,51 @@ paths:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "specs/collections/schema.yml#/Collection"
|
$ref: "specs/collections/schema.yml#/Collection"
|
||||||
|
patch:
|
||||||
|
tags:
|
||||||
|
- Collections
|
||||||
|
summary: "Update the metadata of a collection"
|
||||||
|
description: "Change metadata and details about a specific collection"
|
||||||
|
operationId: patchCollection
|
||||||
|
parameters:
|
||||||
|
- name: guid
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
description: The GUID of the collection
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
requestBody:
|
||||||
|
description: "The new metadata of the collection"
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "specs/collections/schema.yml#/UpdateCollection"
|
||||||
|
responses:
|
||||||
|
"202":
|
||||||
|
description: Accepted
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "specs/collections/schema.yml#/SimpleCollection"
|
||||||
|
delete:
|
||||||
|
tags:
|
||||||
|
- Collections
|
||||||
|
summary: "Delete a specific collection"
|
||||||
|
description: "Delete a collection. This does not delete the associated uploads."
|
||||||
|
operationId: deleteCollection
|
||||||
|
parameters:
|
||||||
|
- name: guid
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
description: The GUID of the collection
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful operation
|
||||||
/api/v2/instance/nodeinfo/2.1:
|
/api/v2/instance/nodeinfo/2.1:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
|
@ -249,7 +292,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/CreateRelease"
|
$ref: "#/components/schemas/CreateRelease"
|
||||||
responses:
|
responses:
|
||||||
"202":
|
"201":
|
||||||
description: Created
|
description: Created
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
|
|
|
@ -28,6 +28,26 @@ Collection:
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
description: "The user-defined description of the collection"
|
description: "The user-defined description of the collection"
|
||||||
items:
|
recordingCount:
|
||||||
type: integer
|
type: integer
|
||||||
description: "The total number of items in the collection"
|
description: "The total number of items in the collection"
|
||||||
|
NewCollection:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- name
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: "The new name for the collection"
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
description: "The new description for the collection"
|
||||||
|
UpdateCollection:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: "The new name for the collection"
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
description: "The new description for the collection"
|
||||||
|
|
Loading…
Reference in New Issue