Files
marvel-service/docs/data/documentation/marvelservice/operations/getcomics/output/ok-swift.property.json
T
javier d5bd9feb0a First version of the library documentation (#7)
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>
2025-10-05 18:41:22 +00:00

1 line
7.4 KiB
JSON

{"sections":[],"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output\/ok-swift.property"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComics","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output\/Ok-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO2OkV"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","content":[{"inlineContent":[{"text":"An error if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is not ","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Throws"},{"type":"aside","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"See Also"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output"]]},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcomics\/output\/ok-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:13MarvelService10OperationsO9getComicsO6OutputO2okAG2OkVvp","title":"ok","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO2OkV"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getComics/Output":{"url":"\/documentation\/marvelservice\/operations\/getcomics\/output","title":"Operations.getComics.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","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":{"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/getComics":{"navigatorTitle":[{"text":"getComics","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"getComics","kind":"identifier"}],"role":"symbol","type":"topic","abstract":[{"text":"Fetches lists of comics.","type":"text"}],"kind":"symbol","title":"Operations.getComics"},"doc://MarvelService/documentation/MarvelService/Operations/getComics/Output/ok-swift.property":{"url":"\/documentation\/marvelservice\/operations\/getcomics\/output\/ok-swift.property","title":"ok","type":"topic","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output\/ok-swift.property","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO2OkV"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComics/Output/Ok-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcomics\/output\/ok-swift.struct","title":"Operations.getComics.Output.Ok","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output\/Ok-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}]}}}