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