@postman/sdk-config 0.21.0 → 0.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +220 -253
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +220 -254
- package/dist/index.js.map +1 -1
- package/dist/sdk-config/index.cjs +219 -253
- package/dist/sdk-config/index.cjs.map +1 -1
- package/dist/sdk-config/index.d.cts +1 -1
- package/dist/sdk-config/index.d.ts +1 -1
- package/dist/sdk-config/index.js +219 -253
- package/dist/sdk-config/index.js.map +1 -1
- package/dist/sdk-config/v1/index.cjs +219 -253
- package/dist/sdk-config/v1/index.cjs.map +1 -1
- package/dist/sdk-config/v1/index.d.cts +26 -767
- package/dist/sdk-config/v1/index.d.ts +26 -767
- package/dist/sdk-config/v1/index.js +219 -253
- package/dist/sdk-config/v1/index.js.map +1 -1
- package/dist/sdk-config-ir/index.cjs +34 -150
- package/dist/sdk-config-ir/index.cjs.map +1 -1
- package/dist/sdk-config-ir/index.d.cts +1 -1
- package/dist/sdk-config-ir/index.d.ts +1 -1
- package/dist/sdk-config-ir/index.js +34 -151
- package/dist/sdk-config-ir/index.js.map +1 -1
- package/dist/sdk-config-ir/v1/index.cjs +34 -150
- package/dist/sdk-config-ir/v1/index.cjs.map +1 -1
- package/dist/sdk-config-ir/v1/index.d.cts +38 -446
- package/dist/sdk-config-ir/v1/index.d.ts +38 -446
- package/dist/sdk-config-ir/v1/index.js +34 -151
- package/dist/sdk-config-ir/v1/index.js.map +1 -1
- package/dist/{typescript-DNic6Rq5.d.cts → typescript-BcBGIPrg.d.cts} +30 -21
- package/dist/{typescript-DNic6Rq5.d.ts → typescript-BcBGIPrg.d.ts} +30 -21
- package/package.json +1 -1
- package/src/sdk-config/v1/README.md +12 -24
- package/src/sdk-config-ir/v1/README.md +0 -39
|
@@ -195,9 +195,6 @@ declare const profilesProvisionOperationSchema: z.ZodObject<{
|
|
|
195
195
|
operation: z.ZodString;
|
|
196
196
|
credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
|
|
197
197
|
revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
198
|
-
flag: z.ZodOptional<z.ZodString>;
|
|
199
|
-
parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
200
|
-
profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
201
198
|
}, z.core.$strict>;
|
|
202
199
|
declare const profilesConfigSchema: z.ZodObject<{
|
|
203
200
|
enabled: z.ZodBoolean;
|
|
@@ -207,9 +204,6 @@ declare const profilesConfigSchema: z.ZodObject<{
|
|
|
207
204
|
operation: z.ZodString;
|
|
208
205
|
credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
|
|
209
206
|
revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
210
|
-
flag: z.ZodOptional<z.ZodString>;
|
|
211
|
-
parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
212
|
-
profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
213
207
|
}, z.core.$strict>>;
|
|
214
208
|
}, z.core.$strict>;
|
|
215
209
|
declare const oauthTokenEndpointsSchema: z.ZodObject<{
|
|
@@ -266,24 +260,10 @@ declare const cliGenerationConfigSchema: z.ZodObject<{
|
|
|
266
260
|
operation: z.ZodString;
|
|
267
261
|
credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
|
|
268
262
|
revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
269
|
-
flag: z.ZodOptional<z.ZodString>;
|
|
270
|
-
parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
271
|
-
profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
272
263
|
}, z.core.$strict>>;
|
|
273
264
|
}, z.core.$strict>>;
|
|
274
265
|
splitTypeCrates: z.ZodOptional<z.ZodBoolean>;
|
|
275
266
|
userAgentSuffixFlag: z.ZodOptional<z.ZodString>;
|
|
276
|
-
banner: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
277
|
-
text: z.ZodString;
|
|
278
|
-
colors: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
279
|
-
lineColors: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
280
|
-
direction: z.ZodOptional<z.ZodEnum<{
|
|
281
|
-
horizontal: "horizontal";
|
|
282
|
-
vertical: "vertical";
|
|
283
|
-
diagonal: "diagonal";
|
|
284
|
-
}>>;
|
|
285
|
-
animate: z.ZodOptional<z.ZodBoolean>;
|
|
286
|
-
}, z.core.$strict>]>>;
|
|
287
267
|
oauthTokenEndpoints: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
288
268
|
token: z.ZodOptional<z.ZodObject<{
|
|
289
269
|
requestProperties: z.ZodOptional<z.ZodObject<{
|
|
@@ -386,6 +366,20 @@ declare const mcpToolFilterSchema: z.ZodObject<{
|
|
|
386
366
|
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
387
367
|
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
388
368
|
}, z.core.$strict>;
|
|
369
|
+
/** MCP tool-name pattern, shared by the schema and the Fern config mapper so they can't drift. */
|
|
370
|
+
declare const MCP_TOOL_NAME_PATTERN: RegExp;
|
|
371
|
+
declare const mcpMergedToolSchema: z.ZodObject<{
|
|
372
|
+
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
373
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
374
|
+
dispatchOn: z.ZodString;
|
|
375
|
+
description: z.ZodOptional<z.ZodString>;
|
|
376
|
+
}, z.core.$strict>;
|
|
377
|
+
declare const mcpCustomToolSchema: z.ZodObject<{
|
|
378
|
+
path: z.ZodString;
|
|
379
|
+
}, z.core.$strict>;
|
|
380
|
+
declare const mcpHooksSchema: z.ZodObject<{
|
|
381
|
+
path: z.ZodString;
|
|
382
|
+
}, z.core.$strict>;
|
|
389
383
|
declare const mcpGenerationConfigSchema: z.ZodObject<{
|
|
390
384
|
typescriptVersion: z.ZodOptional<z.ZodString>;
|
|
391
385
|
zodVersion: z.ZodOptional<z.ZodString>;
|
|
@@ -477,9 +471,24 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
|
|
|
477
471
|
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
478
472
|
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
479
473
|
}, z.core.$strict>>>;
|
|
474
|
+
mergedTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
475
|
+
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
476
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
477
|
+
dispatchOn: z.ZodString;
|
|
478
|
+
description: z.ZodOptional<z.ZodString>;
|
|
479
|
+
}, z.core.$strict>>>;
|
|
480
|
+
customTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
481
|
+
path: z.ZodString;
|
|
482
|
+
}, z.core.$strict>>>;
|
|
483
|
+
hooks: z.ZodOptional<z.ZodObject<{
|
|
484
|
+
path: z.ZodString;
|
|
485
|
+
}, z.core.$strict>>;
|
|
480
486
|
}, z.core.$strict>;
|
|
481
487
|
type McpAvailabilityStatus = (typeof mcpAvailabilityStatuses)[number];
|
|
482
488
|
type McpToolFilter = z.infer<typeof mcpToolFilterSchema>;
|
|
489
|
+
type McpMergedTool = z.infer<typeof mcpMergedToolSchema>;
|
|
490
|
+
type McpHooks = z.infer<typeof mcpHooksSchema>;
|
|
491
|
+
type McpCustomTool = z.infer<typeof mcpCustomToolSchema>;
|
|
483
492
|
type McpGenerationConfig = z.infer<typeof mcpGenerationConfigSchema>;
|
|
484
493
|
|
|
485
494
|
declare const phpGenerationConfigSchema: z.ZodObject<{
|
|
@@ -682,4 +691,4 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
|
|
|
682
691
|
}, z.core.$strict>;
|
|
683
692
|
type TypescriptGenerationConfig = z.infer<typeof typescriptGenerationConfigSchema>;
|
|
684
693
|
|
|
685
|
-
export {
|
|
694
|
+
export { packageConfigSchema as $, cliDistributionScoopSchema as A, cliGenerationConfigSchema as B, CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE as C, type Dependency as D, composerPackageNameSchema as E, csharpGenerationConfigSchema as F, type GoGenerationConfig as G, dependencySchema as H, exactSemverSchema as I, type JavaGenerationConfig as J, type KotlinGenerationConfig as K, githubActionsSecretNameSchema as L, MCP_TOOL_NAME_PATTERN as M, goGenerationConfigSchema as N, goModulePathSchema as O, type PackageConfig as P, javaGenerationConfigSchema as Q, type RubyGenerationConfig as R, type SdkConfigDiagnostic as S, type TerraformGenerationConfig as T, jsonObjectSchema as U, jsonValueSchema as V, kotlinGenerationConfigSchema as W, mcpAvailabilityStatuses as X, mcpGenerationConfigSchema as Y, nonEmptyStringSchema as Z, oauthTokenEndpointsIssues as _, type CliDistributionConfig as a, parentRelativePathSchema as a0, phpGenerationConfigSchema as a1, pythonGenerationConfigSchema as a2, relativePathSchema as a3, rubyGenerationConfigSchema as a4, rustGenerationConfigSchema as a5, swiftGenerationConfigSchema as a6, terraformGenerationConfigSchema as a7, typescriptGenerationConfigSchema as a8, type CliDistributionGithubAppConfig as b, type CliDistributionHomebrewConfig as c, type CliDistributionScoopConfig as d, type CliGenerationConfig as e, type CliOAuthTokenEndpoints as f, type CliProfilesConfig as g, type CliProfilesProvisionOperation as h, type CsharpGenerationConfig as i, type JsonObject as j, type JsonValue as k, type McpAvailabilityStatus as l, type McpCustomTool as m, type McpGenerationConfig as n, type McpHooks as o, type McpMergedTool as p, type McpToolFilter as q, type PhpGenerationConfig as r, type PlanModifiers as s, type PythonGenerationConfig as t, type RustGenerationConfig as u, type SwiftGenerationConfig as v, type TypescriptGenerationConfig as w, cliDistributionConfigSchema as x, cliDistributionGithubAppSchema as y, cliDistributionHomebrewSchema as z };
|
|
@@ -195,9 +195,6 @@ declare const profilesProvisionOperationSchema: z.ZodObject<{
|
|
|
195
195
|
operation: z.ZodString;
|
|
196
196
|
credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
|
|
197
197
|
revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
198
|
-
flag: z.ZodOptional<z.ZodString>;
|
|
199
|
-
parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
200
|
-
profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
201
198
|
}, z.core.$strict>;
|
|
202
199
|
declare const profilesConfigSchema: z.ZodObject<{
|
|
203
200
|
enabled: z.ZodBoolean;
|
|
@@ -207,9 +204,6 @@ declare const profilesConfigSchema: z.ZodObject<{
|
|
|
207
204
|
operation: z.ZodString;
|
|
208
205
|
credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
|
|
209
206
|
revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
210
|
-
flag: z.ZodOptional<z.ZodString>;
|
|
211
|
-
parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
212
|
-
profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
213
207
|
}, z.core.$strict>>;
|
|
214
208
|
}, z.core.$strict>;
|
|
215
209
|
declare const oauthTokenEndpointsSchema: z.ZodObject<{
|
|
@@ -266,24 +260,10 @@ declare const cliGenerationConfigSchema: z.ZodObject<{
|
|
|
266
260
|
operation: z.ZodString;
|
|
267
261
|
credential: z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>;
|
|
268
262
|
revokeParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
269
|
-
flag: z.ZodOptional<z.ZodString>;
|
|
270
|
-
parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
271
|
-
profileParameters: z.ZodOptional<z.ZodType<Record<string, string>, unknown, z.core.$ZodTypeInternals<Record<string, string>, unknown>>>;
|
|
272
263
|
}, z.core.$strict>>;
|
|
273
264
|
}, z.core.$strict>>;
|
|
274
265
|
splitTypeCrates: z.ZodOptional<z.ZodBoolean>;
|
|
275
266
|
userAgentSuffixFlag: z.ZodOptional<z.ZodString>;
|
|
276
|
-
banner: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
277
|
-
text: z.ZodString;
|
|
278
|
-
colors: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
279
|
-
lineColors: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
280
|
-
direction: z.ZodOptional<z.ZodEnum<{
|
|
281
|
-
horizontal: "horizontal";
|
|
282
|
-
vertical: "vertical";
|
|
283
|
-
diagonal: "diagonal";
|
|
284
|
-
}>>;
|
|
285
|
-
animate: z.ZodOptional<z.ZodBoolean>;
|
|
286
|
-
}, z.core.$strict>]>>;
|
|
287
267
|
oauthTokenEndpoints: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
288
268
|
token: z.ZodOptional<z.ZodObject<{
|
|
289
269
|
requestProperties: z.ZodOptional<z.ZodObject<{
|
|
@@ -386,6 +366,20 @@ declare const mcpToolFilterSchema: z.ZodObject<{
|
|
|
386
366
|
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
387
367
|
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
388
368
|
}, z.core.$strict>;
|
|
369
|
+
/** MCP tool-name pattern, shared by the schema and the Fern config mapper so they can't drift. */
|
|
370
|
+
declare const MCP_TOOL_NAME_PATTERN: RegExp;
|
|
371
|
+
declare const mcpMergedToolSchema: z.ZodObject<{
|
|
372
|
+
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
373
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
374
|
+
dispatchOn: z.ZodString;
|
|
375
|
+
description: z.ZodOptional<z.ZodString>;
|
|
376
|
+
}, z.core.$strict>;
|
|
377
|
+
declare const mcpCustomToolSchema: z.ZodObject<{
|
|
378
|
+
path: z.ZodString;
|
|
379
|
+
}, z.core.$strict>;
|
|
380
|
+
declare const mcpHooksSchema: z.ZodObject<{
|
|
381
|
+
path: z.ZodString;
|
|
382
|
+
}, z.core.$strict>;
|
|
389
383
|
declare const mcpGenerationConfigSchema: z.ZodObject<{
|
|
390
384
|
typescriptVersion: z.ZodOptional<z.ZodString>;
|
|
391
385
|
zodVersion: z.ZodOptional<z.ZodString>;
|
|
@@ -477,9 +471,24 @@ declare const mcpGenerationConfigSchema: z.ZodObject<{
|
|
|
477
471
|
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
478
472
|
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
479
473
|
}, z.core.$strict>>>;
|
|
474
|
+
mergedTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
475
|
+
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
476
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
477
|
+
dispatchOn: z.ZodString;
|
|
478
|
+
description: z.ZodOptional<z.ZodString>;
|
|
479
|
+
}, z.core.$strict>>>;
|
|
480
|
+
customTools: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
481
|
+
path: z.ZodString;
|
|
482
|
+
}, z.core.$strict>>>;
|
|
483
|
+
hooks: z.ZodOptional<z.ZodObject<{
|
|
484
|
+
path: z.ZodString;
|
|
485
|
+
}, z.core.$strict>>;
|
|
480
486
|
}, z.core.$strict>;
|
|
481
487
|
type McpAvailabilityStatus = (typeof mcpAvailabilityStatuses)[number];
|
|
482
488
|
type McpToolFilter = z.infer<typeof mcpToolFilterSchema>;
|
|
489
|
+
type McpMergedTool = z.infer<typeof mcpMergedToolSchema>;
|
|
490
|
+
type McpHooks = z.infer<typeof mcpHooksSchema>;
|
|
491
|
+
type McpCustomTool = z.infer<typeof mcpCustomToolSchema>;
|
|
483
492
|
type McpGenerationConfig = z.infer<typeof mcpGenerationConfigSchema>;
|
|
484
493
|
|
|
485
494
|
declare const phpGenerationConfigSchema: z.ZodObject<{
|
|
@@ -682,4 +691,4 @@ declare const typescriptGenerationConfigSchema: z.ZodObject<{
|
|
|
682
691
|
}, z.core.$strict>;
|
|
683
692
|
type TypescriptGenerationConfig = z.infer<typeof typescriptGenerationConfigSchema>;
|
|
684
693
|
|
|
685
|
-
export {
|
|
694
|
+
export { packageConfigSchema as $, cliDistributionScoopSchema as A, cliGenerationConfigSchema as B, CLI_DISTRIBUTION_NON_RELEASE_MODE_CODE as C, type Dependency as D, composerPackageNameSchema as E, csharpGenerationConfigSchema as F, type GoGenerationConfig as G, dependencySchema as H, exactSemverSchema as I, type JavaGenerationConfig as J, type KotlinGenerationConfig as K, githubActionsSecretNameSchema as L, MCP_TOOL_NAME_PATTERN as M, goGenerationConfigSchema as N, goModulePathSchema as O, type PackageConfig as P, javaGenerationConfigSchema as Q, type RubyGenerationConfig as R, type SdkConfigDiagnostic as S, type TerraformGenerationConfig as T, jsonObjectSchema as U, jsonValueSchema as V, kotlinGenerationConfigSchema as W, mcpAvailabilityStatuses as X, mcpGenerationConfigSchema as Y, nonEmptyStringSchema as Z, oauthTokenEndpointsIssues as _, type CliDistributionConfig as a, parentRelativePathSchema as a0, phpGenerationConfigSchema as a1, pythonGenerationConfigSchema as a2, relativePathSchema as a3, rubyGenerationConfigSchema as a4, rustGenerationConfigSchema as a5, swiftGenerationConfigSchema as a6, terraformGenerationConfigSchema as a7, typescriptGenerationConfigSchema as a8, type CliDistributionGithubAppConfig as b, type CliDistributionHomebrewConfig as c, type CliDistributionScoopConfig as d, type CliGenerationConfig as e, type CliOAuthTokenEndpoints as f, type CliProfilesConfig as g, type CliProfilesProvisionOperation as h, type CsharpGenerationConfig as i, type JsonObject as j, type JsonValue as k, type McpAvailabilityStatus as l, type McpCustomTool as m, type McpGenerationConfig as n, type McpHooks as o, type McpMergedTool as p, type McpToolFilter as q, type PhpGenerationConfig as r, type PlanModifiers as s, type PythonGenerationConfig as t, type RustGenerationConfig as u, type SwiftGenerationConfig as v, type TypescriptGenerationConfig as w, cliDistributionConfigSchema as x, cliDistributionGithubAppSchema as y, cliDistributionHomebrewSchema as z };
|
package/package.json
CHANGED
|
@@ -482,16 +482,8 @@ targets:
|
|
|
482
482
|
operation: iam.keys.create
|
|
483
483
|
credential: { username: sid, password: secret }
|
|
484
484
|
revokeParameters: { Sid: sid }
|
|
485
|
-
flag: api-key
|
|
486
|
-
parameters: { FriendlyName: '{cli} for {user} on {host}' }
|
|
487
|
-
profileParameters: { AccountSid: username }
|
|
488
485
|
splitTypeCrates: true
|
|
489
486
|
userAgentSuffixFlag: via
|
|
490
|
-
banner:
|
|
491
|
-
text: ACME
|
|
492
|
-
colors: ['#2929CC', '#30F2B1']
|
|
493
|
-
direction: diagonal
|
|
494
|
-
animate: true
|
|
495
487
|
```
|
|
496
488
|
|
|
497
489
|
Omitted settings stay omitted in both SDK Config and IR. The CLI generator then applies the
|
|
@@ -499,22 +491,18 @@ default shown below. Fern migration copies these keys verbatim from the CLI gene
|
|
|
499
491
|
A legacy `profiles` block without `enabled` migrates as `enabled: false`. A legacy value this schema
|
|
500
492
|
rejects is left out and reported as `FERN_CONFIG_VALUE_INVALID`.
|
|
501
493
|
|
|
502
|
-
| Setting
|
|
503
|
-
|
|
|
504
|
-
| `binaryName`
|
|
505
|
-
| `crateName`
|
|
506
|
-
| `customCommands`
|
|
507
|
-
| `rootGroup`
|
|
508
|
-
| `profiles.enabled`
|
|
509
|
-
| `profiles.commandName`
|
|
510
|
-
| `profiles.revokeOperation`
|
|
511
|
-
| `profiles.provisionOperation`
|
|
512
|
-
| `
|
|
513
|
-
| `
|
|
514
|
-
| `profiles.provisionOperation.profileParameters` | Maps each profile parameter to the typed credential field it is copied from, so requests keep it once the credential is replaced by the provisioned key. | Keys and values match `^[A-Za-z0-9_.-]+$`. | None |
|
|
515
|
-
| `splitTypeCrates` | Splits generated types into one crate per API behind a facade crate. | Boolean | `false` |
|
|
516
|
-
| `userAgentSuffixFlag` | Long flag that appends a product token to the User-Agent. The environment variable is `<BINARY>_<FLAG>`, with hyphens changed to underscores. | `^[a-z][a-z0-9-]*$` without the leading `--`. Built-in global flag names such as `help` and `base-url` are rejected. | `user-agent-suffix` |
|
|
517
|
-
| `banner` | Banner printed above root `--help`: a string, or `text` with `colors` (one colour is solid, several make a gradient along `direction`), `lineColors` (one colour per line) and `animate` (a short shimmer on an interactive terminal). | `text` is non-empty. Colours are `#RRGGBB`. `colors` and `lineColors` are exclusive. `direction` is `horizontal`, `vertical` or `diagonal`. | No banner |
|
|
494
|
+
| Setting | Behavior | Validation | Generator default when omitted |
|
|
495
|
+
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
|
|
496
|
+
| `binaryName` | Executable name. The generator kebab-cases it (`Acme CLI` becomes `acme-cli`) and uses the result for the Cargo binary, the CLI source directory, the runtime app name, and the fallback environment-variable prefix. | Non-empty string with at least one ASCII letter or digit, since the generator rejects names that kebab-case to empty. | Kebab-cased API display name |
|
|
497
|
+
| `crateName` | Name of the generated Cargo package, which release archives and installers (`<name>-installer.sh`) are named after. Defaults to the binary name when the output is delivered to GitHub. | Cargo package name: starts with a letter, then letters, digits, `-` or `_`, at most 64 characters. |
|
|
498
|
+
| `customCommands` | Generates hand-written command support: the model and SDK crates, `sdk.rs`, and `custom.rs`. | Boolean | `true` |
|
|
499
|
+
| `rootGroup` | Nests every spec-derived command under one group, so `acme users list` becomes `acme api users list`. | `^[a-z][a-z0-9_-]*$` | No group |
|
|
500
|
+
| `profiles.enabled` | Emits the profile command group and the global `--profile` / `-p` flag. Profiles store per-profile credentials and request defaults. | Required boolean when `profiles` is present, following the SDK Config convention for feature objects. The generator itself treats a missing `enabled` as `false`. | Profiles off |
|
|
501
|
+
| `profiles.commandName` | Name of the profile command group. | `^[a-z][a-z0-9-]*$`, excluding `auth`, `completion`, `man`, `errors`, `generate-skills`, and `help` | `profiles` |
|
|
502
|
+
| `profiles.revokeOperation` | Operation that `profiles remove --revoke` calls. | Dotted command path, such as `iam.keys.remove` | No `--revoke` flag |
|
|
503
|
+
| `profiles.provisionOperation` | Operation that `profiles create --provision` calls, and how its response fills the stored credential. | `operation` is a required dotted path. `credential` maps at least one field. Map keys and values match `^[A-Za-z0-9_.-]+$`. | No `--provision` flag |
|
|
504
|
+
| `splitTypeCrates` | Splits generated types into one crate per API behind a facade crate. | Boolean | `false` |
|
|
505
|
+
| `userAgentSuffixFlag` | Long flag that appends a product token to the User-Agent. The environment variable is `<BINARY>_<FLAG>`, with hyphens changed to underscores. | `^[a-z][a-z0-9-]*$` without the leading `--`. Built-in global flag names such as `help` and `base-url` are rejected. | `user-agent-suffix` |
|
|
518
506
|
|
|
519
507
|
## Precedence
|
|
520
508
|
|
|
@@ -379,29 +379,6 @@ than generated-language presentation.
|
|
|
379
379
|
| `path-parameter-order` | `pathParameterOrder` | 2 |
|
|
380
380
|
| `type-dates-as-strings` | `typeDatesAsStrings` | 12 |
|
|
381
381
|
| `default-integer-format` | `defaultIntegerFormat` | Importer defaults to `int32`. |
|
|
382
|
-
| `respect-per-spec-base-path` | `respectPerSpecBasePath` | Not in the project snapshot; see below. |
|
|
383
|
-
| `error-responses` | `errorResponses` | Not in the project snapshot; see below. |
|
|
384
|
-
| `additional-properties-defaults-to` | `additionalPropertiesDefaultsTo` | Not in the project snapshot; see below. |
|
|
385
|
-
| `optional-additional-properties` | `optionalAdditionalProperties` | Not in the project snapshot; see below. |
|
|
386
|
-
| `any-of-sibling-properties-as-object` | `anyOfSiblingPropertiesAsObject` | Not in the project snapshot; see below. |
|
|
387
|
-
| `preserve-single-schema-oneof` | `preserveSingleSchemaOneOf` | Not in the project snapshot; see below. |
|
|
388
|
-
| `preserve-one-of-in-all-of` | `preserveOneOfInAllOf` | Not in the project snapshot; see below. |
|
|
389
|
-
| `remove-discriminants-from-schemas` | `removeDiscriminantsFromSchemas` | Not in the project snapshot; see below. |
|
|
390
|
-
| `coerce-consts-to` | `coerceConstsTo` | Not in the project snapshot; see below. |
|
|
391
|
-
| `resolve-aliases` | `resolveAliases` | Not in the project snapshot; see below. |
|
|
392
|
-
| `respect-forward-compatible-enums` | `respectForwardCompatibleEnums` | Not in the project snapshot; see below. |
|
|
393
|
-
| `infer-forward-compatible` | `inferForwardCompatible` | Not in the project snapshot; see below. |
|
|
394
|
-
| `respect-operation-id-word-boundaries` | `respectOperationIdWordBoundaries` | Not in the project snapshot; see below. |
|
|
395
|
-
| `namespaced-errors` | `namespacedErrors` | Not in the project snapshot; see below. |
|
|
396
|
-
| `default-form-parameter-encoding` | `defaultFormParameterEncoding` | Not in the project snapshot; see below. |
|
|
397
|
-
| `respect-parameter-content` | `respectParameterContent` | Not in the project snapshot; see below. |
|
|
398
|
-
| `use-bytes-for-binary-response` | `useBytesForBinaryResponse` | Not in the project snapshot; see below. |
|
|
399
|
-
| `use-read-variant-for-responses` | `useReadVariantForResponses` | Not in the project snapshot; see below. |
|
|
400
|
-
| `example-generation` | `exampleGeneration` | Not in the project snapshot; see below. |
|
|
401
|
-
| `filter` | `filter` | Not in the project snapshot; see below. |
|
|
402
|
-
| `group-environments-by-host` | `groupEnvironmentsByHost` | Not in the project snapshot; see below. |
|
|
403
|
-
| `multi-server-strategy` | `multiServerStrategy` | Not in the project snapshot; see below. |
|
|
404
|
-
| `infer-default-environment` | `inferDefaultEnvironment` | Not in the project snapshot; see below. |
|
|
405
382
|
|
|
406
383
|
`ignoreTags` and `disambiguateRequestNames` postdate the project snapshot. Twilio declares both
|
|
407
384
|
across its namespaced API specs. They stay undefaulted so omission remains distinguishable from an
|
|
@@ -436,22 +413,6 @@ importer default, which blocks the declaring customer from a post-cutover genera
|
|
|
436
413
|
names AsyncAPI messages, but the importer resolves it as part of one shared settings object, so a
|
|
437
414
|
project's OpenAPI specs carry it too and are refused for it.
|
|
438
415
|
|
|
439
|
-
`respectPerSpecBasePath` and `errorResponses` serve the CLI generator's parity with Fern. Both stay
|
|
440
|
-
undefaulted. `respectPerSpecBasePath` applies each document's plain `x-fern-base-path` to that
|
|
441
|
-
document's endpoints. `errorResponses` is Fern's `error-responses` with the keys camel-cased
|
|
442
|
-
(`apply-to` is `applyTo`, `status-code` is `statusCode`). Its `schema` is the schema object itself:
|
|
443
|
-
Fern also accepts a path relative to `generators.yml`, which no service can read, so the client
|
|
444
|
-
resolves the file and sends its content. The same holds for a CLI `banner` read from a file: the
|
|
445
|
-
client sends its `text`.
|
|
446
|
-
|
|
447
|
-
The remaining Fern import settings (`additionalPropertiesDefaultsTo` through `inferDefaultEnvironment` in the table above)
|
|
448
|
-
complete the set Fern's `getAPIDefinitionSettings` maps, so a config that declares one is no longer refused. All stay
|
|
449
|
-
undefaulted: absent must leave an existing SDK's shapes alone, and the generator applies Fern's own default. Fern's
|
|
450
|
-
`shared-error-responses` is not a setting: it is derived from `errorResponses` set API-wide, and the generator derives it
|
|
451
|
-
the same way. `resolveAliases` takes `true`, `false` or `{ except: [...] }`; `exampleGeneration` and `filter` are objects
|
|
452
|
-
with the keys camel-cased (`maxDepth`, `endpoints`). This reverses the earlier removal of environment grouping and
|
|
453
|
-
default-environment inference: both are modeled again because Fern still reads them.
|
|
454
|
-
|
|
455
416
|
## Fern language-specific migration map
|
|
456
417
|
|
|
457
418
|
Only options that remain language-specific stay in `generation.language`.
|