rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
e6d05cb9cc88e10a82f72b10e11d103ecf35c36e
discogs-service/docs/data/documentation/discogsservice/operations/getartist/output/ok-swift.struct.json
T
javier 428eedd89d Implemented the Services and Database GET endpoints (#2) 
This PR contains the work done to include the define the information sections of the `OpenAPI` specification document and all the `GET` endpoints of the _Service_ and _Database_ categories.

The following endpoints have been defined in the document, and also tested manually with `Swift`:
* GET `/`
* GET `/artists/{artist_id}`
* GET `/artists/{artist_id}/releases`
* GET `/labels/{label_id}`
* GET `/labels/{label_id}/releases`
* GET `/masters/{master_id}`
* GET `/masters/{master_id}/versions`
* GET `/releases/{release_id}`
* GET `/releases/{release_id}/rating`
* GET `/releases/{release_id}/rating/{username}`
* GET `/releases/{release_id}/stats`
* GET `/database/search`

In addition, a first version of the _Github Pages_ documentation has been generated from the `DocC` documentation catalog, and the generated Swift code from the `openapi.yaml` file.

Reviewed-on: #2
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-09 23:51:39 +00:00

1 line
9.1 KiB
JSON
Raw Blame History

{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"languages":["swift"]}]}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/init(body:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/body-swift.property"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/Body-swift.enum"],"anchor":"Enumerations","title":"Enumerations","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/Equatable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","title":"Operations.getArtist.Output.Ok","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"externalID":"s:14DiscogsService10OperationsO9getArtistO6OutputO2OkV","symbolKind":"struct","modules":[{"name":"DiscogsService"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output"]]},"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Output/Ok-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Ok"}],"abstract":[],"role":"symbol","type":"topic","title":"Operations.getArtist.Output.Ok","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist":{"navigatorTitle":[{"kind":"identifier","text":"getArtist"}],"abstract":[{"type":"text","text":"Get information about an artist."}],"role":"symbol","type":"topic","title":"Operations.getArtist","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getArtist"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"url":"\/documentation\/discogsservice\/operations\/getartist\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output","title":"Operations.getArtist.Output","kind":"symbol","role":"symbol","type":"topic","abstract":[]},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Output/Ok-swift.struct/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","type":"topic","title":"Equatable Implementations","kind":"article","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/Equatable-Implementations"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Output/Ok-swift.struct/Body-swift.enum":{"navigatorTitle":[{"kind":"identifier","text":"Body"}],"abstract":[],"role":"symbol","type":"topic","title":"Operations.getArtist.Output.Ok.Body","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/body-swift.enum","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/Body-swift.enum"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Output/Ok-swift.struct/init(body:)":{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"role":"symbol","type":"topic","title":"init(body:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"body"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO6OutputO2OkV4BodyO","text":"Body"},{"kind":"text","text":")"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/init(body:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/init(body:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Output/Ok-swift.struct/body-swift.property":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"body","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO6OutputO2OkV4BodyO","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/body-swift.property","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Output\/Ok-swift.struct\/body-swift.property","abstract":[{"type":"text","text":"Received HTTP response body"}],"title":"body"}}}
View Git Blame Copy Permalink