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