Files
discogs-service/docs/data/documentation/discogsservice/operations/getcollectionitemsbyfolder/input/query-swift.struct.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
12 KiB
JSON

{"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"title":"Operations.GetCollectionItemsByFolder.Input.Query","roleHeading":"Structure","symbolKind":"struct","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV5QueryV"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input"]]},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/init(sort:sortOrder:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/sort","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/sortOrder-swift.property"],"anchor":"Instance-Properties","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/SortField","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/SortOrder-swift.enum"],"title":"Enumerations","generated":true,"anchor":"Enumerations"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/Equatable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Query","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]},{"content":[{"type":"heading","anchor":"overview","level":2,"text":"Overview"},{"type":"aside","style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/GET\/query"},{"type":"text","text":"."}]}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct/Equatable-Implementations":{"abstract":[],"kind":"article","type":"topic","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/Equatable-Implementations","role":"collectionGroup"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder","navigatorTitle":[{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","abstract":[{"text":"Get collection items of a user inside a specified folder.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCollectionItemsByFolder"}],"type":"topic","title":"Operations.GetCollectionItemsByFolder"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct/sortOrder-swift.property":{"abstract":[{"text":"The order to sort the results.","type":"text"}],"title":"sortOrder","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sortOrder","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"SortOrder","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9SortOrderO"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct\/sortorder-swift.property","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/sortOrder-swift.property","type":"topic","kind":"symbol"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct/SortOrder-swift.enum":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SortOrder"}],"navigatorTitle":[{"kind":"identifier","text":"SortOrder"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionItemsByFolder.Input.Query.SortOrder","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct\/sortorder-swift.enum","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/SortOrder-swift.enum","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"navigatorTitle":[{"kind":"identifier","text":"Query"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionItemsByFolder.Input.Query","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct/sort":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct\/sort","abstract":[{"type":"text","text":"A filter by field."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/sort","title":"sort","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"sort"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"SortField","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9SortFieldO","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct/init(sort:sortOrder:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct\/init(sort:sortorder:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/init(sort:sortOrder:)","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Query"},{"text":".","type":"text"}],"title":"init(sort:sortOrder:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"sort","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9SortFieldO","text":"SortField","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"sortOrder","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"text":"SortOrder","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9SortOrderO","kind":"typeIdentifier"},{"kind":"text","text":"?)"}]},"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/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct/SortField":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SortField","kind":"identifier"}],"navigatorTitle":[{"text":"SortField","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct\/SortField","kind":"symbol","title":"Operations.GetCollectionItemsByFolder.Input.Query.SortField","abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct\/sortfield","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionItemsByFolder.Input","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","role":"symbol"}}}