rock-n-code/marvel-service
1
0
Fork 0
Code Pull Requests Releases 2 Activity
Files
d5bd9feb0a8ea3020ee39efa3ba706e029951033
marvel-service/docs/data/documentation/marvelservice/client/getcharacterbyid(_:).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
9.1 KiB
JSON
Raw Blame History

{"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getcharacterbyid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharacterById"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier","text":"getCharacterById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV","kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier","text":"getCharacterById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO","kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output"}],"platforms":["macOS"]}]},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"This method fetches a single character resource. It is the canonical URI for any character resource provided by the API.","type":"text"}]},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/characters\/{characterId}"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark","style":"note"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/characters\/{characterId}\/get(getCharacterById)"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark","style":"note"}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Fetches a single character by id."}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharacterById(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"getCharacterById(_:)","externalID":"s:13MarvelService6ClientV16getCharacterByIdyAA10OperationsOADO6OutputOAG5InputVYaKF","role":"symbol","modules":[{"name":"MarvelService"}],"symbolKind":"method","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharacterById"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier","text":"getCharacterById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier","text":"getCharacterById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO","kind":"typeIdentifier","text":"Output"}]},"references":{"doc://MarvelService/documentation/MarvelService/Client/getCharacterById(_:)":{"title":"getCharacterById(_:)","abstract":[{"text":"Fetches a single character by id.","type":"text"}],"url":"\/documentation\/marvelservice\/client\/getcharacterbyid(_:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharacterById(_:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharacterById"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier","text":"getCharacterById"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO","kind":"typeIdentifier","text":"getCharacterById"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO16getCharacterByIdO6OutputO"}]},"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/Client":{"abstract":[{"text":"The Marvel Comics RESTful API.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"title":"Client","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"kind":"symbol","url":"\/documentation\/marvelservice\/client","type":"topic"},"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/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/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacterById\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getCharacterById.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharacterbyid\/output"},"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