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
8.1 KiB
JSON
1 line
8.1 KiB
JSON
{"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/characters\/{characterId}\/stories\/GET\/path"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"}],"kind":"content"}],"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct\/init(characterId:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct\/characterId"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct\/Equatable-Implementations"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input"]]},"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input\/path-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"title":"Operations.getStoriesByCharacterId.Input.Path","roleHeading":"Structure","modules":[{"name":"MarvelService"}],"symbolKind":"struct","navigatorTitle":[{"text":"Path","kind":"identifier"}],"externalID":"s:13MarvelService10OperationsO23getStoriesByCharacterIdO5InputV4PathV","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct","interfaceLanguage":"swift"},"sections":[],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Input/Path-swift.struct/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input\/path-swift.struct\/equatable-implementations","kind":"article","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"doc://MarvelService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP"},"doc://MarvelService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Input/Path-swift.struct/init(characterId:)":{"title":"init(characterId:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Path"},{"type":"text","text":"."}],"url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input\/path-swift.struct\/init(characterid:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct\/init(characterId:)","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"characterId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesByCharacterId/Input/Path-swift.struct/characterId":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"characterId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesByCharacterId\/Input\/Path-swift.struct\/characterId","url":"\/documentation\/marvelservice\/operations\/getstoriesbycharacterid\/input\/path-swift.struct\/characterid","title":"characterId","role":"symbol","abstract":[{"text":"A character id.","type":"text"}],"type":"topic"},"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":{"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":{"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/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH"},"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"}}} |