Replace: generic parameter with path specific parameter

This commit is contained in:
Nicholas Wallace 2024-05-15 04:18:29 +00:00
parent 1430946e0e
commit e8797ce0c8
2 changed files with 27 additions and 25 deletions

View file

@ -117,14 +117,6 @@ components:
schema: schema:
type: boolean type: boolean
default: false default: false
parameters:
authorId:
name: id
in: path
description: Author ID
required: true
schema:
$ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
responses: responses:
author200: author200:
description: Author found. description: Author found.
@ -141,14 +133,19 @@ components:
example: Author not found. example: Author not found.
paths: paths:
/api/authors/{id}: /api/authors/{id}:
parameters:
- name: id
in: path
description: Author ID
required: true
schema:
$ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
get: get:
operationId: getAuthorById operationId: getAuthorById
summary: Get an author by ID summary: Get an author by ID
description: Get an author by ID. The author's books and series can be included in the response. description: Get an author by ID. The author's books and series can be included in the response.
tags: tags:
- Authors - Authors
parameters:
$ref: '#/components/parameters/authorId'
requestBody: requestBody:
$ref: '#/components/requestBody/authorInclude' $ref: '#/components/requestBody/authorInclude'
$ref: '#/components/requestBody/authorLibraryId' $ref: '#/components/requestBody/authorLibraryId'
@ -205,14 +202,19 @@ paths:
'404': '404':
$ref: '#/components/responses/author404' $ref: '#/components/responses/author404'
/api/authors/{id}/image: /api/authors/{id}/image:
parameters:
- name: id
in: path
description: Author ID
required: true
schema:
$ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
get: get:
operationId: getAuthorImageById operationId: getAuthorImageById
summary: Get an author image by author ID summary: Get an author image by author ID
description: Get an author image by author ID. The image will be returned in the requested format and size. description: Get an author image by author ID. The image will be returned in the requested format and size.
tags: tags:
- Authors - Authors
parameters:
$ref: '#/components/parameters/authorId'
requestBody: requestBody:
$ref: '#/components/requestBody/imageWidth' $ref: '#/components/requestBody/imageWidth'
$ref: '#/components/requestBody/imageHeight' $ref: '#/components/requestBody/imageHeight'
@ -287,22 +289,25 @@ paths:
description: Delete an author image by author ID. This will remove the image from the server and the database. description: Delete an author image by author ID. This will remove the image from the server and the database.
tags: tags:
- Authors - Authors
parameters:
$ref: '#/components/parameters/authorId'
responses: responses:
'200': '200':
description: deleteAuthorImageById OK description: deleteAuthorImageById OK
'404': '404':
$ref: '#/components/responses/author404' $ref: '#/components/responses/author404'
/api/authors/{id}/match: /api/authors/{id}/match:
parameters:
- name: id
in: path
description: Author ID
required: true
schema:
$ref: '../objects/entities/Author.yaml#/components/schemas/authorId'
post: post:
operationId: matchAuthorById operationId: matchAuthorById
summary: Match the author against Audible using quick match summary: Match the author against Audible using quick match
description: Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided. description: Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided.
tags: tags:
- Authors - Authors
parameters:
$ref: '#/components/parameters/authorId'
requestBody: requestBody:
$ref: '#/components/requestBody/asin' $ref: '#/components/requestBody/asin'
$ref: '#/components/requestBody/authorSearchName' $ref: '#/components/requestBody/authorSearchName'

View file

@ -1,12 +1,4 @@
components: components:
parameters:
libraryId:
name: id
in: path
description: The ID of the library.
required: true
schema:
$ref: '../objects/Library.yaml#/components/schemas/libraryId'
requestBody: requestBody:
libraryName: libraryName:
name: name name: name
@ -133,7 +125,12 @@ paths:
$ref: '#/components/responses/library404' $ref: '#/components/responses/library404'
/api/libraries/{id}: /api/libraries/{id}:
parameters: parameters:
$ref: '#/components/parameters/libraryId' - name: id
in: path
description: The ID of the library.
required: true
schema:
$ref: '../objects/Library.yaml#/components/schemas/libraryId'
get: get:
operationId: getLibraryById operationId: getLibraryById
summary: Get a single library by ID on server summary: Get a single library by ID on server