Fix: requestBody descriptions

This commit is contained in:
Nicholas Wallace 2024-05-15 04:28:15 +00:00
parent e8797ce0c8
commit 88ef453b56
2 changed files with 59 additions and 16 deletions

View file

@ -147,8 +147,16 @@ paths:
tags: tags:
- Authors - Authors
requestBody: requestBody:
$ref: '#/components/requestBody/authorInclude' required: false
$ref: '#/components/requestBody/authorLibraryId' description: The author object to create.
content:
application/json:
schema:
properties:
include:
$ref: '#/components/requestBody/authorInclude'
library:
$ref: '#/components/requestBody/authorLibraryId'
responses: responses:
'200': '200':
description: getAuthorById OK description: getAuthorById OK
@ -166,13 +174,19 @@ paths:
- Authors - Authors
requestBody: requestBody:
required: true required: true
description: The author object to update.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/requestBody/authorName' properties:
$ref: '#/components/requestBody/authorDescription' name:
$ref: '#/components/requestBody/authorImagePath' $ref: '#/components/requestBody/authorName'
$ref: '#/components/requestBody/asin' description:
$ref: '#/components/requestBody/authorDescription'
imagePath:
$ref: '#/components/requestBody/authorImagePath'
asin:
$ref: '#/components/requestBody/asin'
responses: responses:
'200': '200':
description: updateAuthorById OK description: updateAuthorById OK
@ -216,10 +230,20 @@ paths:
tags: tags:
- Authors - Authors
requestBody: requestBody:
$ref: '#/components/requestBody/imageWidth' required: false
$ref: '#/components/requestBody/imageHeight' description: The author image to get.
$ref: '#/components/requestBody/imageFormat' content:
$ref: '#/components/requestBody/imageRaw' application/json:
schema:
properties:
width:
$ref: '#/components/requestBody/imageWidth'
height:
$ref: '#/components/requestBody/imageHeight'
format:
$ref: '#/components/requestBody/imageFormat'
raw:
$ref: '#/components/requestBody/imageRaw'
responses: responses:
'200': '200':
description: getAuthorImageById OK description: getAuthorImageById OK
@ -248,6 +272,7 @@ paths:
$ref: '#/components/requestBody/imageUrl' $ref: '#/components/requestBody/imageUrl'
requestBody: requestBody:
required: true required: true
description: The author image to add by URL.
content: content:
application/json: application/json:
schema: schema:
@ -269,10 +294,20 @@ paths:
tags: tags:
- Authors - Authors
requestBody: requestBody:
$ref: '#/components/requestBody/imageWidth' required: true
$ref: '#/components/requestBody/imageHeight' description: The author image to update.
$ref: '#/components/requestBody/imageFormat' content:
$ref: '#/components/requestBody/imageRaw' application/json:
schema:
properties:
width:
$ref: '#/components/requestBody/imageWidth'
height:
$ref: '#/components/requestBody/imageHeight'
format:
$ref: '#/components/requestBody/imageFormat'
raw:
$ref: '#/components/requestBody/imageRaw'
responses: responses:
'200': '200':
description: updateAuthorImageById OK description: updateAuthorImageById OK
@ -309,8 +344,14 @@ paths:
tags: tags:
- Authors - Authors
requestBody: requestBody:
$ref: '#/components/requestBody/asin' required: true
$ref: '#/components/requestBody/authorSearchName' description: The author object to match against an online provider.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/requestBody/asin'
- $ref: '#/components/requestBody/authorSearchName'
responses: responses:
'200': '200':
description: matchAuthorById OK description: matchAuthorById OK

View file

@ -99,6 +99,7 @@ paths:
- Libraries - Libraries
requestBody: requestBody:
required: true required: true
description: The library object to create.
content: content:
application/json: application/json:
schema: schema:
@ -150,6 +151,7 @@ paths:
- Libraries - Libraries
requestBody: requestBody:
required: true required: true
description: The library object to update.
content: content:
application/json: application/json:
schema: schema: