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
7.1 KiB
JSON
1 line
7.1 KiB
JSON
{"sections":[],"abstract":[{"type":"text","text":"OK response"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/ok(_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById","text":"getComicById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO6OutputO2OkV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/Ok-swift.struct","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"name":"Remark","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/get(getComicById)\/responses\/200"},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP response code: "},{"type":"codeVoice","code":"200 ok"},{"type":"text","text":"."}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output"]]},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/ok(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"case","role":"symbol","externalID":"s:13MarvelService10OperationsO12getComicByIdO6OutputO2okyA2G2OkVcAGmF","title":"Operations.getComicById.Output.ok(_:)","roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO","text":"getComicById","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"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":{"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/getComicById/Output":{"title":"Operations.getComicById.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output/Ok-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/Ok-swift.struct","title":"Operations.getComicById.Output.Ok","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/ok-swift.struct","role":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output/ok(_:)":{"url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/ok(_:)","title":"Operations.getComicById.Output.ok(_:)","type":"topic","abstract":[{"type":"text","text":"OK response"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/ok(_:)","kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getComicById","preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:13MarvelService10OperationsO12getComicByIdO6OutputO2OkV"},{"kind":"text","text":")"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicById":{"title":"Operations.getComicById","abstract":[{"type":"text","text":"Fetches a single comic by id."}],"url":"\/documentation\/marvelservice\/operations\/getcomicbyid","navigatorTitle":[{"text":"getComicById","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicById","kind":"identifier"}]}}} |