bfc9e67d38
This PR contains the work done to implement the `AuthMiddleware` middleware, to authenticate the requests sent to the backend service, based on [their specifications](https://www.discogs.com/developers/#page:authentication). In addition, some documentation has been added/updated and some boilerplate source code has been removed from the project. Reviewed-on: #3 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getMasterVersions(path:query:headers:)"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/apiprotocol\/getmasterversions(path:query:headers:)"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"symbol","roleHeading":"Instance Method","title":"getMasterVersions(path:query:headers:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getMasterVersions"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO","text":"Output"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService11APIProtocolPAAE17getMasterVersions4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","extendedModule":"DiscogsService"},"abstract":[{"type":"text","text":"Get information about the versions of a master release."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMasterVersions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV4PathV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Query-swift.struct","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV7HeadersV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Headers-swift.struct","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"inlineContent":[{"text":"Retrieves a list of all releases that are versions of the specified master release.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"This request supports pagination.","type":"text"}],"type":"paragraph"},{"content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/masters\/{master_id}\/versions","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/masters\/{master_id}\/versions\/get(getMasterVersions)","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside","name":"Remark"}],"kind":"content"}],"references":{"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","title":"DiscogsService","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[],"type":"topic","url":"\/documentation\/discogsservice"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Path-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Path"}],"title":"Operations.getMasterVersions.Input.Path","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct","abstract":[],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Query-swift.struct":{"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct","navigatorTitle":[{"text":"Query","kind":"identifier"}],"title":"Operations.getMasterVersions.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Query-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Headers-swift.struct":{"title":"Operations.getMasterVersions.Input.Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"abstract":[],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/headers-swift.struct","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions":{"role":"symbol","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Get information about the versions of a master release."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","url":"\/documentation\/discogsservice\/operations\/getmasterversions","navigatorTitle":[{"text":"getMasterVersions","kind":"identifier"}],"title":"Operations.getMasterVersions","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMasterVersions","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/APIProtocol":{"abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","kind":"identifier"}],"url":"\/documentation\/discogsservice\/apiprotocol","title":"APIProtocol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol","kind":"symbol","type":"topic","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getMasterVersions(path:query:headers:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/apiprotocol\/getmasterversions(path:query:headers:)","title":"getMasterVersions(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMasterVersions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"getMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV"},{"kind":"text","text":"."},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV4PathV"},{"kind":"text","text":", "},{"text":"query","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"text":"getMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"getMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO","text":"getMasterVersions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getMasterVersionsO6OutputO","text":"Output"}],"abstract":[{"text":"Get information about the versions of a master release.","type":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getMasterVersions(path:query:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Output","abstract":[],"title":"Operations.getMasterVersions.Output","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input":{"title":"Operations.getMasterVersions.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"title":"Operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations"}}} |