rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
af7b2c2ab27dde10d2df4f22839f351a9f4483c3
marvel-service/docs/data/documentation/marvelservice/operations/getevents/output/ok(_:).json
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
7.0 KiB
JSON
Raw Blame History

{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getevents\/output\/ok(_:)"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEvents","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/events\/get(getEvents)\/responses\/200","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark"},{"type":"paragraph","inlineContent":[{"text":"HTTP response code: ","type":"text"},{"code":"200 ok","type":"codeVoice"},{"text":".","type":"text"}]}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"OK response"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/ok(_:)"},"kind":"symbol","metadata":{"title":"Operations.getEvents.Output.ok(_:)","externalID":"s:13MarvelService10OperationsO9getEventsO6OutputO2okyA2G2OkVcAGmF","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Case","symbolKind":"case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEvents","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV"},{"text":")","kind":"text"}]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output/Ok-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output\/ok-swift.struct","title":"Operations.getEvents.Output.Ok","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/Ok-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}]},"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/getEvents/Output/ok(_:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output\/ok(_:)","title":"Operations.getEvents.Output.ok(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","text":"getEvents","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO2OkV"},{"kind":"text","text":")"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getevents\/output\/ok(_:)","role":"symbol","abstract":[{"type":"text","text":"OK response"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output":{"url":"\/documentation\/marvelservice\/operations\/getevents\/output","title":"Operations.getEvents.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"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/getEvents":{"url":"\/documentation\/marvelservice\/operations\/getevents","title":"Operations.getEvents","navigatorTitle":[{"kind":"identifier","text":"getEvents"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of events."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"}]}}}
View Git Blame Copy Permalink