Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/geteventsbycomicid(path:query:headers:).json
T
javier fc84db4881 Updated license to Apache v2.0 (#9)
This PR contains the work done to update the license to *Apache v2.0* and also, to update any file header and/or mention as necessary.

Reviewed-on: #9
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-07 23:02:12 +00:00

1 line
17 KiB
JSON

{"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsByComicId(path:query:headers:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV4PathV","text":"Path","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Query-swift.struct"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Headers-swift.struct"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output"}]}]},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of events in which a specific comic appears, with optional filters."}]},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/comics\/{comicId}\/events"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/events\/get(getEventsByComicId)"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"}],"kind":"content"}],"metadata":{"modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService11APIProtocolPAAE18getEventsByComicId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsByComicId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO","text":"Output"}],"title":"getEventsByComicId(path:query:headers:)","role":"symbol","roleHeading":"Instance Method","extendedModule":"MarvelService"},"abstract":[{"type":"text","text":"Fetches lists of events filtered by a comic id."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/geteventsbycomicid(path:query:headers:)"]}],"references":{"doc://MarvelService/documentation/MarvelService/APIProtocol":{"navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"url":"\/documentation\/marvelservice\/apiprotocol","kind":"symbol","title":"APIProtocol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","role":"symbol","type":"topic","abstract":[{"text":"A type that performs HTTP operations defined by the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Input":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.getEventsByComicId.Input","kind":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","kind":"symbol","title":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","role":"symbol","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEventsByComicId(path:query:headers:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsByComicId(path:query:headers:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO"}],"url":"\/documentation\/marvelservice\/apiprotocol\/geteventsbycomicid(path:query:headers:)","title":"getEventsByComicId(path:query:headers:)","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a comic id."}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Input/Path-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input\/path-swift.struct","title":"Operations.getEventsByComicId.Input.Path","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Path"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Input/Headers-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input\/headers-swift.struct","title":"Operations.getEventsByComicId.Input.Headers","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Output":{"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","role":"symbol","title":"Operations.getEventsByComicId.Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output","url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId":{"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsByComicId"}],"abstract":[{"type":"text","text":"Fetches lists of events filtered by a comic id."}],"navigatorTitle":[{"kind":"identifier","text":"getEventsByComicId"}],"kind":"symbol","role":"symbol","title":"Operations.getEventsByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Input/Query-swift.struct":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"title":"Operations.getEventsByComicId.Input.Query","kind":"symbol","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input\/query-swift.struct","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Query-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService":{"url":"\/documentation\/marvelservice","kind":"symbol","title":"MarvelService","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","type":"topic","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"text":" backend service.","type":"text"}]}}}