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/customfield.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
Raw Blame History

{"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CustomField","kind":"identifier"}],"roleHeading":"Structure","role":"symbol","title":"Components.Schemas.CustomField","symbolKind":"struct","navigatorTitle":[{"text":"CustomField","kind":"identifier"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO11CustomFieldV","modules":[{"name":"DiscogsService"}]},"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/init(from:)"],"title":"Initializers"},{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/lines","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/name","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/options","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/position"],"title":"Instance Properties"},{"generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/CodingKeys"],"title":"Enumerations"},{"generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/Equatable-Implementations"],"title":"Default Implementations"}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CustomField","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Overview","level":2,"anchor":"overview","type":"heading"},{"style":"note","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/schemas\/CustomField","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Remark"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/customfield"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField"},"kind":"symbol","abstract":[{"text":"A type that represents a custom field.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/CustomField/name":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"name"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"text":"A name of a custom field.","type":"text"}],"kind":"symbol","type":"topic","title":"name","url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/name","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/name","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/CustomField":{"url":"\/documentation\/discogsservice\/components\/schemas\/customfield","navigatorTitle":[{"kind":"identifier","text":"CustomField"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField","abstract":[{"type":"text","text":"A type that represents a custom field."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CustomField"}],"title":"Components.Schemas.CustomField","type":"topic"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/CustomField/Equatable-Implementations":{"abstract":[],"kind":"article","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/equatable-implementations","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/Equatable-Implementations","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/CustomField/position":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"position","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"abstract":[{"text":"A position of a custom field.","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/position","title":"position","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/position","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/CustomField/init(from:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/init(from:)","title":"init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/init(from:)","role":"symbol"},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","type":"unresolvable","title":"Swift.Encodable"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"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/CustomField/lines":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"lines","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"text":"A number of lines of content to allow for a custom field of a textarea type.","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/lines","title":"lines","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/lines","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/CustomField/options":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"options","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"abstract":[{"text":"A list of options to display, in case the field is of dropdown type.","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/options","title":"options","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/options","role":"symbol"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable","title":"Swift.Hashable"},"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/CustomField/id":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"abstract":[{"text":"An identifier of a custom field.","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/id","title":"id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/id","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/CustomField/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/customfield\/codingkeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"kind":"symbol","title":"Components.Schemas.CustomField.CodingKeys","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/CustomField\/CodingKeys","abstract":[],"role":"symbol"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"}}}
View Git Blame Copy Permalink