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