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