Replaced the Tuple schema for the OpenAPI specification document in the library target with per-type key-name payloads.

This commit is contained in:
2026-07-26 02:06:40 +02:00
parent c1c6f147f6
commit 64117bea5c
8 changed files with 102 additions and 67 deletions
+52 -50
View File
@@ -439,24 +439,34 @@ components:
format: date-time
AmiiboSeries:
description: A type that represents an amiibo series.
allOf:
- $ref: '#/components/schemas/Tuple'
- type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this amiibo series.
name:
description: The name of this amiibo series.
type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this amiibo series.
type: string
pattern: "^0x[0-9a-fA-F]+$"
minLength: 3
name:
description: The name of this amiibo series.
type: string
required:
- key
- name
AmiiboType:
description: A type that represents an amiibo type (e.g., Figure, Card, Yarn, Band).
allOf:
- $ref: '#/components/schemas/Tuple'
- type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this amiibo type.
name:
description: The name of this amiibo type.
type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this amiibo type.
type: string
pattern: "^0x[0-9a-fA-F]+$"
minLength: 3
name:
description: The name of this amiibo type.
type: string
required:
- key
- name
AmiiboUsage:
description: A type that represents how an amiibo is used within a game.
type: object
@@ -472,24 +482,34 @@ components:
- write
GameCharacter:
description: A type that represents a game character.
allOf:
- $ref: '#/components/schemas/Tuple'
- type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this game character.
name:
description: The name of this game character.
type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this game character.
type: string
pattern: "^0x[0-9a-fA-F]+$"
minLength: 3
name:
description: The name of this game character.
type: string
required:
- key
- name
GameSeries:
description: A type that represents a game series.
allOf:
- $ref: '#/components/schemas/Tuple'
- type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this game series.
name:
description: The name of this game series.
type: object
properties:
key:
description: The hexadecimal key that uniquely identifies this game series.
type: string
pattern: "^0x[0-9a-fA-F]+$"
minLength: 3
name:
description: The name of this game series.
type: string
required:
- key
- name
LastUpdated:
description: A type that contains the date and time when the service data was last updated.
type: object
@@ -500,24 +520,6 @@ components:
format: date-time
required:
- lastUpdated
Tuple:
description: |
A base type composed of a `key` and `name` pair.
This type is the base schema for the `AmiiboSeries`, `AmiiboType`, `GameCharacter`, and `GameSeries` types.
type: object
properties:
key:
description: A hexadecimal key that uniquely identifies this resource.
type: string
pattern: "^0x[0-9a-fA-F]+$"
minLength: 3
name:
description: A display name for this resource.
type: string
required:
- key
- name
# Wrapper Entities
AmiiboWrapper:
description: A response wrapper that contains zero, one, or more amiibos.