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
8.6 KiB
JSON
1 line
8.6 KiB
JSON
{"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output\/TooManyRequests-swift.struct\/init(body:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output\/TooManyRequests-swift.struct"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"init(body:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","text":"getEventById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO15TooManyRequestsV","text":"TooManyRequests","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO15TooManyRequestsV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","externalID":"s:13MarvelService10OperationsO12getEventByIdO6OutputO15TooManyRequestsV4bodyA2I4BodyO_tcfc","roleHeading":"Initializer","symbolKind":"init","modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","text":"getEventById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output\/TooManyRequests-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO15TooManyRequestsV","text":"TooManyRequests","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO15TooManyRequestsV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response body"}]}],"name":"body"}],"kind":"parameters"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/geteventbyid\/output\/toomanyrequests-swift.struct\/init(body:)"]}],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"TooManyRequests","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://MarvelService/documentation/MarvelService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","title":"Operations","role":"symbol","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventById/Output/TooManyRequests-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/geteventbyid\/output\/toomanyrequests-swift.struct","title":"Operations.getEventById.Output.TooManyRequests","navigatorTitle":[{"kind":"identifier","text":"TooManyRequests"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output\/TooManyRequests-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"TooManyRequests","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/Operations/getEventById/Output/TooManyRequests-swift.struct/init(body:)":{"title":"init(body:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output\/TooManyRequests-swift.struct\/init(body:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO","kind":"typeIdentifier","text":"getEventById"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO15TooManyRequestsV","text":"TooManyRequests","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getEventByIdO6OutputO15TooManyRequestsV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventbyid\/output\/toomanyrequests-swift.struct\/init(body:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"TooManyRequests"},{"type":"text","text":"."}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventById":{"abstract":[{"type":"text","text":"Fetches a single event by id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById","navigatorTitle":[{"kind":"identifier","text":"getEventById"}],"title":"Operations.getEventById","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventById"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventbyid","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventById/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getEventById.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventbyid\/output","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventById/Output/TooManyRequests-swift.struct/Body-swift.enum":{"url":"\/documentation\/marvelservice\/operations\/geteventbyid\/output\/toomanyrequests-swift.struct\/body-swift.enum","title":"Operations.getEventById.Output.TooManyRequests.Body","navigatorTitle":[{"text":"Body","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventById\/Output\/TooManyRequests-swift.struct\/Body-swift.enum","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}]}}} |