Migrating from LaunchPad's preview
Chirograph is extracted from the OpenAPI clients of LaunchPad’s MSBuild SDK, which were never released (LaunchPad#3238). If you tried that preview, this page is the list of what to rename. LaunchPad’s SDK will chain Chirograph rather than carry its own copy, so a LaunchPad application gets Chirograph through LaunchPad.
What stays the same
Section titled “What stays the same”- The
OpenApiClientitem and all its metadata:Generator,ClientName,Namespace,DocumentName,DocumentCache,UpdateDocumentCacheandOptions. - The three sources, and how they are inferred from
Include. - The configuration key,
Clients:<ClientName>:BaseAddress. - Where the code goes:
obj/<configuration>/<framework>/openapi/<ClientName>/.
Renames
Section titled “Renames”Properties and the target hook lose the LaunchPad prefix for Chirograph. Diagnostic codes keep their last digits, so the search
and replace is mechanical.
| LaunchPad preview | Chirograph |
|---|---|
LaunchPadUpdateOpenApiDocumentCache |
ChirographUpdateOpenApiDocumentCache |
LaunchPadOpenApiClientsDirectory |
ChirographOpenApiClientsDirectory |
LaunchPadKiotaVersion |
ChirographKiotaVersion |
LaunchPadRefitterVersion |
ChirographRefitterVersion |
LaunchPadKiotaBundleVersion |
ChirographKiotaBundleVersion |
LaunchPadRefitVersion |
ChirographRefitVersion |
LaunchPadMicrosoftExtensionsHttpVersion |
ChirographMicrosoftExtensionsHttpVersion |
LaunchPadGenerateOpenApiClients target |
ChirographGenerateOpenApiClients target |
LPSDK0100 |
CHIRO100 |
LPSDK0101 |
CHIRO101 |
LPSDK0102 |
CHIRO102 |
LPSDK0103 |
CHIRO103 |
LPSDK0104 |
CHIRO104 |
LPSDK0105 |
CHIRO105 |
LPSDK0106 |
CHIRO106 |
LPSDK0107 |
CHIRO107 |
CHIRO107 (the generator failed) existed in the preview as LPSDK0107, but wasn’t documented.
What changed
Section titled “What changed”- Registration. The preview generated a joint for each client, which needed Dovetail. Chirograph generates a public
Add<ClientName>()extension onIServiceCollectioninstead, which works without Dovetail, and with a recent Dovetail declares the joint that calls it: see With Dovetail. Microsoft.Extensions.Httpis added for Kiota clients only, and not at all in a project that also has a Refitter client.Refit.HttpClientFactorybrings its own, and the packed version could be older than that one (NU1605, a downgrade). The preview added it for both.- Telemetry. The preview set environment variables Kiota doesn’t read. Chirograph sets
KIOTA_CLI_TELEMETRY_OPTOUT,KIOTA_OFFLINE_ENABLEDandDOTNET_CLI_TELEMETRY_OPTOUT, so Kiota’s telemetry and update check are really off. GeneratedCode. The registration is stamped with Chirograph’s version, not a fixed1.0.0.- A server with several target frameworks is built as a whole and writes its document from its own outer build, rather than from its first target framework, so it works whichever frameworks the client targets.
dotnet cleanremoves the generated code and the stamp that marks it up to date, so the next build generates it again.