Files
discogs-service/docs/data/documentation/discogsservice/components/schemas/searchresult.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
18 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SearchResult","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"anchor":"overview","type":"heading","level":2,"text":"Overview"},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/components\/schemas\/SearchResult"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"topicSections":[{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/init(from:)"],"anchor":"Initializers","title":"Initializers"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/barcode","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/catno","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/community","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/country","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/cover_image","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/format","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/genre","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/label","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/resource_url","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/style","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/thumb","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/title","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/uri","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/year"],"anchor":"Instance-Properties","title":"Instance Properties"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys"],"anchor":"Enumerations","title":"Enumerations"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/Equatable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations"}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To"}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"SearchResult"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SearchResult","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","symbolKind":"struct","externalID":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV","roleHeading":"Structure","title":"Components.Schemas.SearchResult"},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"A type that represents a search result."}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/searchresult"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/cover_image":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cover_image","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/cover_image","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/cover_image","title":"cover_image","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A URL link to a cover image of a result."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/uri":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/uri","abstract":[{"type":"text","text":"A URI representation of a release."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/uri","kind":"symbol","role":"symbol","title":"uri","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"uri","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/genre":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/genre","abstract":[{"text":"A list of music genres associated with a result.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/genre","kind":"symbol","role":"symbol","type":"topic","title":"genre","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"genre","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/label":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/label","type":"topic","title":"label","abstract":[{"text":"A list of labels associated with a result.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/label","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"label","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"role":"symbol"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"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/Components/Schemas/SearchResult/resource_url":{"abstract":[{"type":"text","text":"A URI resource of a result."}],"role":"symbol","type":"topic","title":"resource_url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"resource_url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/resource_url","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/resource_url"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/catno":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/catno","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/catno","kind":"symbol","title":"catno","abstract":[{"type":"text","text":"A category number of a result."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"catno","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/equatable-implementations","role":"collectionGroup","type":"topic","kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/Equatable-Implementations","abstract":[],"title":"Equatable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/format":{"abstract":[{"type":"text","text":"A list of formats associated with a result."}],"role":"symbol","type":"topic","title":"format","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"format"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/format","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/format"},"doc://DiscogsService/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/id":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/id","title":"id","kind":"symbol","role":"symbol","abstract":[{"text":"An identifier of a result.","type":"text"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/year":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/year","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/year","kind":"symbol","title":"year","abstract":[{"type":"text","text":"A number of year of a result."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"year","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/country":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"country","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/country","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/country","abstract":[{"type":"text","text":"A country of a result."}],"title":"country"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/community":{"title":"community","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/community","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/community","abstract":[],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"community","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO9CommunityV","text":"Community","kind":"typeIdentifier"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"title":"Components.Schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/CodingKeys":{"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys","abstract":[],"title":"Components.Schemas.SearchResult.CodingKeys"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/title":{"abstract":[{"type":"text","text":"A title of a result"}],"role":"symbol","type":"topic","title":"title","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/title","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/title"},"doc://DiscogsService/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult","abstract":[{"text":"A type that represents a search result.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","kind":"symbol","role":"symbol","title":"Components.Schemas.SearchResult","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SearchResult"}],"navigatorTitle":[{"kind":"identifier","text":"SearchResult"}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","url":"\/documentation\/discogsservice\/components","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"symbol","title":"Components","navigatorTitle":[{"text":"Components","kind":"identifier"}],"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/barcode":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/barcode","type":"topic","abstract":[{"type":"text","text":"A list of barcode numbers associated with a result."}],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/barcode","role":"symbol","kind":"symbol","title":"barcode","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"barcode"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"]"}]},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/style":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/style","type":"topic","title":"style","abstract":[{"text":"A list of music styles associated with a result.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/style","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"style"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/init(from:)":{"abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/init(from:)","type":"topic","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/init(from:)","role":"symbol","kind":"symbol"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/thumb":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/thumb","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/thumb","kind":"symbol","title":"thumb","abstract":[{"type":"text","text":"A URL link to a thumbnail of a result."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"thumb"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}}}