rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
2a7b9746a774ba216578062531d65ae32a4f53b6
discogs-service/docs/data/documentation/discogsservice/components/schemas/pagination.json
T
javier 2a7b9746a7 Implemented the User Collection endpoints (#12) 
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>
2025-10-16 14:38:41 +00:00

1 line
14 KiB
JSON
Raw Blame History

{"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/pagination"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"A type that provides details about a paginated result.","type":"text"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Pagination"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/components\/schemas\/Pagination"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/UrlsPayload"],"generated":true,"anchor":"Structures","title":"Structures"},{"title":"Initializers","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(page:pages:perPage:items:urls:)"],"anchor":"Initializers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/items","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/page","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/pages","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/perPage","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urls"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys"],"generated":true,"anchor":"Enumerations","title":"Enumerations"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"metadata":{"roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Pagination","kind":"identifier"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV","title":"Components.Schemas.Pagination","navigatorTitle":[{"kind":"identifier","text":"Pagination"}],"role":"symbol"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/perPage":{"type":"topic","title":"perPage","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/perpage","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/perPage","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"perPage"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A total number of items per page in a result.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Pagination","kind":"identifier"}],"navigatorTitle":[{"text":"Pagination","kind":"identifier"}],"abstract":[{"type":"text","text":"A type that provides details about a paginated result."}],"kind":"symbol","type":"topic","title":"Components.Schemas.Pagination","url":"\/documentation\/discogsservice\/components\/schemas\/pagination","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/pages":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/pages","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pages","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/pages","role":"symbol","title":"pages","type":"topic","abstract":[{"type":"text","text":"A total number of pages in a result."}]},"doc://DiscogsService/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/page":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"A number for the current page in a result."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/page","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/page","title":"page","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"page","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/items":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/items","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"items","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/items","role":"symbol","title":"items","type":"topic","abstract":[{"type":"text","text":"A total number of items in a result."}]},"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/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/init(page:pages:perPage:items:urls:)":{"type":"topic","title":"init(page:pages:perPage:items:urls:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(page:pages:perPage:items:urls:)","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/init(page:pages:perpage:items:urls:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"page"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"pages"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"perPage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"items"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"urls"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Pagination","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"UrlsPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV11UrlsPayloadV"},{"kind":"text","text":")"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Pagination","type":"codeVoice"},{"text":".","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/Equatable-Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/equatable-implementations","role":"collectionGroup","title":"Equatable Implementations","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/CodingKeys":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Components.Schemas.Pagination.CodingKeys","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/codingkeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys","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/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urls":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urls","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"urls","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"Pagination","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV11UrlsPayloadV","text":"UrlsPayload","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urls","role":"symbol","title":"urls","type":"topic","abstract":[{"type":"text","text":"A collection of URLs to navigate through the pages in a result."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"title":"Components.Schemas","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/init(from:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(from:)","abstract":[],"title":"init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/UrlsPayload":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UrlsPayload"}],"navigatorTitle":[{"kind":"identifier","text":"UrlsPayload"}],"abstract":[{"type":"text","text":"A collection of URLs to navigate through the pages in a result."}],"kind":"symbol","type":"topic","title":"Components.Schemas.Pagination.UrlsPayload","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/UrlsPayload","role":"symbol"}}}
View Git Blame Copy Permalink