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

Documented the AmiiboFilter, AmiiboSeriesFilter, AmiiboTypeFilter, GameCharacterFilter, and the GameSeriesFilter types in the library target.

Browse Source
This commit is contained in:
Javier Cicchelli
2025-09-09 09:49:43 +02:00
parent 36fd2c29ea
commit f7ae2f65f2
5 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/Public/Filters/AmiiboFilter.swift
+27 -1
View File
@@ -10,21 +10,47 @@
// //
//===----------------------------------------------------------------------=== //===----------------------------------------------------------------------===
/// A type that contains values to fine-tune a response when requesting amiibo items.
public struct AmiiboFilter { public struct AmiiboFilter {
// MARK: Properties // MARK: Properties
/// A game character to return, if any.
public let gameCharacter: String? public let gameCharacter: String?
/// A game series to return, if any.
public let gameSeries: String? public let gameSeries: String?
/// An amiibo identifier to return, if any.
public let identifier: String? public let identifier: String?
/// An amiibo name to return, if any.
public let name: String? public let name: String?
/// An amiibo series to return, if any.
public let series: String? public let series: String?
/// A flag indicating whether to include games in the response, if any.
public let showGames: Bool? public let showGames: Bool?
/// A flag indicating whether to include amiibo usages in games in the response, if any.
public let showUsage: Bool? public let showUsage: Bool?
/// An amiibo type to return, if any.
public let type: String? public let type: String?
// MARK: Initialisers // MARK: Initializers
/// Initializes this filter.
/// - Parameters:
/// - identifier: An amiibo identifier to return, if any.
/// - name: An amiibo name to return, if any.
/// - type: An amiibo type to return, if any.
/// - series: An amiibo series to return, if any.
/// - gameCharacter: A game character to return, if any.
/// - gameSeries: A game series to return, if any.
/// - showGames: A flag indicating whether to include games in the response, if any.
/// - showUsage: A flag indicating whether to include amiibo usages in games in the response, if any.
public init( public init(
identifier: String? = nil, identifier: String? = nil,
name: String? = nil, name: String? = nil,
Sources/Public/Filters/AmiiboSeriesFilter.swift
+2 -1
View File
@@ -10,6 +10,7 @@
// //
//===----------------------------------------------------------------------=== //===----------------------------------------------------------------------===
/// A type that contains values to fine-tune a response when requesting amiibo series.
public struct AmiiboSeriesFilter: KeyNameFilter { public struct AmiiboSeriesFilter: KeyNameFilter {
// MARK: Properties // MARK: Properties
@@ -17,7 +18,7 @@ public struct AmiiboSeriesFilter: KeyNameFilter {
public let key: String? public let key: String?
public let name: String? public let name: String?
// MARK: Initialisers // MARK: Initializers
public init() { public init() {
self.key = nil self.key = nil
Sources/Public/Filters/AmiiboTypeFilter.swift
+2 -1
View File
@@ -10,6 +10,7 @@
// //
//===----------------------------------------------------------------------=== //===----------------------------------------------------------------------===
/// A type that contains values to fine-tune a response when requesting amiibo types.
public struct AmiiboTypeFilter: KeyNameFilter { public struct AmiiboTypeFilter: KeyNameFilter {
// MARK: Properties // MARK: Properties
@@ -17,7 +18,7 @@ public struct AmiiboTypeFilter: KeyNameFilter {
public let key: String? public let key: String?
public let name: String? public let name: String?
// MARK: Initialisers // MARK: Initializers
public init() { public init() {
self.key = nil self.key = nil
Sources/Public/Filters/GameCharacterFilter.swift
+2 -1
View File
@@ -10,6 +10,7 @@
// //
//===----------------------------------------------------------------------=== //===----------------------------------------------------------------------===
/// A type that contains values to fine-tune a response when requesting game characters.
public struct GameCharacterFilter: KeyNameFilter { public struct GameCharacterFilter: KeyNameFilter {
// MARK: Properties // MARK: Properties
@@ -17,7 +18,7 @@ public struct GameCharacterFilter: KeyNameFilter {
public let key: String? public let key: String?
public let name: String? public let name: String?
// MARK: Initialisers // MARK: Initializers
public init() { public init() {
self.key = nil self.key = nil
Sources/Public/Filters/GameSeriesFilter.swift
+2 -1
View File
@@ -10,6 +10,7 @@
// //
//===----------------------------------------------------------------------=== //===----------------------------------------------------------------------===
/// A type that contains values to fine-tune a response when requesting game series.
public struct GameSeriesFilter: KeyNameFilter { public struct GameSeriesFilter: KeyNameFilter {
// MARK: Properties // MARK: Properties
@@ -17,7 +18,7 @@ public struct GameSeriesFilter: KeyNameFilter {
public let key: String? public let key: String?
public let name: String? public let name: String?
// MARK: Initialisers // MARK: Initializers
public init() { public init() {
self.key = nil self.key = nil