Files
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
10 KiB
JSON

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