Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getstoriesbyeventid(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
17 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getStoriesByEventId(path:query:headers:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"extendedModule":"MarvelService","title":"getStoriesByEventId(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getStoriesByEventId","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV5QueryV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO","text":"getStoriesByEventId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV7HeadersV","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:13MarvelService10OperationsO19getStoriesByEventIdO","text":"getStoriesByEventId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:13MarvelService11APIProtocolPAAE19getStoriesByEventId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","symbolKind":"method","modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesByEventId","kind":"identifier"},{"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":"getStoriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV4PathV"},{"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":"getStoriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input\/Query-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV5QueryV"},{"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":"getStoriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getStoriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO6OutputO"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Fetches lists of comic stories from a specific event, with optional filters."}],"type":"paragraph"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/v1\/public\/events\/{eventId}\/stories","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/events\/{eventId}\/stories\/get(getStoriesByEventId)","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getstoriesbyeventid(path:query:headers:)"]}],"abstract":[{"type":"text","text":"Fetches lists of stories filtered by an event id."}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByEventId/Input":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyeventid\/input","title":"Operations.getStoriesByEventId.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","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/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/Operations/getStoriesByEventId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyeventid\/input\/query-swift.struct","title":"Operations.getStoriesByEventId.Input.Query","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByEventId/Input/Path-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyeventid\/input\/path-swift.struct","title":"Operations.getStoriesByEventId.Input.Path","navigatorTitle":[{"text":"Path","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input\/Path-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}]},"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/APIProtocol/getStoriesByEventId(path:query:headers:)":{"abstract":[{"text":"Fetches lists of stories filtered by an event id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getStoriesByEventId(path:query:headers:)","title":"getStoriesByEventId(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO5InputV7HeadersV"},{"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":"getStoriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getStoriesByEventIdO6OutputO"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/apiprotocol\/getstoriesbyeventid(path:query:headers:)"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByEventId":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyeventid","title":"Operations.getStoriesByEventId","navigatorTitle":[{"text":"getStoriesByEventId","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of stories filtered by an event id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesByEventId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByEventId/Output":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyeventid\/output","title":"Operations.getStoriesByEventId.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByEventId/Input/Headers-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByEventId\/Input\/Headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getstoriesbyeventid\/input\/headers-swift.struct","title":"Operations.getStoriesByEventId.Input.Headers","role":"symbol","abstract":[],"type":"topic"}}}