Open API specification improvements and License update (#17)
This PR contains the work done to: * improve the overall `OpenAPI` specification documentation describing the `Amiibo API` service; * update the `AmiiboFilter` type to include the `head` and `tail` properties; * update the error handling of the errors coming up from the service; * update its license to Apache v2.0; * regenerate the Github Pages documentation. Reviewed-on: #17 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 #17.
This commit is contained in:
@@ -1 +1 @@
|
||||
{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","externalID":"s:13AmiiboService13GameCharacterV3keySSvp","modules":[{"name":"AmiiboService"}],"role":"symbol","title":"key","roleHeading":"Instance Property"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/gamecharacter\/key"]}],"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"A key."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/key"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter"]]},"references":{"doc://AmiiboService/documentation/AmiiboService":{"url":"\/documentation\/amiiboservice","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"inlineContent":[{"type":"text","text":"Amiibo API"}],"type":"strong"},{"type":"text","text":" backend service."}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","title":"AmiiboService","role":"collection"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter/key":{"title":"key","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A key."}],"url":"\/documentation\/amiiboservice\/gamecharacter\/key","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/key"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/gamecharacter","abstract":[{"text":"A model that represents a game character.","type":"text"}],"title":"GameCharacter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","navigatorTitle":[{"text":"GameCharacter","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameCharacter","kind":"identifier"}]}}}
|
||||
{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"AmiiboService"}],"role":"symbol","externalID":"s:13AmiiboService13GameCharacterV3keySSvp","roleHeading":"Instance Property","title":"key","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/key","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A key."}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/gamecharacter\/key"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/GameCharacter/key":{"role":"symbol","abstract":[{"type":"text","text":"A key."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","title":"key","url":"\/documentation\/amiiboservice\/gamecharacter\/key","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/key","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","navigatorTitle":[{"text":"GameCharacter","kind":"identifier"}],"abstract":[{"type":"text","text":"A model that represents a game character."}],"role":"symbol","title":"GameCharacter","url":"\/documentation\/amiiboservice\/gamecharacter","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"GameCharacter","kind":"identifier"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService":{"abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"inlineContent":[{"type":"text","text":"Amiibo API"}],"type":"strong"},{"text":" backend service.","type":"text"}],"type":"topic","kind":"symbol","role":"collection","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","title":"AmiiboService","url":"\/documentation\/amiiboservice"}}}
|
||||
@@ -1 +1 @@
|
||||
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/gamecharacter\/name"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"externalID":"s:13AmiiboService13GameCharacterV4nameSSvp","symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"AmiiboService"}],"title":"name","role":"symbol"},"abstract":[{"type":"text","text":"A name."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/name"},"references":{"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/gamecharacter","abstract":[{"text":"A model that represents a game character.","type":"text"}],"title":"GameCharacter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","navigatorTitle":[{"text":"GameCharacter","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameCharacter","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService":{"url":"\/documentation\/amiiboservice","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"inlineContent":[{"type":"text","text":"Amiibo API"}],"type":"strong"},{"type":"text","text":" backend service."}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","title":"AmiiboService","role":"collection"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter/name":{"title":"name","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A name."}],"url":"\/documentation\/amiiboservice\/gamecharacter\/name","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/name"}}}
|
||||
{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"metadata":{"roleHeading":"Instance Property","role":"symbol","title":"name","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService13GameCharacterV4nameSSvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/name"},"abstract":[{"text":"A name.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter"]]},"variants":[{"paths":["\/documentation\/amiiboservice\/gamecharacter\/name"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://AmiiboService/documentation/AmiiboService/GameCharacter/name":{"role":"symbol","abstract":[{"text":"A name.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"name","kind":"symbol","url":"\/documentation\/amiiboservice\/gamecharacter\/name","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter\/name","type":"topic"},"doc://AmiiboService/documentation/AmiiboService":{"abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"inlineContent":[{"type":"text","text":"Amiibo API"}],"type":"strong"},{"text":" backend service.","type":"text"}],"type":"topic","kind":"symbol","role":"collection","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","title":"AmiiboService","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","navigatorTitle":[{"text":"GameCharacter","kind":"identifier"}],"abstract":[{"type":"text","text":"A model that represents a game character."}],"role":"symbol","title":"GameCharacter","url":"\/documentation\/amiiboservice\/gamecharacter","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"GameCharacter","kind":"identifier"}],"kind":"symbol"}}}
|
||||
Reference in New Issue
Block a user