rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
d5bd9feb0a8ea3020ee39efa3ba706e029951033
marvel-service/docs/data/documentation/marvelservice/client/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.3 KiB
JSON
Raw Blame History

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