39e9dc5d53
This PR contains the rock done to securize the /GET `/oauth/identity` endpoints on the OpenAPI specification document, plus it also improves the endpoints ordering in the *Database* section. Reviewed-on: #10 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
12 KiB
JSON
1 line
12 KiB
JSON
{"seeAlsoSections":[{"anchor":"Service-endpoints","title":"Service endpoints","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getService(_:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getService"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetService","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O5InputV7HeadersV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Input\/Headers-swift.struct"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetService","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"inlineContent":[{"text":"Retrieves any available information related to the service.","type":"text"}],"type":"paragraph"},{"name":"Remark","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"Remark","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/\/get(getService)","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getService(headers:)"},"variants":[{"paths":["\/documentation\/discogsservice\/apiprotocol\/getservice(headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"metadata":{"modules":[{"name":"DiscogsService"}],"symbolKind":"method","title":"getService(headers:)","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","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetService","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O6OutputO","kind":"typeIdentifier"}],"roleHeading":"Instance Method","externalID":"s:14DiscogsService11APIProtocolPAAE03getB07headersAA10OperationsO03GetB0O6OutputOAI5InputV7HeadersV_tYaKF","extendedModule":"DiscogsService","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]]},"kind":"symbol","abstract":[{"text":"Get information about the service.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getService(_:)":{"role":"symbol","title":"getService(_:)","kind":"symbol","abstract":[{"text":"Get information about the service.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getService","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetService","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O5InputV"},{"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"}],"url":"\/documentation\/discogsservice\/apiprotocol\/getservice(_:)","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getService(_:)","required":true},"doc://DiscogsService/documentation/DiscogsService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"title":"Operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output":{"title":"Operations.GetService.Output","kind":"symbol","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output","url":"\/documentation\/discogsservice\/operations\/getservice\/output","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","title":"DiscogsService","abstract":[],"url":"\/documentation\/discogsservice","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getService(headers:)":{"title":"getService(headers:)","kind":"symbol","abstract":[{"text":"Get information about the service.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getService","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetService","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO03GetB0O"},{"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"}],"url":"\/documentation\/discogsservice\/apiprotocol\/getservice(headers:)","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getService(headers:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","type":"topic","abstract":[],"kind":"symbol","title":"Operations.GetService.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Input","url":"\/documentation\/discogsservice\/operations\/getservice\/input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService":{"title":"Operations.GetService","kind":"symbol","abstract":[{"text":"Get information about the service.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"GetService"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetService"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService","url":"\/documentation\/discogsservice\/operations\/getservice","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Input/Headers-swift.struct":{"title":"Operations.GetService.Input.Headers","kind":"symbol","abstract":[],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Input\/Headers-swift.struct","url":"\/documentation\/discogsservice\/operations\/getservice\/input\/headers-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/APIProtocol":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","kind":"identifier"}],"title":"APIProtocol","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol","kind":"symbol","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"url":"\/documentation\/discogsservice\/apiprotocol","role":"symbol","type":"topic"}}} |