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.5 KiB
JSON
1 line
9.5 KiB
JSON
{"relationshipsSections":[{"identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/notfound-swift.struct\/body-swift.enum"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"overview","text":"Overview","level":2,"type":"heading"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/comics\/{comicId}\/GET\/responses\/404\/content"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum\/json(_:)"],"generated":true,"anchor":"Enumeration-Cases"},{"title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum\/json"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum"},"kind":"symbol","metadata":{"title":"Operations.getComicById.Output.NotFound.Body","externalID":"s:13MarvelService10OperationsO12getComicByIdO6OutputO8NotFoundV4BodyO","navigatorTitle":[{"kind":"identifier","text":"Body"}],"role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Enumeration","symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}]},"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":{"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/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output/NotFound-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotFound"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"NotFound"}],"url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/notfound-swift.struct","title":"Operations.getComicById.Output.NotFound","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output/NotFound-swift.struct/Body-swift.enum/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/notfound-swift.struct\/body-swift.enum\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum\/Equatable-Implementations","kind":"article"},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output/NotFound-swift.struct/Body-swift.enum":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum","title":"Operations.getComicById.Output.NotFound.Body","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/notfound-swift.struct\/body-swift.enum","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Body"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output":{"title":"Operations.getComicById.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/SH":{"identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Operations/getComicById":{"title":"Operations.getComicById","abstract":[{"type":"text","text":"Fetches a single comic by id."}],"url":"\/documentation\/marvelservice\/operations\/getcomicbyid","navigatorTitle":[{"text":"getComicById","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicById","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output/NotFound-swift.struct/Body-swift.enum/json(_:)":{"url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/notfound-swift.struct\/body-swift.enum\/json(_:)","title":"Operations.getComicById.Output.NotFound.Body.json(_:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum\/json(_:)","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO13StandardErrorV","text":"StandardError","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicById/Output/NotFound-swift.struct/Body-swift.enum/json":{"url":"\/documentation\/marvelservice\/operations\/getcomicbyid\/output\/notfound-swift.struct\/body-swift.enum\/json","title":"json","type":"topic","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".json","type":"codeVoice"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicById\/Output\/NotFound-swift.struct\/Body-swift.enum\/json","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"StandardError","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO13StandardErrorV"}]}}} |