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