Files
T
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
9.9 KiB
JSON

{"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"overview","text":"Overview","type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/v1\/public\/comics\/{comicId}\/events\/GET\/responses\/405\/content"},{"text":".","type":"text"}]}],"style":"note","name":"Remark","type":"aside"}],"kind":"content"}],"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum\/json(_:)"],"title":"Enumeration Cases","generated":true,"anchor":"Enumeration-Cases"},{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum\/json"],"generated":true},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum\/Equatable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct"]]},"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"kind":"relationships"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output\/methodnotallowed-swift.struct\/body-swift.enum"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"MarvelService"}],"roleHeading":"Enumeration","title":"Operations.getEventsByComicId.Output.MethodNotAllowed.Body","symbolKind":"enum","navigatorTitle":[{"text":"Body","kind":"identifier"}],"externalID":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO16MethodNotAllowedV4BodyO","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum","interfaceLanguage":"swift"},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Output":{"title":"Operations.getEventsByComicId.Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output","role":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Output/MethodNotAllowed-swift.struct/Body-swift.enum":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum","navigatorTitle":[{"kind":"identifier","text":"Body"}],"title":"Operations.getEventsByComicId.Output.MethodNotAllowed.Body","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output\/methodnotallowed-swift.struct\/body-swift.enum"},"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/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId":{"title":"Operations.getEventsByComicId","abstract":[{"text":"Fetches lists of events filtered by a comic id.","type":"text"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid","navigatorTitle":[{"text":"getEventsByComicId","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByComicId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Output/MethodNotAllowed-swift.struct/Body-swift.enum/json(_:)":{"title":"Operations.getEventsByComicId.Output.MethodNotAllowed.Body.json(_:)","abstract":[],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output\/methodnotallowed-swift.struct\/body-swift.enum\/json(_:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum\/json(_:)","type":"topic","role":"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:13MarvelService10ComponentsO7SchemasO13StandardErrorV","kind":"typeIdentifier","text":"StandardError"},{"kind":"text","text":")"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Output/MethodNotAllowed-swift.struct/Body-swift.enum/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output\/methodnotallowed-swift.struct\/body-swift.enum\/equatable-implementations","kind":"article","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Output/MethodNotAllowed-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output\/methodnotallowed-swift.struct","title":"Operations.getEventsByComicId.Output.MethodNotAllowed","navigatorTitle":[{"kind":"identifier","text":"MethodNotAllowed"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"MethodNotAllowed","kind":"identifier"}]},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Output/MethodNotAllowed-swift.struct/Body-swift.enum/json":{"title":"json","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":"."}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output\/methodnotallowed-swift.struct\/body-swift.enum\/json","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output\/MethodNotAllowed-swift.struct\/Body-swift.enum\/json","type":"topic","role":"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:13MarvelService10ComponentsO7SchemasO13StandardErrorV","kind":"typeIdentifier","text":"StandardError"}]}}}