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/releaseinfolder/init(id:folderid:instanceid:dateadded:rating:basicinformation:notes:).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

{"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"folderId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"instanceId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"dateAdded","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"basicInformation","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV","text":"Release","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release"},{"text":", ","kind":"text"},{"text":"notes","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV","text":"ReleaseInFolder","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV12NotesPayloada","text":"NotesPayload","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayload"},{"text":"? = nil)","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"An identifier of an appearance of a release in a collection folder.","type":"text"}],"type":"paragraph"}],"name":"id"},{"content":[{"inlineContent":[{"text":"An identifier of a collection folder that contains a specified release.","type":"text"}],"type":"paragraph"}],"name":"folderId"},{"content":[{"type":"paragraph","inlineContent":[{"text":"An identifier of a release instance.","type":"text"}]}],"name":"instanceId"},{"content":[{"inlineContent":[{"type":"text","text":"A date and time in which a release was added into the collection folder of a user."}],"type":"paragraph"}],"name":"dateAdded"},{"content":[{"inlineContent":[{"type":"text","text":"A rating given to a release by a user that added it into a collection folder."}],"type":"paragraph"}],"name":"rating"},{"content":[{"inlineContent":[{"text":"The available information about a release that was added into a collection folder of a user.","type":"text"}],"type":"paragraph"}],"name":"basicInformation"},{"content":[{"inlineContent":[{"text":"A list of additional notes related to a release in a collection folder of a user.","type":"text"}],"type":"paragraph"}],"name":"notes"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder"]]},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/init(id:folderid:instanceid:dateadded:rating:basicinformation:notes:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"ReleaseInFolder"},{"type":"text","text":"."}],"metadata":{"modules":[{"name":"DiscogsService"}],"symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"folderId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"instanceId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"dateAdded"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"basicInformation"},{"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":"Release","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"notes"},{"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":"ReleaseInFolder","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotesPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV12NotesPayloada"},{"kind":"text","text":"?)"}],"role":"symbol","externalID":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV2id8folderId08instanceJ09dateAdded6rating16basicInformation5notesAGSi_SiSgSi10Foundation4DateVSiAE0E0VSayAG012NotesPayloadU0VGSgtcfc","title":"init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)","roleHeading":"Initializer"},"references":{"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":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"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/Release":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"A type that eepresents a particular physical or digital object released by one or more artists."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release","url":"\/documentation\/discogsservice\/components\/schemas\/release","title":"Components.Schemas.Release","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Release"}],"navigatorTitle":[{"kind":"identifier","text":"Release"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/init(id:folderid:instanceid:dateadded:rating:basicinformation:notes:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"ReleaseInFolder"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","title":"init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/init(id:folderId:instanceId:dateAdded:rating:basicInformation:notes:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"folderId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"instanceId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"dateAdded"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"basicInformation"},{"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":"Release","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"notes"},{"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":"ReleaseInFolder","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotesPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV12NotesPayloada"},{"kind":"text","text":"?)"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/NotesPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayload","navigatorTitle":[{"kind":"identifier","text":"NotesPayload"}],"abstract":[{"type":"text","text":"A list of additional notes related to a release in a collection folder of a user."}],"kind":"symbol","type":"topic","title":"Components.Schemas.ReleaseInFolder.NotesPayload","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayload","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotesPayload"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseInFolder","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder","role":"symbol","navigatorTitle":[{"text":"ReleaseInFolder","kind":"identifier"}],"title":"Components.Schemas.ReleaseInFolder","type":"topic","abstract":[{"type":"text","text":"A type that represents an appearance of a release in a collection folder of a user."}]}}}
View Git Blame Copy Permalink