d5bd9feb0a
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>
1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"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"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Path-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Query-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV5QueryV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"kind":"text","text":"."},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"kind":"text","text":"."},{"text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getEventsByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output"}]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of events in which a specific comic appears, with optional filters.","type":"text"}]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"type":"codeVoice","code":"GET \/v1\/public\/comics\/{comicId}\/events"},{"text":".","type":"text"}]}],"style":"note","name":"Remark"},{"name":"Remark","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/events\/get(getEventsByComicId)"},{"text":".","type":"text"}]}]}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"abstract":[{"type":"text","text":"Fetches lists of events filtered by a comic id."}],"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/geteventsbycomicid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"metadata":{"title":"getEventsByComicId(path:query:headers:)","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"symbolKind":"method","externalID":"s:13MarvelService11APIProtocolPAAE18getEventsByComicId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","extendedModule":"MarvelService","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEventsByComicId"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","kind":"typeIdentifier","text":"getEventsByComicId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV4PathV","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:13MarvelService10OperationsO18getEventsByComicIdO","kind":"typeIdentifier","text":"getEventsByComicId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","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"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsByComicId","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO","kind":"typeIdentifier","text":"Output"}]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsByComicId(path:query:headers:)","interfaceLanguage":"swift"},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input","kind":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input","title":"Operations.getEventsByComicId.Input","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Input/Query-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Query-swift.struct","kind":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input\/query-swift.struct","title":"Operations.getEventsByComicId.Input.Query","role":"symbol","abstract":[],"type":"topic"},"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/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/Input/Path-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Path-swift.struct","navigatorTitle":[{"text":"Path","kind":"identifier"}],"title":"Operations.getEventsByComicId.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input\/path-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId/Input/Headers-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input\/Headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"title":"Operations.getEventsByComicId.Input.Headers","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input\/headers-swift.struct","type":"topic"},"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/APIProtocol":{"url":"\/documentation\/marvelservice\/apiprotocol","title":"APIProtocol","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEventsByComicId(path:query:headers:)":{"title":"getEventsByComicId(path:query:headers:)","abstract":[{"type":"text","text":"Fetches lists of events filtered by a comic id."}],"url":"\/documentation\/marvelservice\/apiprotocol\/geteventsbycomicid(path:query:headers:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsByComicId(path:query:headers:)","type":"topic","role":"symbol","fragments":[{"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"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV4PathV","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:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV5QueryV","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:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","text":"getEventsByComicId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO","text":"Output","kind":"typeIdentifier"}]},"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"}}} |