Declared the "Key" and "Name" parameters for the components of the Open API specification document in the library target.
This commit is contained in:
@@ -153,6 +153,11 @@ paths:
|
|||||||
operationId: getAmiiboSeries
|
operationId: getAmiiboSeries
|
||||||
tags:
|
tags:
|
||||||
- Amiibo
|
- Amiibo
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Key'
|
||||||
|
description: A key of an amiibo series to include in the response.
|
||||||
|
- $ref: '#/components/parameters/Name'
|
||||||
|
description: A name of an amiibo series key to include in the response.
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
$ref: '#/components/responses/SuccessTuple'
|
$ref: '#/components/responses/SuccessTuple'
|
||||||
@@ -162,27 +167,17 @@ paths:
|
|||||||
description: An amiibo series not found.
|
description: An amiibo series not found.
|
||||||
'500':
|
'500':
|
||||||
description: Service is not available.
|
description: Service is not available.
|
||||||
parameters:
|
|
||||||
- name: key
|
|
||||||
in: query
|
|
||||||
description: The Amiibo series key to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
- name: name
|
|
||||||
in: query
|
|
||||||
description: The Amiibo series name to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
/character:
|
/character:
|
||||||
get:
|
get:
|
||||||
description: Get a list of all the game characters available in the database.
|
description: Get a list of all the game characters available in the database.
|
||||||
operationId: getGameCharacters
|
operationId: getGameCharacters
|
||||||
tags:
|
tags:
|
||||||
- Game
|
- Game
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Key'
|
||||||
|
description: A key of a game character key to include in the response.
|
||||||
|
- $ref: '#/components/parameters/Name'
|
||||||
|
description: A name of a game character key to include in the response.
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
$ref: '#/components/responses/SuccessTuple'
|
$ref: '#/components/responses/SuccessTuple'
|
||||||
@@ -192,27 +187,17 @@ paths:
|
|||||||
description: A game character not found.
|
description: A game character not found.
|
||||||
'500':
|
'500':
|
||||||
description: Service is not available.
|
description: Service is not available.
|
||||||
parameters:
|
|
||||||
- name: key
|
|
||||||
in: query
|
|
||||||
description: The game character key to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
- name: name
|
|
||||||
in: query
|
|
||||||
description: The game character name to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
/gameseries:
|
/gameseries:
|
||||||
get:
|
get:
|
||||||
description: Gets a list of all the game series available in the database.
|
description: Gets a list of all the game series available in the database.
|
||||||
operationId: getGameSeries
|
operationId: getGameSeries
|
||||||
tags:
|
tags:
|
||||||
- Game
|
- Game
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Key'
|
||||||
|
description: A key of a game series to include in the response.
|
||||||
|
- $ref: '#/components/parameters/Name'
|
||||||
|
description: A name of a game series to include in the response.
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
$ref: '#/components/responses/SuccessTuple'
|
$ref: '#/components/responses/SuccessTuple'
|
||||||
@@ -222,27 +207,17 @@ paths:
|
|||||||
description: A game series not found.
|
description: A game series not found.
|
||||||
'500':
|
'500':
|
||||||
description: Service is not available.
|
description: Service is not available.
|
||||||
parameters:
|
|
||||||
- name: key
|
|
||||||
in: query
|
|
||||||
description: The game series key to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
- name: name
|
|
||||||
in: query
|
|
||||||
description: The game series name to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
/type:
|
/type:
|
||||||
get:
|
get:
|
||||||
description: Gets a list of all the Amiibo types available in the database.
|
description: Gets a list of all the Amiibo types available in the database.
|
||||||
operationId: getAmiiboTypes
|
operationId: getAmiiboTypes
|
||||||
tags:
|
tags:
|
||||||
- Amiibo
|
- Amiibo
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/Key'
|
||||||
|
description: A key of an amiibo type to include in the response.
|
||||||
|
- $ref: '#/components/parameters/Name'
|
||||||
|
description: A name of an amiibo type to include in the response.
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
$ref: '#/components/responses/SuccessTuple'
|
$ref: '#/components/responses/SuccessTuple'
|
||||||
@@ -252,21 +227,6 @@ paths:
|
|||||||
description: An amiibo type not found.
|
description: An amiibo type not found.
|
||||||
'500':
|
'500':
|
||||||
description: Service is not available.
|
description: Service is not available.
|
||||||
parameters:
|
|
||||||
- name: key
|
|
||||||
in: query
|
|
||||||
description: The Amiibo type key to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
- name: name
|
|
||||||
in: query
|
|
||||||
description: The Amiibo type name to filter the response.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
style: form
|
|
||||||
/lastupdated:
|
/lastupdated:
|
||||||
get:
|
get:
|
||||||
description: Gets a timestamp when the Amiibo data was last updated.
|
description: Gets a timestamp when the Amiibo data was last updated.
|
||||||
@@ -287,6 +247,21 @@ paths:
|
|||||||
'500':
|
'500':
|
||||||
description: Service is not available.
|
description: Service is not available.
|
||||||
components:
|
components:
|
||||||
|
parameters:
|
||||||
|
Key:
|
||||||
|
description: A key of a type to include in the response.
|
||||||
|
name: key
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
Name:
|
||||||
|
description: A name of a type to include in the response.
|
||||||
|
name: name
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
responses:
|
responses:
|
||||||
SuccessTuple:
|
SuccessTuple:
|
||||||
description: Response that returns a JSON object containing requested `Tuple` data from a resource.
|
description: Response that returns a JSON object containing requested `Tuple` data from a resource.
|
||||||
|
|||||||
Reference in New Issue
Block a user