diff --git a/Sources/AmiiboService/openapi.yaml b/Sources/AmiiboService/openapi.yaml index 5806e11..bf6f7d9 100644 --- a/Sources/AmiiboService/openapi.yaml +++ b/Sources/AmiiboService/openapi.yaml @@ -153,6 +153,11 @@ paths: operationId: getAmiiboSeries tags: - 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: '200': $ref: '#/components/responses/SuccessTuple' @@ -162,27 +167,17 @@ paths: description: An amiibo series not found. '500': 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: get: description: Get a list of all the game characters available in the database. operationId: getGameCharacters tags: - 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: '200': $ref: '#/components/responses/SuccessTuple' @@ -192,27 +187,17 @@ paths: description: A game character not found. '500': 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: get: description: Gets a list of all the game series available in the database. operationId: getGameSeries tags: - 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: '200': $ref: '#/components/responses/SuccessTuple' @@ -222,27 +207,17 @@ paths: description: A game series not found. '500': 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: get: description: Gets a list of all the Amiibo types available in the database. operationId: getAmiiboTypes tags: - 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: '200': $ref: '#/components/responses/SuccessTuple' @@ -252,21 +227,6 @@ paths: description: An amiibo type not found. '500': 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: get: description: Gets a timestamp when the Amiibo data was last updated. @@ -287,6 +247,21 @@ paths: '500': description: Service is not available. 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: SuccessTuple: description: Response that returns a JSON object containing requested `Tuple` data from a resource.