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

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