rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
ea39b68a4d1c6c5c87df9712fe2b0d180bf083b5
discogs-service/docs/data/documentation/discogsservice/operations/getmasterversions/input/init(path:query:headers:).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
13 KiB
JSON
Raw Blame History

{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/input\/init(path:query:headers:)"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/init(path:query:headers:)","interfaceLanguage":"swift"},"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Input","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"title":"init(path:query:headers:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV4path5query7headersA2G4PathV_AG5QueryVAG7HeadersVtcfc","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":")"}],"role":"symbol","roleHeading":"Initializer"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Query-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","text":"Query"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":" = .init())"}]}],"kind":"declarations"},{"parameters":[{"name":"path","content":[{"inlineContent":[{"text":"","type":"text"}],"type":"paragraph"}]},{"name":"query","content":[{"inlineContent":[{"text":"","type":"text"}],"type":"paragraph"}]},{"name":"headers","content":[{"inlineContent":[{"text":"","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/init(path:query:headers:)":{"title":"init(path:query:headers:)","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/init(path:query:headers:)","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/init(path:query:headers:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Input"},{"type":"text","text":"."}],"type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV7HeadersV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Headers-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/headers-swift.struct","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Headers-swift.struct","abstract":[],"title":"Operations.getMasterVersions.Input.Headers"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input":{"navigatorTitle":[{"kind":"identifier","text":"Input"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","abstract":[],"title":"Operations.getMasterVersions.Input"},"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":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Path-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Path"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Path","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct","abstract":[],"title":"Operations.getMasterVersions.Input.Path"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Query-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Query"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Query-swift.struct","abstract":[],"title":"Operations.getMasterVersions.Input.Query"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions":{"navigatorTitle":[{"kind":"identifier","text":"getMasterVersions"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getMasterVersions"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","abstract":[{"type":"text","text":"Get information about the versions of a master release."}],"title":"Operations.getMasterVersions"}}}
View Git Blame Copy Permalink