Update yaml keys to camelCase

This commit is contained in:
advplyr 2024-04-20 14:55:57 -05:00
parent ca7eaf9750
commit 8e6ead59ce
4 changed files with 25 additions and 25 deletions

View File

@ -5,7 +5,7 @@ components:
type: boolean type: boolean
nullable: true nullable: true
parameters: parameters:
authorID: authorId:
name: id name: id
in: path in: path
description: Author ID description: Author ID
@ -43,7 +43,7 @@ components:
description: The Audible Identifier (ASIN). description: The Audible Identifier (ASIN).
required: false required: false
schema: schema:
$ref: '../objects/entities/Author.yaml#/components/schemas/authorASIN' $ref: '../objects/entities/Author.yaml#/components/schemas/authorAsin'
authorSearchName: authorSearchName:
name: q name: q
in: query in: query
@ -77,7 +77,7 @@ components:
type: string type: string
nullable: true nullable: true
example: /metadata/authors/aut_z3leimgybl7uf3y4ab.jpg example: /metadata/authors/aut_z3leimgybl7uf3y4ab.jpg
imageURL: imageUrl:
name: url name: url
in: query in: query
description: The URL of the image to add to the server description: The URL of the image to add to the server

View File

@ -5,7 +5,7 @@ components:
description: The ID of the author. description: The ID of the author.
format: uuid format: uuid
example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
authorASIN: authorAsin:
type: string type: string
description: The Audible identifier (ASIN) of the author. Will be null if unknown. Not the Amazon identifier. description: The Audible identifier (ASIN) of the author. Will be null if unknown. Not the Amazon identifier.
nullable: true nullable: true
@ -34,7 +34,7 @@ components:
id: id:
$ref: '#/components/schemas/authorId' $ref: '#/components/schemas/authorId'
asin: asin:
$ref: '#/components/schemas/authorASIN' $ref: '#/components/schemas/authorAsin'
name: name:
$ref: '#/components/schemas/authorName' $ref: '#/components/schemas/authorName'
description: description:

Binary file not shown.

View File

@ -13,17 +13,17 @@ components:
paths: paths:
/api/authors/{id}: /api/authors/{id}:
get: get:
operationId: getAuthorByID operationId: getAuthorById
summary: Get a single author by ID on server summary: Get a single author by ID on server
tags: tags:
- Authors - Authors
parameters: parameters:
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorID' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorInclude' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorInclude'
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorLibraryId' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorLibraryId'
responses: responses:
200: 200:
description: getAuthorByID OK description: getAuthorById OK
content: content:
application/json: application/json:
schema: schema:
@ -34,19 +34,19 @@ paths:
404: 404:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
patch: patch:
operationId: updateAuthorByID operationId: updateAuthorById
summary: Update a single author by ID on server. This endpoint will merge two authors if the new author name matches another author in the database. summary: Update a single author by ID on server. This endpoint will merge two authors if the new author name matches another author in the database.
tags: tags:
- Authors - Authors
parameters: parameters:
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorID' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
- $ref: './controllers/AuthorController.yaml#/components/parameters/asin' - $ref: './controllers/AuthorController.yaml#/components/parameters/asin'
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorName' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorName'
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorDescription' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorDescription'
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorImagePath' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorImagePath'
responses: responses:
200: 200:
description: updateAuthorByID OK description: updateAuthorById OK
content: content:
application/json: application/json:
schema: schema:
@ -62,12 +62,12 @@ paths:
404: 404:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
delete: delete:
operationId: deleteAuthorByID operationId: deleteAuthorById
summary: Delete a single author by ID on server and remove author from all books. summary: Delete a single author by ID on server and remove author from all books.
tags: tags:
- Authors - Authors
parameters: parameters:
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorID' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
responses: responses:
200: 200:
$ref: '#/components/responses/ok200' $ref: '#/components/responses/ok200'
@ -75,16 +75,16 @@ paths:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
/api/authors/{id}/image: /api/authors/{id}/image:
post: post:
operationId: setAuthorImageByID operationId: setAuthorImageById
summary: Set an author image using a provided URL. summary: Set an author image using a provided URL.
tags: tags:
- Authors - Authors
parameters: parameters:
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorID' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
- $ref: './controllers/AuthorController.yaml#/components/parameters/imageURL' - $ref: './controllers/AuthorController.yaml#/components/parameters/imageUrl'
responses: responses:
200: 200:
description: setAuthorImageByID OK description: setAuthorImageById OK
content: content:
application/json: application/json:
schema: schema:
@ -93,31 +93,31 @@ paths:
404: 404:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
delete: delete:
operationId: deleteAuthorImageByID operationId: deleteAuthorImageById
summary: Delete an author image from the server and remove the image from the database. summary: Delete an author image from the server and remove the image from the database.
tags: tags:
- Authors - Authors
parameters: parameters:
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorID' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
responses: responses:
200: 200:
$ref: '#/components/responses/ok200' $ref: '#/components/responses/ok200'
404: 404:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
patch: patch:
operationId: getAuthorImageByID operationId: getAuthorImageById
summary: Return the author image by author ID. summary: Return the author image by author ID.
tags: tags:
- Authors - Authors
parameters: parameters:
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorID' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
- $ref: './controllers/AuthorController.yaml#/components/parameters/imageWidth' - $ref: './controllers/AuthorController.yaml#/components/parameters/imageWidth'
- $ref: './controllers/AuthorController.yaml#/components/parameters/imageHeight' - $ref: './controllers/AuthorController.yaml#/components/parameters/imageHeight'
- $ref: './controllers/AuthorController.yaml#/components/parameters/imageFormat' - $ref: './controllers/AuthorController.yaml#/components/parameters/imageFormat'
- $ref: './controllers/AuthorController.yaml#/components/parameters/imageRaw' - $ref: './controllers/AuthorController.yaml#/components/parameters/imageRaw'
responses: responses:
200: 200:
description: getAuthorImageByID OK description: getAuthorImageById OK
content: content:
image/*: image/*:
schema: schema:
@ -127,17 +127,17 @@ paths:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
/api/authors/{id}/match: /api/authors/{id}/match:
post: post:
operationId: matchAuthorByID operationId: matchAuthorById
summary: 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. summary: 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: parameters:
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorID' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorId'
- $ref: './controllers/AuthorController.yaml#/components/parameters/asin' - $ref: './controllers/AuthorController.yaml#/components/parameters/asin'
- $ref: './controllers/AuthorController.yaml#/components/parameters/authorSearchName' - $ref: './controllers/AuthorController.yaml#/components/parameters/authorSearchName'
responses: responses:
200: 200:
description: matchAuthorByID OK description: matchAuthorById OK
content: content:
application/json: application/json:
schema: schema: