discogs-service/docs/data/documentation/discogsservice/components/parameters.json

{"topicSections":[{"generated":true,"anchor":"Type-Aliases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Country","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Currency","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FieldId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FieldValue","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FolderId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Format","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/HomePage","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InstanceId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Label","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/LabelId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Location","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Name","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Notes","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Profile","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Rating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/UserAgent","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username"],"title":"Type Aliases"},{"generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistReleasesSort","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterVersionsSort","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/SortField","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/SortOrder"],"title":"Enumerations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/parameters"]}],"metadata":{"title":"Components.Parameters","navigatorTitle":[{"kind":"identifier","text":"Parameters"}],"role":"symbol","roleHeading":"Enumeration","externalID":"s:14DiscogsService10ComponentsO10ParametersO","symbolKind":"enum","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Parameters"}],"modules":[{"name":"DiscogsService"}]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Parameters"}],"languages":["swift"],"platforms":["macOS"]}]}],"kind":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/parameters","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Page":{"abstract":[{"type":"text","text":"A number of page of results to return."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/page","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page","type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Page"}],"navigatorTitle":[{"kind":"identifier","text":"Page"}],"title":"Components.Parameters.Page","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/parameters"},{"type":"text","text":" section of the OpenAPI document."}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","url":"\/documentation\/discogsservice\/components\/parameters","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Parameters"}],"kind":"symbol","title":"Components.Parameters","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Parameters"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/HomePage":{"abstract":[{"text":"A URI to a website of a user.","type":"text"}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/homepage","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/HomePage","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"HomePage","kind":"identifier"}],"navigatorTitle":[{"text":"HomePage","kind":"identifier"}],"kind":"symbol","title":"Components.Parameters.HomePage"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/MasterVersionsSort":{"abstract":[{"text":"A value to sort the master versions by.","type":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterVersionsSort","url":"\/documentation\/discogsservice\/components\/parameters\/masterversionssort","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"MasterVersionsSort"}],"navigatorTitle":[{"kind":"identifier","text":"MasterVersionsSort"}],"type":"topic","title":"Components.Parameters.MasterVersionsSort"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/SortOrder":{"navigatorTitle":[{"kind":"identifier","text":"SortOrder"}],"url":"\/documentation\/discogsservice\/components\/parameters\/sortorder","abstract":[{"type":"text","text":"The order to sort the results."}],"title":"Components.Parameters.SortOrder","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SortOrder"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/SortOrder","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Location":{"title":"Components.Parameters.Location","navigatorTitle":[{"kind":"identifier","text":"Location"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A geographical location of a user."}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Location"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Location","url":"\/documentation\/discogsservice\/components\/parameters\/location"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Notes":{"role":"symbol","kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/notes","type":"topic","title":"Components.Parameters.Notes","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Notes","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Notes","abstract":[{"text":"A custom note about a release.","type":"text"}],"navigatorTitle":[{"text":"Notes","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Released":{"url":"\/documentation\/discogsservice\/components\/parameters\/released","navigatorTitle":[{"kind":"identifier","text":"Released"}],"abstract":[{"type":"text","text":"A filter by release year."}],"title":"Components.Parameters.Released","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Released"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Country":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Country","kind":"symbol","role":"symbol","abstract":[{"text":"A filter by country.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Country","kind":"identifier"}],"navigatorTitle":[{"text":"Country","kind":"identifier"}],"title":"Components.Parameters.Country","url":"\/documentation\/discogsservice\/components\/parameters\/country"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Format":{"role":"symbol","kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/format","type":"topic","title":"Components.Parameters.Format","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Format","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Format","abstract":[{"text":"A filter by format.","type":"text"}],"navigatorTitle":[{"text":"Format","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","type":"topic","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[],"kind":"symbol","role":"collection"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/FolderId":{"abstract":[{"type":"text","text":"An identifier of a collection folder."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/folderid","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FolderId","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"FolderId","kind":"identifier"}],"navigatorTitle":[{"text":"FolderId","kind":"identifier"}],"kind":"symbol","title":"Components.Parameters.FolderId"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Currency":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Currency","abstract":[{"type":"text","text":"A currency code in the marketplace."}],"kind":"symbol","title":"Components.Parameters.Currency","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Currency","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/currency","navigatorTitle":[{"text":"Currency","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ReleaseId":{"navigatorTitle":[{"text":"ReleaseId","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/releaseid","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseId","kind":"identifier"}],"title":"Components.Parameters.ReleaseId","abstract":[{"text":"An identifier of a release.","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Profile":{"url":"\/documentation\/discogsservice\/components\/parameters\/profile","type":"topic","abstract":[{"type":"text","text":"A biographical information about a user."}],"role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Profile"}],"navigatorTitle":[{"kind":"identifier","text":"Profile"}],"kind":"symbol","title":"Components.Parameters.Profile","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Profile"},"doc://DiscogsService/documentation/DiscogsService/Components":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Components"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Components","kind":"identifier"}],"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components","title":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ArtistId":{"navigatorTitle":[{"text":"ArtistId","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/parameters\/artistid","abstract":[{"text":"An identifier of an artist.","type":"text"}],"title":"Components.Parameters.ArtistId","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ArtistId","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistId","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/UserAgent":{"navigatorTitle":[{"kind":"identifier","text":"UserAgent"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/useragent","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserAgent"}],"title":"Components.Parameters.UserAgent","abstract":[{"text":"A name of a software agent responsible for interacting with the service.","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/UserAgent"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/LabelId":{"abstract":[{"type":"text","text":"An identifier of a label."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/labelid","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/LabelId","type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"LabelId"}],"navigatorTitle":[{"kind":"identifier","text":"LabelId"}],"kind":"symbol","title":"Components.Parameters.LabelId"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/FieldId":{"url":"\/documentation\/discogsservice\/components\/parameters\/fieldid","type":"topic","abstract":[{"text":"An identifier of a custom field.","type":"text"}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"FieldId","kind":"identifier"}],"navigatorTitle":[{"text":"FieldId","kind":"identifier"}],"kind":"symbol","title":"Components.Parameters.FieldId","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FieldId"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/FieldValue":{"title":"Components.Parameters.FieldValue","url":"\/documentation\/discogsservice\/components\/parameters\/fieldvalue","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"FieldValue","kind":"identifier"}],"navigatorTitle":[{"text":"FieldValue","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FieldValue","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A value of a custom field."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Username":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Username"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Username"}],"abstract":[{"type":"text","text":"A username of a user."}],"url":"\/documentation\/discogsservice\/components\/parameters\/username","title":"Components.Parameters.Username","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/PerPage":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","kind":"symbol","role":"symbol","abstract":[{"text":"A number of items to return per page.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PerPage","kind":"identifier"}],"navigatorTitle":[{"text":"PerPage","kind":"identifier"}],"title":"Components.Parameters.PerPage","url":"\/documentation\/discogsservice\/components\/parameters\/perpage"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Rating":{"url":"\/documentation\/discogsservice\/components\/parameters\/rating","navigatorTitle":[{"kind":"identifier","text":"Rating"}],"abstract":[{"text":"A number for a rating of a release.","type":"text"}],"title":"Components.Parameters.Rating","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Rating"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Rating","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ArtistReleasesSort":{"role":"symbol","navigatorTitle":[{"text":"ArtistReleasesSort","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ArtistReleasesSort"}],"abstract":[{"type":"text","text":"A value to sort the releases of an artist by."}],"url":"\/documentation\/discogsservice\/components\/parameters\/artistreleasessort","title":"Components.Parameters.ArtistReleasesSort","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistReleasesSort","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Name":{"abstract":[{"text":"A real name of a user.","type":"text"}],"title":"Components.Parameters.Name","url":"\/documentation\/discogsservice\/components\/parameters\/name","role":"symbol","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Name","kind":"identifier"}],"navigatorTitle":[{"text":"Name","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Name"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/InstanceId":{"title":"Components.Parameters.InstanceId","url":"\/documentation\/discogsservice\/components\/parameters\/instanceid","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"InstanceId","kind":"identifier"}],"navigatorTitle":[{"text":"InstanceId","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InstanceId","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"An identifier of a release instance."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/MasterId":{"type":"topic","title":"Components.Parameters.MasterId","url":"\/documentation\/discogsservice\/components\/parameters\/masterid","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterId","abstract":[{"type":"text","text":"An identifier of a master."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"MasterId"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MasterId","kind":"identifier"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Label":{"navigatorTitle":[{"text":"Label","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A filter by label."}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Label"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Label","title":"Components.Parameters.Label","role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/label"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/SortField":{"url":"\/documentation\/discogsservice\/components\/parameters\/sortfield","title":"Components.Parameters.SortField","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/SortField","abstract":[{"type":"text","text":"A filter by field."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"SortField"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SortField"}],"kind":"symbol"}}}