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

{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NotesPayloadPayload","kind":"identifier"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"overview","text":"Overview"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/ReleaseInFolder\/NotesPayload","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"kind":"symbol","metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NotesPayloadPayload","kind":"identifier"}],"role":"symbol","title":"Components.Schemas.ReleaseInFolder.NotesPayloadPayload","symbolKind":"struct","externalID":"s:14DiscogsService10ComponentsO7SchemasO15ReleaseInFolderV012NotesPayloadI0V","roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"kind":"identifier","text":"NotesPayloadPayload"}]},"topicSections":[{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/init(fieldId:value:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/init(from:)"]},{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/fieldId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/value"]},{"generated":true,"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/CodingKeys"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/Equatable-Implementations"]}],"abstract":[{"type":"text","text":"A type that represents a note about a release in a collection folder of a user."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder"]]},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/NotesPayloadPayload/Equatable-Implementations":{"type":"topic","kind":"article","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/Equatable-Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload\/equatable-implementations"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"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/ReleaseInFolder/NotesPayloadPayload/init(from:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"type":"topic","kind":"symbol","role":"symbol","title":"init(from:)","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload\/init(from:)"},"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."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/NotesPayloadPayload/CodingKeys":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.ReleaseInFolder.NotesPayloadPayload.CodingKeys","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/CodingKeys","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload\/codingkeys","type":"topic"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable","type":"unresolvable"},"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/ReleaseInFolder/NotesPayloadPayload/init(fieldId:value:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"fieldId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"value","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"type":"topic","kind":"symbol","role":"symbol","title":"init(fieldId:value:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"NotesPayloadPayload"},{"type":"text","text":"."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/init(fieldId:value:)","url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload\/init(fieldid:value:)"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/NotesPayloadPayload/fieldId":{"abstract":[{"type":"text","text":"An identifier of a custom field."}],"title":"fieldId","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"fieldId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/fieldId","url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload\/fieldid","type":"topic","kind":"symbol"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseInFolder/NotesPayloadPayload":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"NotesPayloadPayload","kind":"identifier"}],"title":"Components.Schemas.ReleaseInFolder.NotesPayloadPayload","abstract":[{"text":"A type that represents a note about a release in a collection folder of a user.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload","role":"symbol","navigatorTitle":[{"text":"NotesPayloadPayload","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload","type":"topic"},"doc://DiscogsService/SE":{"title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE","type":"unresolvable"},"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/ReleaseInFolder/NotesPayloadPayload/value":{"abstract":[{"text":"A value assigned to a custom field.","type":"text"}],"title":"value","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"value"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseInFolder\/NotesPayloadPayload\/value","url":"\/documentation\/discogsservice\/components\/schemas\/releaseinfolder\/notespayloadpayload\/value","type":"topic","kind":"symbol"}}}