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.9 KiB
JSON
1 line
8.9 KiB
JSON
{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","text":"getCharactersBySeriesId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO8ConflictV","text":"Conflict","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output\/Conflict-swift.struct","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO8ConflictV4BodyO","text":"Body","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output\/Conflict-swift.struct\/Body-swift.enum","kind":"typeIdentifier"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"name":"body","content":[{"type":"paragraph","inlineContent":[{"text":"Received HTTP response body","type":"text"}]}]}],"kind":"parameters"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output\/Conflict-swift.struct"]]},"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Conflict","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/output\/conflict-swift.struct\/init(body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output\/Conflict-swift.struct\/init(body:)"},"metadata":{"title":"init(body:)","modules":[{"name":"MarvelService"}],"roleHeading":"Initializer","symbolKind":"init","externalID":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO8ConflictV4bodyA2I4BodyO_tcfc","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"getCharactersBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO"},{"kind":"text","text":"."},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO"},{"text":".","kind":"text"},{"text":"Conflict","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO8ConflictV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO8ConflictV4BodyO"},{"text":")","kind":"text"}]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Output/Conflict-swift.struct/Body-swift.enum":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/output\/conflict-swift.struct\/body-swift.enum","title":"Operations.getCharactersBySeriesId.Output.Conflict.Body","navigatorTitle":[{"kind":"identifier","text":"Body"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output\/Conflict-swift.struct\/Body-swift.enum","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Output/Conflict-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output\/Conflict-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Conflict"}],"title":"Operations.getCharactersBySeriesId.Output.Conflict","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Conflict"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/output\/conflict-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Output":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output","title":"Operations.getCharactersBySeriesId.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Output/Conflict-swift.struct/init(body:)":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/output\/conflict-swift.struct\/init(body:)","title":"init(body:)","type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Conflict"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output\/Conflict-swift.struct\/init(body:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","kind":"typeIdentifier","text":"getCharactersBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO8ConflictV","kind":"typeIdentifier","text":"Conflict"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO8ConflictV4BodyO","kind":"typeIdentifier","text":"Body"},{"kind":"text","text":")"}]},"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/getCharactersBySeriesId":{"abstract":[{"text":"Fetches lists of characters filtered by a series id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","navigatorTitle":[{"kind":"identifier","text":"getCharactersBySeriesId"}],"title":"Operations.getCharactersBySeriesId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersBySeriesId","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid","type":"topic"}}} |