1 line
4.9 KiB
JSON
1 line
4.9 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"privateKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"publicKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"A Marvel API private key.","type":"text"}],"type":"paragraph"}],"name":"privateKey"},{"name":"publicKey","content":[{"inlineContent":[{"text":"A Marvel API public key.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"inlineContent":[{"type":"text","text":"The middleware attaches the required "},{"code":"apikey","type":"codeVoice"},{"type":"text","text":", "},{"code":"ts","type":"codeVoice"},{"type":"text","text":", and "},{"code":"hash","type":"codeVoice"},{"type":"text","text":" parameters to the URI path of the intercepted request."},{"type":"text","text":" "},{"type":"text","text":"This initializer should be used for server-side applications, as indicated in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.marvel.com\/documentation\/authorization"}],"type":"paragraph"}]}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(privateKey:publicKey:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/marvelservice\/authmiddleware\/init(privatekey:publickey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"init(privateKey:publicKey:)","modules":[{"name":"MarvelService"}],"roleHeading":"Initializer","role":"symbol","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"privateKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"externalID":"s:13MarvelService14AuthMiddlewareV10privateKey06publicF0ACSS_SStcfc"},"abstract":[{"type":"text","text":"Initializes this middleware with private and public keys."}],"references":{"doc://MarvelService/documentation/MarvelService/AuthMiddleware":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}],"url":"\/documentation\/marvelservice\/authmiddleware","title":"AuthMiddleware","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"abstract":[{"text":"A middleware that attaches the necessary authentication parameters to the path of the request.","type":"text"}]},"https://developer.marvel.com/documentation/authorization":{"titleInlineContent":[{"type":"text","text":"Marvel API documentation"}],"url":"https:\/\/developer.marvel.com\/documentation\/authorization","title":"Marvel API documentation","type":"link","identifier":"https:\/\/developer.marvel.com\/documentation\/authorization"},"doc://MarvelService/documentation/MarvelService/AuthMiddleware/init(privateKey:publicKey:)":{"url":"\/documentation\/marvelservice\/authmiddleware\/init(privatekey:publickey:)","kind":"symbol","title":"init(privateKey:publicKey:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(privateKey:publicKey:)","role":"symbol","type":"topic","abstract":[{"text":"Initializes this middleware with private and public keys.","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"privateKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"publicKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}]},"doc://MarvelService/documentation/MarvelService":{"url":"\/documentation\/marvelservice","kind":"symbol","title":"MarvelService","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","type":"topic","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"text":" backend service.","type":"text"}]}}} |