Files
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
8.7 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/MethodNotAllowed-swift.struct"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/MethodNotAllowed-swift.struct\/init(body:)","interfaceLanguage":"swift"},"metadata":{"title":"init(body:)","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":"getSeriesById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO"},{"text":".","kind":"text"},{"text":"MethodNotAllowed","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO16MethodNotAllowedV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO16MethodNotAllowedV4BodyO"},{"text":")","kind":"text"}],"externalID":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO16MethodNotAllowedV4bodyA2I4BodyO_tcfc","role":"symbol","roleHeading":"Initializer","symbolKind":"init","modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO"},{"text":".","kind":"text"},{"text":"MethodNotAllowed","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/MethodNotAllowed-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO16MethodNotAllowedV"},{"text":".","kind":"text"},{"text":"Body","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO16MethodNotAllowedV4BodyO"},{"text":")","kind":"text"}],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Received HTTP response body","type":"text"}]}],"name":"body"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/methodnotallowed-swift.struct\/init(body:)"]}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"MethodNotAllowed"},{"type":"text","text":"."}],"references":{"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/getSeriesById/Output/MethodNotAllowed-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/methodnotallowed-swift.struct","title":"Operations.getSeriesById.Output.MethodNotAllowed","navigatorTitle":[{"text":"MethodNotAllowed","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/MethodNotAllowed-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MethodNotAllowed"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesById/Output/MethodNotAllowed-swift.struct/init(body:)":{"title":"init(body:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/MethodNotAllowed-swift.struct\/init(body:)","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":"getSeriesById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO"},{"text":".","kind":"text"},{"text":"MethodNotAllowed","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO16MethodNotAllowedV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO16MethodNotAllowedV4BodyO"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/methodnotallowed-swift.struct\/init(body:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"MethodNotAllowed"},{"type":"text","text":"."}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesById/Output/MethodNotAllowed-swift.struct/Body-swift.enum":{"title":"Operations.getSeriesById.Output.MethodNotAllowed.Body","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/methodnotallowed-swift.struct\/body-swift.enum","role":"symbol","navigatorTitle":[{"text":"Body","kind":"identifier"}],"abstract":[]},"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/getSeriesById":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyid","title":"Operations.getSeriesById","navigatorTitle":[{"text":"getSeriesById","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Fetches a single comic series by id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeriesById","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesById/Output":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output","title":"Operations.getSeriesById.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]}}}