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
9.9 KiB
JSON
1 line
9.9 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getService(headers:)","interfaceLanguage":"swift"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/apiprotocol\/getservice(headers:)"]}],"abstract":[{"text":"Get information about the service.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getService","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService","text":"getService","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService\/Input","text":"Input","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O5InputV7HeadersV","text":"Headers"},{"text":" = .init()) ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O","text":"getService"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O6OutputO","text":"Output"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"Retrieves any available information related to the service."}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/"},{"text":".","type":"text"}]}],"style":"note","type":"aside","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/\/get(getService)"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Remark"}]}],"metadata":{"role":"symbol","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService11APIProtocolPAAE03getB07headersAA10OperationsOADO6OutputOAH5InputV7HeadersV_tYaKF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getService","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getService","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"getService","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O6OutputO"}],"title":"getService(headers:)","extendedModule":"DiscogsService"},"kind":"symbol","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/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/Operations/getService":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getService","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"getService","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getservice","abstract":[{"type":"text","text":"Get information about the service."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService","title":"Operations.getService","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getService/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getservice\/input","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService\/Input","title":"Operations.getService.Input","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getService(headers:)":{"abstract":[{"type":"text","text":"Get information about the service."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getService","kind":"identifier"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"text":"getService","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O5InputV"},{"kind":"text","text":"."},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O5InputV7HeadersV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O","kind":"typeIdentifier","text":"getService"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO03getB0O6OutputO","kind":"typeIdentifier","text":"Output"}],"url":"\/documentation\/discogsservice\/apiprotocol\/getservice(headers:)","title":"getService(headers:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getService(headers:)","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/getService/Input/Headers-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getservice\/input\/headers-swift.struct","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService\/Input\/Headers-swift.struct","title":"Operations.getService.Input.Headers","type":"topic","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"},"doc://DiscogsService/documentation/DiscogsService/Operations/getService/Output":{"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getservice\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getService.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getService\/Output"}}} |