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

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