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
13 KiB
JSON
1 line
13 KiB
JSON
{"sections":[],"abstract":[{"text":"Fetches a single creator by id.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCreatorById(path:headers:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorById","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorById","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Output","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO6OutputO"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"This method fetches a single creator resource. It is the canonical URI for any creator resource provided by the API.","type":"text"}]},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/v1\/public\/creators\/{creatorId}","type":"codeVoice"},{"text":".","type":"text"}]}]},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/creators\/{creatorId}\/get(getCreatorById)","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"variants":[{"paths":["\/documentation\/marvelservice\/client\/getcreatorbyid(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"method","role":"symbol","externalID":"s:13MarvelService11APIProtocolPAAE14getCreatorById4path7headersAA10OperationsOADO6OutputOAI5InputV4PathV_AM7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","title":"getCreatorById(path:headers:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorById"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO","kind":"typeIdentifier","text":"getCreatorById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO","kind":"typeIdentifier","text":"getCreatorById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"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:13MarvelService10OperationsO14getCreatorByIdO","kind":"typeIdentifier","text":"getCreatorById"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO6OutputO","kind":"typeIdentifier","text":"Output"}],"modules":[{"name":"MarvelService"}],"extendedModule":"MarvelService"},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCreatorById/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.getCreatorById.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcreatorbyid\/input","type":"topic"},"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/Operations/getCreatorById":{"abstract":[{"type":"text","text":"Fetches a single creator by id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById","navigatorTitle":[{"kind":"identifier","text":"getCreatorById"}],"title":"Operations.getCreatorById","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCreatorById"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcreatorbyid","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorById/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getCreatorById.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcreatorbyid\/output","type":"topic"},"doc://MarvelService/documentation/MarvelService/Client/getCreatorById(path:headers:)":{"abstract":[{"text":"Fetches a single creator by id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCreatorById(path:headers:)","title":"getCreatorById(path:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCreatorById","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO","kind":"typeIdentifier","text":"getCreatorById"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV","kind":"typeIdentifier","text":"Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCreatorById","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO14getCreatorByIdO6OutputO"}],"kind":"symbol","url":"\/documentation\/marvelservice\/client\/getcreatorbyid(path:headers:)","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorById/Input/Headers-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Input\/Headers-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"title":"Operations.getCreatorById.Input.Headers","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcreatorbyid\/input\/headers-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCreatorById/Input/Path-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCreatorById\/Input\/Path-swift.struct","navigatorTitle":[{"text":"Path","kind":"identifier"}],"title":"Operations.getCreatorById.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcreatorbyid\/input\/path-swift.struct","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/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"}}} |