Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcreatorsbyseriesid(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 a series id.","type":"text"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCreatorsBySeriesId(path:query:headers:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV4PathV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/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:13MarvelService10OperationsO21getCreatorsBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV5QueryV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input\/Query-swift.struct","text":"Query","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV7HeadersV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input\/Headers-swift.struct","text":"Headers","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Output","text":"Output","kind":"typeIdentifier"}]}]},{"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 series, with optional filters."}],"type":"paragraph"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/series\/{seriesId}\/creators"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/series\/{seriesId}\/creators\/get(getCreatorsBySeriesId)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getcreatorsbyseriesid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"method","role":"symbol","externalID":"s:13MarvelService11APIProtocolPAAE21getCreatorsBySeriesId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","roleHeading":"Instance Method","title":"getCreatorsBySeriesId(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV4PathV","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:13MarvelService10OperationsO21getCreatorsBySeriesIdO","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV5QueryV","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:13MarvelService10OperationsO21getCreatorsBySeriesIdO","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV7HeadersV","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:13MarvelService10OperationsO21getCreatorsBySeriesIdO","text":"getCreatorsBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"modules":[{"name":"MarvelService"}],"extendedModule":"MarvelService"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://MarvelService/documentation/MarvelService/APIProtocol/getCreatorsBySeriesId(path:query:headers:)":{"title":"getCreatorsBySeriesId(path:query:headers:)","abstract":[{"type":"text","text":"Fetches lists of creators filtered by a series id."}],"url":"\/documentation\/marvelservice\/apiprotocol\/getcreatorsbyseriesid(path:query:headers:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCreatorsBySeriesId(path:query:headers:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorsBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO5InputV7HeadersV"},{"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":"getCreatorsBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO21getCreatorsBySeriesIdO6OutputO"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsBySeriesId/Input/Headers-swift.struct":{"title":"Operations.getCreatorsBySeriesId.Input.Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid\/input\/headers-swift.struct","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsBySeriesId/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.getCreatorsBySeriesId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid\/input"},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsBySeriesId":{"url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid","title":"Operations.getCreatorsBySeriesId","navigatorTitle":[{"text":"getCreatorsBySeriesId","kind":"identifier"}],"type":"topic","abstract":[{"text":"Fetches lists of creators filtered by a series id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsBySeriesId","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":{"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/getCreatorsBySeriesId/Input/Path-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input\/Path-swift.struct","title":"Operations.getCreatorsBySeriesId.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid\/input\/path-swift.struct","role":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsBySeriesId/Input/Query-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Input\/Query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"title":"Operations.getCreatorsBySeriesId.Input.Query","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid\/input\/query-swift.struct"},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsBySeriesId/Output":{"title":"Operations.getCreatorsBySeriesId.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcreatorsbyseriesid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsBySeriesId\/Output","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]}}}