rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/components/schemas/artistid.json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 15:20:20 +00:00

1 line
15 KiB
JSON
Raw Blame History

{"sections":[],"topicSections":[{"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:)"],"title":"Initializers","generated":true},{"anchor":"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"],"title":"Instance Properties","generated":true},{"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/CodingKeys"],"title":"Enumerations","generated":true},{"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/Equatable-Implementations"],"title":"Default Implementations","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ArtistId"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/ArtistId"},{"type":"text","text":"."}]}],"name":"Remark"}],"kind":"content"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"A type that references an artist."}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships"}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ArtistId"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO8ArtistIdV","modules":[{"name":"DiscogsService"}],"title":"Components.Schemas.ArtistId","navigatorTitle":[{"text":"ArtistId","kind":"identifier"}],"symbolKind":"struct","roleHeading":"Structure"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/artistid"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/init(from:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/init(from:)","abstract":[],"kind":"symbol","type":"topic"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"type":"topic","title":"Components.Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/codingkeys","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.ArtistId.CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/CodingKeys","abstract":[],"kind":"symbol","type":"topic"},"doc://DiscogsService/Se":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/active":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"active","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"active","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/active","abstract":[{"type":"text","text":"A flag that indicates whether the relation is currently active or not."}],"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/active"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/tracks":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/tracks","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracks"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"tracks","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/tracks","abstract":[{"type":"text","text":"TBD"}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/id":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"title":"id","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/id","abstract":[{"text":"An identifier of an artist.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/id"},"doc://DiscogsService/SE":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/resourceUrl":{"type":"topic","title":"resourceUrl","abstract":[{"text":"A URI resource of an artist.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/resourceUrl","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/resourceurl","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"resourceUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ArtistId","kind":"identifier"}],"title":"Components.Schemas.ArtistId","navigatorTitle":[{"text":"ArtistId","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId","abstract":[{"text":"A type that references an artist.","type":"text"}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/name":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/name","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"name","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/name","abstract":[{"type":"text","text":"A name of an artist."}],"kind":"symbol","type":"topic"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"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:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"resourceUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"active"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"anv"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"join"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"role"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"tracks"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"title":"init(id:name:resourceUrl:active:anv:join:role:tracks:)","identifier":"doc:\/\/DiscogsService\/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":"."}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/equatable-implementations","role":"collectionGroup","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/Equatable-Implementations","abstract":[],"kind":"article","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/join":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/join","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"join"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"join","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/join","abstract":[{"type":"text","text":"TBD"}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/anv":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"anv","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"anv","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/anv","abstract":[{"text":"TBD","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/anv"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistId/role":{"type":"topic","title":"role","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistId\/role","abstract":[{"type":"text","text":"A role of an artist."}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistid\/role","role":"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"}]}}}
View Git Blame Copy Permalink