rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
d5bd9feb0a8ea3020ee39efa3ba706e029951033
marvel-service/docs/data/documentation/marvelservice/operations/geteventsbystoryid/input/init(path:query:headers:).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
13 KiB
JSON
Raw Blame History

{"sections":[],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Input"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/init(path:query:headers:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/Query-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV5QueryV"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV7HeadersV"},{"text":" = .init())","kind":"text"}],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"name":"path","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"}]}]},{"name":"query","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"}]}]}],"kind":"parameters"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/geteventsbystoryid\/input\/init(path:query:headers:)"]}],"metadata":{"symbolKind":"init","role":"symbol","externalID":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV4path5query7headersA2G4PathV_AG5QueryVAG7HeadersVtcfc","roleHeading":"Initializer","title":"init(path:query:headers:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO","kind":"typeIdentifier","text":"getEventsByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO","kind":"typeIdentifier","text":"getEventsByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO","kind":"typeIdentifier","text":"getEventsByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":")"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEventsByStoryId/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/geteventsbystoryid\/input\/headers-swift.struct","title":"Operations.getEventsByStoryId.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByStoryId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/geteventsbystoryid\/input\/query-swift.struct","title":"Operations.getEventsByStoryId.Input.Query","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByStoryId":{"url":"\/documentation\/marvelservice\/operations\/geteventsbystoryid","title":"Operations.getEventsByStoryId","navigatorTitle":[{"text":"getEventsByStoryId","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of events filtered by a story id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByStoryId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByStoryId/Input":{"url":"\/documentation\/marvelservice\/operations\/geteventsbystoryid\/input","title":"Operations.getEventsByStoryId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"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/getEventsByStoryId/Input/init(path:query:headers:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Input","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/init(path:query:headers:)","title":"init(path:query:headers:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO","text":"getEventsByStoryId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO","text":"getEventsByStoryId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO","text":"getEventsByStoryId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByStoryIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbystoryid\/input\/init(path:query:headers:)"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByStoryId/Input/Path-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByStoryId\/Input\/Path-swift.struct","title":"Operations.getEventsByStoryId.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbystoryid\/input\/path-swift.struct","role":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"abstract":[]},"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"}}}
View Git Blame Copy Permalink