2a7b9746a7
This PR contains the work done to implement the *User Collection* endpoints of the Discogs API into the `OpenAPI` specification document:
* GET `/users/{username}/collection/folders`
* POST `/users/{username}/collection/folders`
* GET `/users/{username}/collection/folders/{folder_id}`
* POST `/users/{username}/collection/folders/{folder_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}`
* GET `/users/{username}/collection/releases/{release_id}`
* GET `/users/{username}/collection/folders/{folder_id}/releases`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* GET `/users/{username}/collection/fields`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}/fields/{field_id}`
* GET `/users/{username}/collection/value`
Reviewed-on: #12
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
11 KiB
JSON
1 line
11 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"page"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},{"text":".","kind":"text"},{"text":"Page","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Pagea","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page"},{"text":"? = nil, ","kind":"text"},{"text":"perPage","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},{"text":".","kind":"text"},{"text":"PerPage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage"},{"text":"? = nil)","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"page","content":[{"inlineContent":[{"type":"text","text":"A number of page of results to return."}],"type":"paragraph"}]},{"name":"perPage","content":[{"inlineContent":[{"type":"text","text":"A number of items to return per page."}],"type":"paragraph"}]}]}],"metadata":{"title":"init(page:perPage:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO16GetLabelReleasesO5InputV5QueryV4page7perPageAISiSg_ALtcfc","symbolKind":"init","role":"symbol","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"page","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Page","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Pagea"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"perPage"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"PerPage","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea"},{"kind":"text","text":"?)"}]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/query-swift.struct\/init(page:perpage:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct\/init(page:perPage:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Query"},{"type":"text","text":"."}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Input/Query-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/query-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"navigatorTitle":[{"text":"Query","kind":"identifier"}],"kind":"symbol","title":"Operations.GetLabelReleases.Input.Query","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetLabelReleases"}],"navigatorTitle":[{"kind":"identifier","text":"GetLabelReleases"}],"abstract":[{"type":"text","text":"Get information about the releases of a label."}],"kind":"symbol","type":"topic","title":"Operations.GetLabelReleases","url":"\/documentation\/discogsservice\/operations\/getlabelreleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Page":{"url":"\/documentation\/discogsservice\/components\/parameters\/page","navigatorTitle":[{"text":"Page","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page","abstract":[{"text":"A number of page of results to return.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Page"}],"title":"Components.Parameters.Page","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input","title":"Operations.GetLabelReleases.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Input/Query-swift.struct/init(page:perPage:)":{"kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"page"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Pagea","text":"Page"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"perPage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea","text":"PerPage"},{"kind":"text","text":"?)"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/query-swift.struct\/init(page:perpage:)","title":"init(page:perPage:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct\/init(page:perPage:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Query","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"type":"topic","title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/parameters","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/PerPage":{"url":"\/documentation\/discogsservice\/components\/parameters\/perpage","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PerPage","kind":"identifier"}],"navigatorTitle":[{"text":"PerPage","kind":"identifier"}],"kind":"symbol","title":"Components.Parameters.PerPage","abstract":[{"text":"A number of items to return per page.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","type":"topic","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components":{"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"role":"symbol","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"}}} |