rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity

Open API specification improvements and License update #17

Merged
javier merged 9 commits from library/testing-improvements into main 2025-10-07 22:07:56 +00:00
Conversation 0 Commits 9 Files Changed 127
+19 -40
1 changed files with 19 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 9fe5a74206 - Show all commits
Sources/AmiiboService/openapi.yaml
+19 -40
View File
@@ -63,17 +63,17 @@ paths:
- Amiibo - Amiibo
responses: responses:
'200': '200':
description: Response that retuns a decodable JSON object containing a list of Amiibo items. description: Response that retuns a decodable JSON object wrapping a list of Amiibo items.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/AmiiboWrapper' $ref: '#/components/schemas/AmiiboWrapper'
'400': '400':
$ref: '#/components/responses/BadRequest' description: An amiibo bad request.
'404': '404':
$ref: '#/components/responses/NotFound' description: An amiibo not found.
'500': '500':
$ref: '#/components/responses/Unavailable' description: Service is not available.
parameters: parameters:
- name: amiiboSeries - name: amiiboSeries
in: query in: query
@@ -155,11 +155,11 @@ paths:
'200': '200':
$ref: '#/components/responses/SuccessTuple' $ref: '#/components/responses/SuccessTuple'
'400': '400':
$ref: '#/components/responses/BadRequest' description: An amiibo series bad request.
'404': '404':
$ref: '#/components/responses/NotFound' description: An amiibo series not found.
'500': '500':
$ref: '#/components/responses/Unavailable' description: Service is not available.
parameters: parameters:
- name: key - name: key
in: query in: query
@@ -185,11 +185,11 @@ paths:
'200': '200':
$ref: '#/components/responses/SuccessTuple' $ref: '#/components/responses/SuccessTuple'
'400': '400':
$ref: '#/components/responses/BadRequest' description: A game character bad request.
'404': '404':
$ref: '#/components/responses/NotFound' description: A game character not found.
'500': '500':
$ref: '#/components/responses/Unavailable' description: Service is not available.
parameters: parameters:
- name: key - name: key
in: query in: query
@@ -215,11 +215,11 @@ paths:
'200': '200':
$ref: '#/components/responses/SuccessTuple' $ref: '#/components/responses/SuccessTuple'
'400': '400':
$ref: '#/components/responses/BadRequest' description: A game series bad request.
'404': '404':
$ref: '#/components/responses/NotFound' description: A game series not found.
'500': '500':
$ref: '#/components/responses/Unavailable' description: Service is not available.
parameters: parameters:
- name: key - name: key
in: query in: query
@@ -245,11 +245,11 @@ paths:
'200': '200':
$ref: '#/components/responses/SuccessTuple' $ref: '#/components/responses/SuccessTuple'
'400': '400':
$ref: '#/components/responses/BadRequest' description: An amiibo type bad request.
'404': '404':
$ref: '#/components/responses/NotFound' description: An amiibo type not found.
'500': '500':
$ref: '#/components/responses/Unavailable' description: Service is not available.
parameters: parameters:
- name: key - name: key
in: query in: query
@@ -279,40 +279,19 @@ paths:
schema: schema:
$ref: '#/components/schemas/LastUpdated' $ref: '#/components/schemas/LastUpdated'
'400': '400':
$ref: '#/components/responses/BadRequest' description: A last updated bad request.
'404': '404':
$ref: '#/components/responses/NotFound' description: A last updated not found.
'500': '500':
$ref: '#/components/responses/Unavailable' description: Service is not available.
components: components:
responses: responses:
BadRequest:
description: Response that indicates the service received a bad request.
content:
text/plain:
schema:
type: string
example: "Bad request"
NotFound:
description: Response that indicates the service cannot find a requested resource.
content:
text/plain:
schema:
type: string
example: "Not found"
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.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/TupleWrapper' $ref: '#/components/schemas/TupleWrapper'
Unavailable:
description: Response that indicates the service is unavailable to respond to requests.
content:
text/plain:
schema:
type: string
example: "Service unavailable"
schemas: schemas:
# Core Entities # Core Entities
Amiibo: Amiibo: