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.1 KiB
JSON
1 line
8.1 KiB
JSON
{"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getevents\/output\/ok-swift.struct\/init(body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEvents","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV4BodyO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"body","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response body"}]}]}],"kind":"parameters"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct\/init(body:)"},"kind":"symbol","metadata":{"title":"init(body:)","externalID":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV4bodyA2I4BodyO_tcfc","role":"symbol","modules":[{"name":"MarvelService"}],"symbolKind":"init","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEvents","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV4BodyO","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"references":{"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/getEvents/Output/Ok-swift.struct/Body-swift.enum":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output\/ok-swift.struct\/body-swift.enum","title":"Operations.getEvents.Output.Ok.Body","navigatorTitle":[{"text":"Body","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output/Ok-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output\/ok-swift.struct","title":"Operations.getEvents.Output.Ok","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output/Ok-swift.struct/init(body:)":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output\/ok-swift.struct\/init(body:)","title":"init(body:)","type":"topic","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct\/init(body:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEvents","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"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/getEvents/Output":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output","title":"Operations.getEvents.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents":{"url":"\/documentation\/marvelservice\/operations\/getevents","title":"Operations.getEvents","navigatorTitle":[{"kind":"identifier","text":"getEvents"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of events."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"}]}}} |