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

Open API and documentation improvements (#20)

Browse Source 
This PR contains the work done to polish the `Open API` specification document as well as the `DocC` documentation even further, by removing unnecessary intermediate types and adding missing documentation.

Reviewed-on: #20
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #20.
This commit is contained in:
Javier Cicchelli
2025-10-28 15:41:02 +00:00
committed by Javier Cicchelli
parent 4623c13c24
commit 0d9c9e22a4
125 changed files with 181 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/AmiiboService/Public/Models/AmiiboSeries.swift
+5 -5
View File
@@ -14,19 +14,19 @@
/// A model that represents an amiibo series.
public struct AmiiboSeries: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties
/// A key.
/// An amiibo series key.
public let key: String
/// A name.
/// An amiibo series name.
public let name: String
// MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key
self.name = payload.name
Sources/AmiiboService/Public/Models/AmiiboType.swift
+4 -4
View File
@@ -15,18 +15,18 @@
/// A model that represents an amiibo type.
public struct AmiiboType: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties
/// A key.
/// An amiibo type key.
public let key: String
/// A name.
/// An amiibo type name.
public let name: String
// MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key
self.name = payload.name
Sources/AmiiboService/Public/Models/GameCharacter.swift
+5 -5
View File
@@ -15,18 +15,18 @@
/// A model that represents a game character.
public struct GameCharacter: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties
/// A key.
/// A game character key.
public let key: String
/// A name.
/// A game character name.
public let name: String
// MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key
self.name = payload.name
Sources/AmiiboService/Public/Models/GameSeries.swift
+4 -4
View File
@@ -15,18 +15,18 @@
/// A model that represents a game series.
public struct GameSeries: KeyNameModel {
// TODO: Remove the documentation from the properties of this type as the `--enable-inherited-docs` flag when generating DocC documentation is not working as intended (?).
// MARK: Properties
/// A key.
/// A game series key.
public let key: String
/// A name.
/// A game series name.
public let name: String
// MARK: Initializers
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple) {
self.key = payload.key
self.name = payload.name