javier
d5bd9feb0a
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it. Reviewed-on: #7 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
6.1 KiB
JSON
1 line
6.1 KiB
JSON
{"sections":[],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/MarvelService\/14OpenAPIRuntime16ClientMiddlewareP","doc:\/\/MarvelService\/s8CopyableP","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"abstract":[{"text":"A middleware that attaches the necessary authentication parameters to the path of the request.","type":"text"}],"seeAlsoSections":[{"title":"Configuration","generated":true,"anchor":"Configuration","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1"]}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthMiddleware"}],"platforms":["macOS"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService"]]},"topicSections":[{"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(apiKey:)","doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(privateKey:publicKey:)"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/ClientMiddleware-Implementations"],"generated":true}],"metadata":{"symbolKind":"struct","role":"symbol","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"externalID":"s:13MarvelService14AuthMiddlewareV","roleHeading":"Structure","title":"AuthMiddleware","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthMiddleware"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/authmiddleware"]}],"references":{"doc://MarvelService/documentation/MarvelService/Servers/Server1":{"title":"Servers.Server1","abstract":[{"text":"Live service","type":"text"}],"url":"\/documentation\/marvelservice\/servers\/server1","navigatorTitle":[{"text":"Server1","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Servers\/Server1","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","kind":"symbol","url":"\/documentation\/marvelservice","title":"MarvelService","role":"collection","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"type":"text","text":" backend service."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/AuthMiddleware":{"abstract":[{"text":"A middleware that attaches the necessary authentication parameters to the path of the request.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"title":"AuthMiddleware","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/authmiddleware"},"doc://MarvelService/documentation/MarvelService/AuthMiddleware/init(apiKey:)":{"abstract":[{"type":"text","text":"Initializes this middleware with an api key."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(apiKey:)","title":"init(apiKey:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"apiKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/authmiddleware\/init(apikey:)","type":"topic"},"doc://MarvelService/documentation/MarvelService/AuthMiddleware/ClientMiddleware-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/ClientMiddleware-Implementations","title":"ClientMiddleware Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/authmiddleware\/clientmiddleware-implementations"},"doc://MarvelService/documentation/MarvelService/AuthMiddleware/init(privateKey:publicKey:)":{"abstract":[{"text":"Initializes this middleware with private and public keys.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(privateKey:publicKey:)","title":"init(privateKey:publicKey:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"privateKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"publicKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/authmiddleware\/init(privatekey:publickey:)"},"doc://MarvelService/s8SendableP":{"identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://MarvelService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/14OpenAPIRuntime16ClientMiddlewareP":{"identifier":"doc:\/\/MarvelService\/14OpenAPIRuntime16ClientMiddlewareP","title":"OpenAPIRuntime.ClientMiddleware","type":"unresolvable"},"doc://MarvelService/s8CopyableP":{"identifier":"doc:\/\/MarvelService\/s8CopyableP","title":"Swift.Copyable","type":"unresolvable"}}} |