rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
ea39b68a4d1c6c5c87df9712fe2b0d180bf083b5
discogs-service/docs/data/documentation/discogsservice/operations/getmaster/input/path-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
8.1 KiB
JSON
Raw Blame History

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct","interfaceLanguage":"swift"},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct\/init(master_id:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct\/master_id"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct\/Equatable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmaster\/input\/path-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"overview","level":2,"text":"Overview"},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/masters\/{master_id}\/GET\/path","type":"codeVoice"},{"type":"text","text":"."}]}]}]}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo"}],"sections":[],"metadata":{"title":"Operations.getMaster.Input.Path","navigatorTitle":[{"kind":"identifier","text":"Path"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO9getMasterO5InputV4PathV","symbolKind":"struct","role":"symbol","roleHeading":"Structure"},"references":{"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getmaster\/input","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input","abstract":[],"title":"Operations.getMaster.Input"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Input/Path-swift.struct/master_id":{"abstract":[{"type":"text","text":"An identifier of a master."}],"role":"symbol","type":"topic","title":"master_id","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"master_id","kind":"identifier"},{"kind":"text","text":": "},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"MasterId","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8MasterIda"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmaster\/input\/path-swift.struct\/master_id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct\/master_id"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Input/Path-swift.struct/Equatable-Implementations":{"title":"Equatable Implementations","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct\/Equatable-Implementations","kind":"article","abstract":[],"role":"collectionGroup","url":"\/documentation\/discogsservice\/operations\/getmaster\/input\/path-swift.struct\/equatable-implementations"},"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/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Input/Path-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Path"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getmaster\/input\/path-swift.struct","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct","abstract":[],"title":"Operations.getMaster.Input.Path"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster/Input/Path-swift.struct/init(master_id:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"master_id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier","text":"Parameters"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8MasterIda","kind":"typeIdentifier","text":"MasterId"},{"kind":"text","text":")"}],"url":"\/documentation\/discogsservice\/operations\/getmaster\/input\/path-swift.struct\/init(master_id:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster\/Input\/Path-swift.struct\/init(master_id:)","title":"init(master_id:)","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Path"},{"type":"text","text":"."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMaster":{"url":"\/documentation\/discogsservice\/operations\/getmaster","abstract":[{"text":"Get information about a master release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMaster","kind":"symbol","role":"symbol","title":"Operations.getMaster","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getMaster"}],"navigatorTitle":[{"kind":"identifier","text":"getMaster"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"}}}
View Git Blame Copy Permalink