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

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