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
9.4 KiB
JSON
1 line
9.4 KiB
JSON
{"relationshipsSections":[{"identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/ok-swift.struct\/body-swift.enum"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/series\/{seriesId}\/GET\/responses\/200\/content"},{"type":"text","text":"."}]}],"style":"note","name":"Remark"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)"],"generated":true,"title":"Enumeration Cases","anchor":"Enumeration-Cases"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum\/json"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"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\/Ok-swift.struct"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"Operations.getSeriesById.Output.Ok.Body","externalID":"s:13MarvelService10OperationsO13getSeriesByIdO6OutputO2OkV4BodyO","navigatorTitle":[{"text":"Body","kind":"identifier"}],"role":"symbol","modules":[{"name":"MarvelService"}],"symbolKind":"enum","roleHeading":"Enumeration","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}]},"references":{"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"}]},"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":{"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/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/MarvelService\/s8SendableP","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesById/Output/Ok-swift.struct/Body-swift.enum/json(_:)":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/ok-swift.struct\/body-swift.enum\/json(_:)","title":"Operations.getSeriesById.Output.Ok.Body.json(_:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)","kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO17SeriesDataWrapperV","kind":"typeIdentifier","text":"SeriesDataWrapper"},{"kind":"text","text":")"}]},"doc://MarvelService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/MarvelService\/SQ","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesById/Output/Ok-swift.struct/Body-swift.enum":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/ok-swift.struct\/body-swift.enum","title":"Operations.getSeriesById.Output.Ok.Body","navigatorTitle":[{"kind":"identifier","text":"Body"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesById/Output/Ok-swift.struct/Body-swift.enum/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/ok-swift.struct\/body-swift.enum\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations","kind":"article"},"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/Ok-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"title":"Operations.getSeriesById.Output.Ok","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/ok-swift.struct"},"doc://MarvelService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","type":"unresolvable"},"doc://MarvelService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/MarvelService\/SH","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesById/Output/Ok-swift.struct/Body-swift.enum/json":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyid\/output\/ok-swift.struct\/body-swift.enum\/json","title":"json","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":".json"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesById\/Output\/Ok-swift.struct\/Body-swift.enum\/json","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO17SeriesDataWrapperV","kind":"typeIdentifier","text":"SeriesDataWrapper"}]}}} |