eaee2b84f0
This PR contains the work done to update the overall documentation of the package. Reviewed-on: #17 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
15 KiB
JSON
1 line
15 KiB
JSON
{"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ArtistId","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"overview","level":2,"text":"Overview","type":"heading"},{"content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/schemas\/ArtistId","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Remark","type":"aside","style":"note"}]}],"metadata":{"symbolKind":"struct","role":"symbol","title":"Components.Schemas.ArtistId","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO8ArtistIdV","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"ArtistId","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"ArtistId"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/init(id:name:resourceUrl:active:anv:join:role:tracks:)"]},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/active","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/anv","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/join","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/name","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/resourceUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/role","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/tracks"],"generated":true},{"anchor":"Enumerations","title":"Enumerations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/CodingKeys"]},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/Equatable-Implementations"],"anchor":"Default-Implementations","generated":true,"title":"Default Implementations"}],"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/artistid"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"abstract":[{"text":"A type that references an artist.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]},"doc://DiscogsService/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/tracks":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/tracks","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/tracks","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracks"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"text":"A list of tracks associated with an artist, if any.","type":"text"}],"kind":"symbol","type":"topic","title":"tracks"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/join":{"title":"join","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/join","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"join","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/join","kind":"symbol","abstract":[{"type":"text","text":"A join relationship descriptor, if any."}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/Equatable-Implementations":{"type":"topic","role":"collectionGroup","kind":"article","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/Equatable-Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/equatable-implementations","title":"Equatable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/resourceUrl":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resourceUrl","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A URI resource of an artist."}],"title":"resourceUrl","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/resourceurl","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/resourceUrl"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/name":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/name","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/name","title":"name","type":"topic","role":"symbol","abstract":[{"text":"A name of an artist.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/active":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/active","kind":"symbol","title":"active","abstract":[{"text":"A flag that indicates whether the relation is currently active or not.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"active"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/active"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/role":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/role","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/role","title":"role","type":"topic","role":"symbol","abstract":[{"text":"A role of an artist.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"role","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/init(id:name:resourceUrl:active:anv:join:role:tracks:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/init(id:name:resourceurl:active:anv:join:role:tracks:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"ArtistId"},{"type":"text","text":"."}],"title":"init(id:name:resourceUrl:active:anv:join:role:tracks:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"name","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"resourceUrl","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"active","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"anv","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"join","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"role","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"tracks","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/init(id:name:resourceUrl:active:anv:join:role:tracks:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId","title":"Components.Schemas.ArtistId","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/artistid","abstract":[{"text":"A type that references an artist.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ArtistId"}],"navigatorTitle":[{"kind":"identifier","text":"ArtistId"}]},"doc://DiscogsService/Se":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/anv":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/anv","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"anv","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/anv","abstract":[{"type":"text","text":"An ANV (Artist Name Variation), if any."}],"type":"topic","title":"anv"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/init(from:)":{"type":"topic","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/init(from:)","title":"init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/init(from:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/CodingKeys":{"abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/codingkeys","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/CodingKeys","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"role":"symbol","title":"Components.Schemas.ArtistId.CodingKeys","type":"topic"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/id":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/id","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/id","title":"id","type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"An identifier of an artist."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}]}}} |