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.3 KiB
JSON
1 line
9.3 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO2OkV","roleHeading":"Structure","symbolKind":"struct","role":"symbol","title":"Operations.getStoryById.Output.Ok"},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/init(body:)"],"title":"Initializers"},{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/body-swift.property"],"title":"Instance Properties"},{"generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/Body-swift.enum"],"title":"Enumerations"},{"generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/Equatable-Implementations"],"title":"Default Implementations"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output"]]},"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"]}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getstorybyid\/output\/ok-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"}],"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/getStoryById/Output/Ok-swift.struct/Equatable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/Equatable-Implementations","kind":"article","url":"\/documentation\/marvelservice\/operations\/getstorybyid\/output\/ok-swift.struct\/equatable-implementations","title":"Equatable Implementations","role":"collectionGroup","abstract":[],"type":"topic"},"doc://MarvelService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ"},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Output/Ok-swift.struct/Body-swift.enum":{"url":"\/documentation\/marvelservice\/operations\/getstorybyid\/output\/ok-swift.struct\/body-swift.enum","title":"Operations.getStoryById.Output.Ok.Body","navigatorTitle":[{"kind":"identifier","text":"Body"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Body"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Output/Ok-swift.struct/init(body:)":{"title":"init(body:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"url":"\/documentation\/marvelservice\/operations\/getstorybyid\/output\/ok-swift.struct\/init(body:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/init(body:)","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"body"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","kind":"typeIdentifier","text":"getStoryById"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Output/Ok-swift.struct/body-swift.property":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO","kind":"typeIdentifier","text":"getStoryById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO12getStoryByIdO6OutputO2OkV4BodyO","kind":"typeIdentifier","text":"Body"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct\/body-swift.property","kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getstorybyid\/output\/ok-swift.struct\/body-swift.property","title":"body","role":"symbol","abstract":[{"type":"text","text":"Received HTTP response body"}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Output":{"url":"\/documentation\/marvelservice\/operations\/getstorybyid\/output","title":"Operations.getStoryById.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById":{"abstract":[{"type":"text","text":"Fetches a single comic story by id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById","navigatorTitle":[{"text":"getStoryById","kind":"identifier"}],"title":"Operations.getStoryById","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoryById","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getstorybyid"},"doc://MarvelService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP"},"doc://MarvelService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH"},"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/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/documentation/MarvelService/Operations/getStoryById/Output/Ok-swift.struct":{"title":"Operations.getStoryById.Output.Ok","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getstorybyid\/output\/ok-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoryById\/Output\/Ok-swift.struct","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}]}}} |