rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
d5bd9feb0a8ea3020ee39efa3ba706e029951033
marvel-service/docs/data/documentation/marvelservice/operations/getcomicsbystoryid/input/init(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
13 KiB
JSON
Raw Blame History

{"sections":[],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Input"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/init(path:query:headers:)"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV4PathV","text":"Path","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Query-swift.struct"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO","text":"getComicsByStoryId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Headers-swift.struct"},{"text":" = .init())","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""}]}],"name":"path"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""}]}],"name":"query"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""}]}],"name":"headers"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/init(path:query:headers:)"]}],"metadata":{"title":"init(path:query:headers:)","externalID":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV4path5query7headersA2G4PathV_AG5QueryVAG7HeadersVtcfc","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Initializer","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV7HeadersV"},{"text":")","kind":"text"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"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/getComicsByStoryId/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/headers-swift.struct","title":"Operations.getComicsByStoryId.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId/Input/Path-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Path-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Path"}],"title":"Operations.getComicsByStoryId.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/path-swift.struct"},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId/Input/Query-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input\/Query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"title":"Operations.getComicsByStoryId.Input.Query","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/query-swift.struct"},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId/Input":{"url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input","title":"Operations.getComicsByStoryId.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId\/Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId":{"abstract":[{"type":"text","text":"Fetches lists of comics filtered by a story id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByStoryId","navigatorTitle":[{"text":"getComicsByStoryId","kind":"identifier"}],"title":"Operations.getComicsByStoryId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByStoryId","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByStoryId/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\/getComicsByStoryId\/Input\/init(path:query:headers:)","title":"init(path:query:headers:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByStoryIdO5InputV7HeadersV"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcomicsbystoryid\/input\/init(path:query:headers:)","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"}}}
View Git Blame Copy Permalink