Files
marvel-service/docs/data/documentation/marvelservice/operations/getcharactersbystoryid.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
6.7 KiB
JSON

{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByStoryId","kind":"identifier"}],"navigatorTitle":[{"text":"getCharactersByStoryId","kind":"identifier"}],"modules":[{"name":"MarvelService"}],"symbolKind":"enum","roleHeading":"Enumeration","externalID":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","role":"symbol","title":"Operations.getCharactersByStoryId"},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","topicSections":[{"title":"Structures","anchor":"Structures","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input"],"generated":true},{"title":"Type Properties","anchor":"Type-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/id"],"generated":true},{"title":"Enumerations","anchor":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/AcceptableContentType","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Output"],"generated":true}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcharactersbystoryid"]}],"abstract":[{"type":"text","text":"Fetches lists of characters filtered by a story id."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByStoryId","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Overview","level":2,"anchor":"overview","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of comic characters appearing in a single story, with optional filters."}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/stories\/{storyId}\/characters"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/v1\/public\/stories\/{storyId}\/characters\/get(getCharactersByStoryId)","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside","name":"Remark"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Output":{"title":"Operations.getCharactersByStoryId.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Output","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId":{"title":"Operations.getCharactersByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"getCharactersByStoryId","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid","role":"symbol","navigatorTitle":[{"text":"getCharactersByStoryId","kind":"identifier"}],"abstract":[{"type":"text","text":"Fetches lists of characters filtered by a story id."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/AcceptableContentType":{"title":"Operations.getCharactersByStoryId.AcceptableContentType","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/acceptablecontenttype","navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/AcceptableContentType","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input","title":"Operations.getCharactersByStoryId.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/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"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/id":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/id","title":"id","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/id","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"}}}