rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
67c9ffa6f4a0d32e64433c5708d320fccd64efe5
discogs-service/docs/data/documentation/discogsservice/components/schemas/pagination/init(page:pages:perpage:items:urls:).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
9.6 KiB
JSON
Raw Blame History

{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"kind":"externalParam","text":"page"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"pages","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":", ","kind":"text"},{"text":"perPage","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"items","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"urls","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","text":"Pagination"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV11UrlsPayloadV","text":"UrlsPayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/UrlsPayload","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"page","content":[{"type":"paragraph","inlineContent":[{"text":"A number for the current page in a result.","type":"text"}]}]},{"name":"pages","content":[{"inlineContent":[{"text":"A total number of pages in a result.","type":"text"}],"type":"paragraph"}]},{"name":"perPage","content":[{"inlineContent":[{"text":"A total number of items per page in a result.","type":"text"}],"type":"paragraph"}]},{"name":"items","content":[{"inlineContent":[{"text":"A total number of items in a result.","type":"text"}],"type":"paragraph"}]},{"name":"urls","content":[{"inlineContent":[{"text":"A collection of URLs to navigate through the pages in a result.","type":"text"}],"type":"paragraph"}]}]}],"metadata":{"roleHeading":"Initializer","modules":[{"name":"DiscogsService"}],"symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"page","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"pages","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"perPage","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"items","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"urls"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV","text":"Pagination","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV11UrlsPayloadV","text":"UrlsPayload","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV4page5pages7perPage5items4urlsAGSi_S3iAG11UrlsPayloadVtcfc","title":"init(page:pages:perPage:items:urls:)","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/pagination\/init(page:pages:perpage:items:urls:)"]}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(page:pages:perPage:items:urls:)"},"sections":[],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Pagination","type":"codeVoice"},{"text":".","type":"text"}],"references":{"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/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/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"},"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":{"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/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"}]}}}
View Git Blame Copy Permalink