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

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId"]]},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Headers-swift.struct","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Path-swift.struct","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Query-swift.struct"],"generated":true,"anchor":"Structures","title":"Structures"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/init(path:query:headers:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/headers-swift.property","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/path-swift.property","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/query-swift.property"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"symbolKind":"struct","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"externalID":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","title":"Operations.getCharactersByStoryId.Input","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]}]}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo"}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/init(path:query:headers:)":{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Input"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/init(path:query:headers:)","title":"init(path:query:headers:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","kind":"typeIdentifier","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","kind":"typeIdentifier","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","kind":"typeIdentifier","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":")"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/init(path:query:headers:)","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/getCharactersByStoryId/Input/Path-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/path-swift.struct","title":"Operations.getCharactersByStoryId.Input.Path","navigatorTitle":[{"text":"Path","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Path-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","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/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/query-swift.property":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/query-swift.property","title":"query","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/query-swift.property","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"query","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV5QueryV"}]},"doc://MarvelService/s16SendableMetatypeP":{"identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"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/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/Input/Equatable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/equatable-implementations","role":"collectionGroup","abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/Query-swift.struct":{"title":"Operations.getCharactersByStoryId.Input.Query","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/query-swift.struct","navigatorTitle":[{"text":"Query","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Query-swift.struct","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/headers-swift.property":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/headers-swift.property","title":"headers","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/headers-swift.property","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV7HeadersV","text":"Headers"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/headers-swift.struct","title":"Operations.getCharactersByStoryId.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/path-swift.property":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV4PathV","text":"Path"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/path-swift.property","url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/path-swift.property","title":"path","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/SH":{"identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable","type":"unresolvable"}}}