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

Added descriptions to the components types for the OpenAPI specification document in the library target.

Browse Source
This commit is contained in:
Javier Cicchelli
2025-10-07 19:35:59 +02:00
parent c2d6708b88
commit c55b6e467f
1 changed files with 73 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/openapi.yaml
+73 -9
View File
@@ -77,56 +77,70 @@ paths:
parameters: parameters:
- name: amiiboSeries - name: amiiboSeries
in: query in: query
description: The Amiibo series identifier or name to filter the response. description: An identifier or name of an Amiibo to filter the response.
required: false required: false
schema: schema:
type: string type: string
style: form style: form
- name: character - name: character
in: query in: query
description: The game character identifier or name to filter the response. description: An identifier or name of a game character to filter the response.
required: false required: false
schema: schema:
type: string type: string
style: form style: form
- name: gameseries - name: gameseries
in: query in: query
description: The game series identifier or name to filter the response. description: An identifier or name of a game series to filter the response.
required: false required: false
schema: schema:
type: string type: string
style: form style: form
- name: head
in: query
description: A last part of an identifier to filter the response.
required: false
schema:
type: string
style: form
- name: id - name: id
in: query in: query
description: The Amiibo identifier to filter the response. description: An identifier of an Amiibo to filter the response.
required: false required: false
schema: schema:
type: string type: string
style: form style: form
- name: name - name: name
in: query in: query
description: The Amiibo name to filter the response. description: A name of an Amiibo to filter the response.
required: false required: false
schema: schema:
type: string type: string
style: form style: form
- name: showgames - name: showgames
in: query in: query
description: The flag that indicates whether to include information about related games. description: A flag that indicates whether to include information about related games.
required: false required: false
schema: schema:
type: boolean type: boolean
style: form style: form
- name: showusage - name: showusage
in: query in: query
description: The flag that indicates whether to include information about Amiibo usage in related games. description: A flag that indicates whether to include information about Amiibo usage in related games.
required: false required: false
schema: schema:
type: boolean type: boolean
style: form style: form
- name: tail
in: query
description: A first part of an identifier to filter the response.
required: false
schema:
type: string
style: form
- name: type - name: type
in: query in: query
description: The Amiibo type to filter the response. description: An identifier or a name of an Amiibo type to filter the response.
required: false required: false
schema: schema:
type: string type: string
@@ -302,37 +316,59 @@ components:
schemas: schemas:
# Core Entities # Core Entities
Amiibo: Amiibo:
description: A type that contains all the information about an Amiibo.
type: object type: object
properties: properties:
amiiboSeries: amiiboSeries:
description: A name of the series the Amiibo belongs to.
type: string type: string
character: character:
description: |
A name of a character of An Amiibo.
Multiple character have different amiibo design.
type: string type: string
gameSeries: gameSeries:
description: A name of the game series the Amiibo belongs to.
type: string type: string
games3DS: games3DS:
description: A list of 3DS games an Amiibo could be used in, if any.
type: array type: array
items: items:
$ref: '#/components/schemas/AmiiboGame' $ref: '#/components/schemas/AmiiboGame'
gamesSwitch: gamesSwitch:
description: A list of Switch games an Amiibo could be used in, if any.
type: array type: array
items: items:
$ref: '#/components/schemas/AmiiboGame' $ref: '#/components/schemas/AmiiboGame'
gamesWiiU: gamesWiiU:
description: A list of Wii U games an Amiibo could be used in, if any.
type: array type: array
items: items:
$ref: '#/components/schemas/AmiiboGame' $ref: '#/components/schemas/AmiiboGame'
head: head:
description: |
The first 8 characters of the hexadecimal value that identifies an Amiibo.
The positions 0 to 7 of the hexadecimal string.
type: string type: string
image: image:
description: An image URL related to an Amiibo.
type: string type: string
name: name:
description: A name of an Amiibo.
type: string type: string
release: release:
description: A type that contains the release dates of an Amiibo, if any.
$ref: '#/components/schemas/AmiiboRelease' $ref: '#/components/schemas/AmiiboRelease'
tail: tail:
description: |
The last 8 characters of the hexadecimal value that identifies an Amiibo.
The positions 8 to 15 of the hexadecimal string.
type: string type: string
type: type:
description: A name for the type an Amiibo belongs to.
type: string type: string
required: required:
- amiiboSeries - amiiboSeries
@@ -345,86 +381,114 @@ components:
- tail - tail
- type - type
AmiiboGame: AmiiboGame:
description: A type that represents a game in which an Amiibo is related to.
type: object type: object
properties: properties:
amiiboUsage: amiiboUsage:
description: A list of available usages an Amiibo have in a game, if any.
type: array type: array
items: items:
$ref: '#/components/schemas/AmiiboUsage' $ref: '#/components/schemas/AmiiboUsage'
gameID: gameID:
description: A list of identifiers of a game an Amiibo is related to.
type: array type: array
items: items:
type: string type: string
gameName: gameName:
description: A name of a game an Amiibo is related to.
type: string type: string
required: required:
- gameID - gameID
- gameName - gameName
AmiiboList: AmiiboList:
description: A type that contains a list of `Amiibo` instances.
type: array type: array
items: items:
description: A list if `Amiibo` instance.
$ref: '#/components/schemas/Amiibo' $ref: '#/components/schemas/Amiibo'
AmiiboRelease: AmiiboRelease:
description: A type that contains the release dates of an Amiibo throughout the world.
type: object type: object
properties: properties:
au: au:
description: A release date for Australia, if any.
type: string type: string
format: date-time format: date-time
eu: eu:
description: A release date for Europe, if any.
type: string type: string
format: date-time format: date-time
jp: jp:
description: A release date for Japan, if any.
type: string type: string
format: date-time format: date-time
na: na:
description: A release date for North America, if any.
type: string type: string
format: date-time format: date-time
AmiiboUsage: AmiiboUsage:
description: A type that represents a use of an Amiibo in a game.
type: object type: object
properties: properties:
Usage: Usage:
description: An explanation of the usage of an Amiibo in a game.
type: string type: string
write: write:
description: A flag that indicates whether the data in an Amiibo is writable or not.
type: boolean type: boolean
required: required:
- Usage - Usage
- write - write
LastUpdated: LastUpdated:
description: A type that informs when the data in the service was last updated.
type: object type: object
properties: properties:
lastUpdated: lastUpdated:
description: The date and time when the data in the database was last updated.
type: string type: string
format: date-time format: date-time
required: required:
- lastUpdated - lastUpdated
# Wrapper Entities # Wrapper Entities
AmiiboWrapper: AmiiboWrapper:
description: A type that contains either one or multiple `Amiibo` instances.
type: object type: object
properties: properties:
amiibo: amiibo:
description: A property that contains one or multiple `Amiibo` instances.
oneOf: oneOf:
- $ref: '#/components/schemas/Amiibo' - $ref: '#/components/schemas/Amiibo'
- $ref: '#/components/schemas/AmiiboList' - $ref: '#/components/schemas/AmiiboList'
required: required:
- amiibo - amiibo
Tuple: Tuple:
description: |
A type that is conformed only by the `key` and `name` properties.
This type represents either `AmiiboSeries`, `AmiiboType`, `GameCharacter`, and `GameSeries` types.
type: object type: object
properties: properties:
key: key:
description: A key assigned to a tuple.
type: string type: string
name: name:
description: A name assigned to a tuple.
type: string type: string
required: required:
- key - key
- name - name
TupleList: TupleList:
description: A type that represents a list of key/value tuples.
type: array type: array
items: items:
description: A property that can contains multiple `Tuple` instances.
$ref: '#/components/schemas/Tuple' $ref: '#/components/schemas/Tuple'
TupleWrapper: TupleWrapper:
description: A type that contains either one or multiple `Tuple` instances.
type: object type: object
properties: properties:
amiibo: amiibo:
description: A property that contains one or multiple `Tuple` instances.
oneOf: oneOf:
- $ref: '#/components/schemas/Tuple' - $ref: '#/components/schemas/Tuple'
- $ref: '#/components/schemas/TupleList' - $ref: '#/components/schemas/TupleList'