Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcreatorsbycomicid(_:).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
9.5 KiB
JSON

{"sections":[],"abstract":[{"text":"Fetches lists of creators filtered by a comic id.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCreatorsByComicId(_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorsByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByComicId\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO5InputV"},{"text":") ","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":"getCreatorsByComicId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByComicId\/Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO6OutputO"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Fetches lists of comic creators whose work appears in a specific comic, with optional filters."}],"type":"paragraph"},{"type":"aside","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"type":"codeVoice","code":"GET \/v1\/public\/comics\/{comicId}\/creators"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/creators\/get(getCreatorsByComicId)"},{"type":"text","text":"."}]}],"name":"Remark","style":"note","type":"aside"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcreatorsbycomicid(_:)"]}],"metadata":{"symbolKind":"method","required":true,"role":"symbol","externalID":"s:13MarvelService11APIProtocolP20getCreatorsByComicIdyAA10OperationsOADO6OutputOAG5InputVYaKF","title":"getCreatorsByComicId(_:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorsByComicId"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO","kind":"typeIdentifier","text":"getCreatorsByComicId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO","kind":"typeIdentifier","text":"getCreatorsByComicId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO6OutputO","kind":"typeIdentifier","text":"Output"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCreatorsByComicId/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByComicId\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getCreatorsByComicId.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcreatorsbycomicid\/output","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/getCreatorsByComicId":{"url":"\/documentation\/marvelservice\/operations\/getcreatorsbycomicid","title":"Operations.getCreatorsByComicId","navigatorTitle":[{"kind":"identifier","text":"getCreatorsByComicId"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of creators filtered by a comic id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByComicId","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorsByComicId"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol/getCreatorsByComicId(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorsByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO5InputV"},{"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":"getCreatorsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO20getCreatorsByComicIdO6OutputO"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCreatorsByComicId(_:)","kind":"symbol","url":"\/documentation\/marvelservice\/apiprotocol\/getcreatorsbycomicid(_:)","title":"getCreatorsByComicId(_:)","required":true,"abstract":[{"type":"text","text":"Fetches lists of creators filtered by a comic id."}],"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/getCreatorsByComicId/Input":{"url":"\/documentation\/marvelservice\/operations\/getcreatorsbycomicid\/input","title":"Operations.getCreatorsByComicId.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorsByComicId\/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"}}}