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
8.1 KiB
JSON
1 line
8.1 KiB
JSON
{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output"]]},"abstract":[{"type":"text","text":"Successfully retrieved release rating details by a given user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok(_:)"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getReleaseStats","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"style":"warning","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"There is a discrepancy about this response between was is documented and what the endpoints actually responds. In the "},{"type":"reference","identifier":"https:\/\/www.discogs.com\/developers#page:database,header:database-release-stats","isActive":true},{"type":"text","text":", it is defined that a type containing a statistical data would be returned but the actual response returns an object that contains a boolean flag instead."}]}],"type":"aside"},{"style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/releases\/{release_id}\/stats\/get(getReleaseStats)\/responses\/200","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside"},{"inlineContent":[{"text":"HTTP response code: ","type":"text"},{"code":"200 ok","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/ok(_:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"role":"symbol","symbolKind":"case","title":"Operations.getReleaseStats.Output.ok(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"getReleaseStats","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV"},{"text":")","kind":"text"}],"externalID":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2okyA2G2OkVcAGmF","roleHeading":"Case","modules":[{"name":"DiscogsService"}]},"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":{"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/getReleaseStats/Output":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"title":"Operations.getReleaseStats.Output","kind":"symbol"},"https://www.discogs.com/developers#page:database,header:database-release-stats":{"url":"https:\/\/www.discogs.com\/developers#page:database,header:database-release-stats","type":"link","identifier":"https:\/\/www.discogs.com\/developers#page:database,header:database-release-stats","titleInlineContent":[{"text":"documentation","type":"text"}],"title":"documentation"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"getReleaseStats"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleasestats","abstract":[{"type":"text","text":"Get information about statistics of release."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getReleaseStats"}],"title":"Operations.getReleaseStats","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/Ok-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/Ok-swift.struct","abstract":[],"title":"Operations.getReleaseStats.Output.Ok","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseStats/Output/ok(_:)":{"role":"symbol","kind":"symbol","abstract":[{"text":"Successfully retrieved release rating details by a given user.","type":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseStats\/Output\/ok(_:)","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok(_:)","title":"Operations.getReleaseStats.Output.ok(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO","text":"getReleaseStats"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO","text":"Output"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15getReleaseStatsO6OutputO2OkV","text":"Ok"},{"kind":"text","text":")"}]}}} |