Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcreatorsbyeventid(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

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