@typeship-ax/cli 0.8.0 → 0.9.1
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/AGENTS.md +31 -0
- package/README.md +26 -9
- package/api.json +1875 -684
- package/api.md +352 -500
- package/dist/api-identity.d.ts +40 -0
- package/dist/api-identity.d.ts.map +1 -0
- package/dist/api-identity.js +128 -0
- package/dist/auth-profiles.d.ts +30 -0
- package/dist/auth-profiles.d.ts.map +1 -0
- package/dist/auth-profiles.js +138 -0
- package/dist/cli.js +522 -355
- package/dist/console-login-check.d.ts +21 -0
- package/dist/console-login-check.d.ts.map +1 -0
- package/dist/console-login-check.js +107 -0
- package/dist/console-login-contract.d.ts +45 -0
- package/dist/console-login-contract.d.ts.map +1 -0
- package/dist/console-login-contract.js +40 -0
- package/dist/core/http.d.ts +17 -2
- package/dist/core/http.d.ts.map +1 -1
- package/dist/core/http.js +78 -17
- package/dist/credential-storage.d.ts +24 -0
- package/dist/credential-storage.d.ts.map +1 -0
- package/dist/credential-storage.js +207 -0
- package/dist/docs.d.ts +25 -0
- package/dist/docs.d.ts.map +1 -1
- package/dist/docs.js +144 -0
- package/dist/errors.d.ts +18 -10
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +24 -14
- package/dist/index.d.ts +10 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -4
- package/dist/named-credentials.d.ts +21 -0
- package/dist/named-credentials.d.ts.map +1 -0
- package/dist/named-credentials.js +86 -0
- package/dist/oauth-login.d.ts +39 -0
- package/dist/oauth-login.d.ts.map +1 -0
- package/dist/oauth-login.js +171 -0
- package/dist/oauth-request.d.ts +21 -0
- package/dist/oauth-request.d.ts.map +1 -0
- package/dist/oauth-request.js +119 -0
- package/dist/oauth-session.d.ts +106 -0
- package/dist/oauth-session.d.ts.map +1 -0
- package/dist/oauth-session.js +244 -0
- package/dist/ops.d.ts +14 -1
- package/dist/ops.d.ts.map +1 -1
- package/dist/ops.js +30 -30
- package/dist/polling-login.d.ts +57 -0
- package/dist/polling-login.d.ts.map +1 -0
- package/dist/polling-login.js +204 -0
- package/dist/resources/account.d.ts +2 -2
- package/dist/resources/account.d.ts.map +1 -1
- package/dist/resources/account.js +1 -0
- package/dist/resources/api-keys.d.ts +3 -3
- package/dist/resources/api-keys.d.ts.map +1 -1
- package/dist/resources/api-keys.js +2 -0
- package/dist/resources/definition-revisions.d.ts +5 -5
- package/dist/resources/definition-revisions.d.ts.map +1 -1
- package/dist/resources/definition-revisions.js +4 -0
- package/dist/resources/definitions.d.ts +15 -4
- package/dist/resources/definitions.d.ts.map +1 -1
- package/dist/resources/definitions.js +11 -2
- package/dist/resources/generate.d.ts +14 -3
- package/dist/resources/generate.d.ts.map +1 -1
- package/dist/resources/generate.js +10 -2
- package/dist/resources/generations.d.ts +3 -3
- package/dist/resources/generations.d.ts.map +1 -1
- package/dist/resources/generations.js +2 -0
- package/dist/resources/projects.d.ts +56 -20
- package/dist/resources/projects.d.ts.map +1 -1
- package/dist/resources/projects.js +40 -4
- package/dist/resources/targets.d.ts +20 -9
- package/dist/resources/targets.d.ts.map +1 -1
- package/dist/resources/targets.js +14 -1
- package/dist/schemas.d.ts.map +1 -1
- package/dist/schemas.js +38 -22
- package/dist/types.d.ts +385 -119
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +11 -0
- package/package.json +2 -1
- package/src/api-identity.ts +98 -0
- package/src/auth-profiles.ts +114 -0
- package/src/cli.ts +444 -332
- package/src/console-login-check.ts +88 -0
- package/src/console-login-contract.ts +65 -0
- package/src/core/http.ts +88 -19
- package/src/credential-storage.ts +183 -0
- package/src/docs.ts +138 -0
- package/src/errors.ts +26 -15
- package/src/index.ts +29 -4
- package/src/named-credentials.ts +74 -0
- package/src/oauth-login.ts +184 -0
- package/src/oauth-request.ts +90 -0
- package/src/oauth-session.ts +258 -0
- package/src/ops.ts +44 -31
- package/src/polling-login.ts +165 -0
- package/src/resources/account.ts +3 -0
- package/src/resources/api-keys.ts +5 -0
- package/src/resources/definition-revisions.ts +9 -0
- package/src/resources/definitions.ts +25 -0
- package/src/resources/generate.ts +23 -0
- package/src/resources/generations.ts +5 -0
- package/src/resources/projects.ts +95 -7
- package/src/resources/targets.ts +32 -0
- package/src/schemas.ts +38 -22
- package/src/types.ts +404 -119
package/api.json
CHANGED
|
@@ -4,20 +4,84 @@
|
|
|
4
4
|
"api_version": "1.0.0",
|
|
5
5
|
"spec_format": "openapi",
|
|
6
6
|
"language": "TypeScript",
|
|
7
|
+
"surface": "cli",
|
|
7
8
|
"operations": [
|
|
8
9
|
{
|
|
9
10
|
"operation": "generate.run",
|
|
10
|
-
"signature": "
|
|
11
|
+
"signature": "typeship generate run [flags]",
|
|
12
|
+
"command": [
|
|
13
|
+
"typeship",
|
|
14
|
+
"generate",
|
|
15
|
+
"run"
|
|
16
|
+
],
|
|
17
|
+
"parameters": [
|
|
18
|
+
{
|
|
19
|
+
"name": "definition",
|
|
20
|
+
"flag": "--definition",
|
|
21
|
+
"in": "body",
|
|
22
|
+
"type": "json",
|
|
23
|
+
"required": true
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"name": "target",
|
|
27
|
+
"flag": "--target",
|
|
28
|
+
"in": "body",
|
|
29
|
+
"type": "object",
|
|
30
|
+
"required": true
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "package_name",
|
|
34
|
+
"flag": "--package-name",
|
|
35
|
+
"in": "body",
|
|
36
|
+
"type": "string",
|
|
37
|
+
"required": false
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "module_path",
|
|
41
|
+
"flag": "--module-path",
|
|
42
|
+
"in": "body",
|
|
43
|
+
"type": "string",
|
|
44
|
+
"required": false
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "config",
|
|
48
|
+
"flag": "--config",
|
|
49
|
+
"in": "body",
|
|
50
|
+
"type": "object",
|
|
51
|
+
"required": false
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "Idempotency-Key",
|
|
55
|
+
"flag": "--idempotency-key",
|
|
56
|
+
"in": "header",
|
|
57
|
+
"type": "string",
|
|
58
|
+
"required": false
|
|
59
|
+
}
|
|
60
|
+
],
|
|
61
|
+
"example_command": "typeship generate run --definition '{\"url\":\"https://example.com\"}' --target '{\"generator\":\"typescript-sdk\"}'",
|
|
11
62
|
"method": "POST",
|
|
12
63
|
"path": "/generate",
|
|
13
64
|
"summary": "Generate one Target from a Definition",
|
|
14
65
|
"description": "Stateless generation: nothing is stored. Returns the full generated\npackage as files. Works without an API key: anonymous calls generate\nthe first 25 operations, rate limited per IP address, and the\nresponse's `limits` object says what was held back and where to lift\nit; anonymous calls from a Definition URL also carry `claim.url`, a link\nthat turns the run into a project once a person signs in. With a key, the free plan generates the first 25 operations and\npaid plans generate the complete Definition. A present but invalid key is a\n401, not a downgrade to anonymous.",
|
|
15
66
|
"safety": "write",
|
|
16
67
|
"auth": "optional",
|
|
68
|
+
"security": [
|
|
69
|
+
{},
|
|
70
|
+
{
|
|
71
|
+
"apiKey": []
|
|
72
|
+
}
|
|
73
|
+
],
|
|
17
74
|
"paginated": false,
|
|
18
75
|
"input_schema": {
|
|
19
76
|
"type": "object",
|
|
20
77
|
"properties": {
|
|
78
|
+
"Idempotency-Key": {
|
|
79
|
+
"minLength": 1,
|
|
80
|
+
"maxLength": 255,
|
|
81
|
+
"pattern": "^[!-~]+$",
|
|
82
|
+
"type": "string",
|
|
83
|
+
"description": "Identifies one logical write for 24 hours. The key is scoped to the authenticated account and operation; account-less generation uses a hashed network identity. Retrying the same method, path, query, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write."
|
|
84
|
+
},
|
|
21
85
|
"definition": {
|
|
22
86
|
"description": "A Definition for stateless generation, provided as exactly one URL or inline entrypoint.",
|
|
23
87
|
"anyOf": [
|
|
@@ -89,7 +153,7 @@
|
|
|
89
153
|
"type": "string"
|
|
90
154
|
},
|
|
91
155
|
"config": {
|
|
92
|
-
"description": "Everything Typeship needs beyond the Definition, in one object: generation customization (globals, retries, pagination) and how the generated tooling behaves (cli, mcp, package, docs_url). Plain configuration. Typeship never requires vendor extensions inside the Definition itself. Stateless generation also accepts GraphQL settings here; stored projects keep those settings on their Definition.",
|
|
156
|
+
"description": "Everything Typeship needs beyond the Definition, in one object: generation customization (globals, retries, pagination, readme) and how the generated tooling behaves (cli, mcp, package, docs_url). Plain configuration. Typeship never requires vendor extensions inside the Definition itself. Stateless generation also accepts GraphQL settings here; stored projects keep those settings on their Definition.",
|
|
93
157
|
"properties": {
|
|
94
158
|
"globals": {
|
|
95
159
|
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-apply to every operation that accepts them; per-call values win. Names that match nothing are reported as generation warnings.",
|
|
@@ -265,40 +329,256 @@
|
|
|
265
329
|
"additionalProperties": false,
|
|
266
330
|
"type": "object"
|
|
267
331
|
},
|
|
268
|
-
"
|
|
269
|
-
"description": "
|
|
332
|
+
"auth": {
|
|
333
|
+
"description": "Public authentication defaults for generated clients and tools. Stored Projects own the OAuth server, application catalog, and identity policy; stateless generation accepts the same shape for one run. Runtime credentials and client secrets are never accepted.",
|
|
270
334
|
"properties": {
|
|
271
|
-
"
|
|
272
|
-
"
|
|
335
|
+
"oauth_server": {
|
|
336
|
+
"anyOf": [
|
|
337
|
+
{
|
|
338
|
+
"description": "Authorization-server metadata used by generated OAuth flows. Secrets and runtime credentials are never accepted here.",
|
|
339
|
+
"properties": {
|
|
340
|
+
"issuer": {
|
|
341
|
+
"format": "uri",
|
|
342
|
+
"description": "Exact authorization-server issuer, including any tenant path.",
|
|
343
|
+
"type": [
|
|
344
|
+
"string",
|
|
345
|
+
"null"
|
|
346
|
+
]
|
|
347
|
+
},
|
|
348
|
+
"discovery_url": {
|
|
349
|
+
"format": "uri",
|
|
350
|
+
"description": "Exact metadata URL when it cannot be derived from the issuer.",
|
|
351
|
+
"type": [
|
|
352
|
+
"string",
|
|
353
|
+
"null"
|
|
354
|
+
]
|
|
355
|
+
},
|
|
356
|
+
"authorization_url": {
|
|
357
|
+
"format": "uri",
|
|
358
|
+
"description": "Authorization endpoint override.",
|
|
359
|
+
"type": [
|
|
360
|
+
"string",
|
|
361
|
+
"null"
|
|
362
|
+
]
|
|
363
|
+
},
|
|
364
|
+
"token_url": {
|
|
365
|
+
"format": "uri",
|
|
366
|
+
"description": "Token endpoint override.",
|
|
367
|
+
"type": [
|
|
368
|
+
"string",
|
|
369
|
+
"null"
|
|
370
|
+
]
|
|
371
|
+
},
|
|
372
|
+
"device_authorization_url": {
|
|
373
|
+
"format": "uri",
|
|
374
|
+
"description": "Device-authorization endpoint override.",
|
|
375
|
+
"type": [
|
|
376
|
+
"string",
|
|
377
|
+
"null"
|
|
378
|
+
]
|
|
379
|
+
},
|
|
380
|
+
"scopes": {
|
|
381
|
+
"description": "Default scopes requested during login.",
|
|
382
|
+
"maxItems": 20,
|
|
383
|
+
"type": [
|
|
384
|
+
"array",
|
|
385
|
+
"null"
|
|
386
|
+
]
|
|
387
|
+
},
|
|
388
|
+
"audience": {
|
|
389
|
+
"description": "Default audience included in authorization and token requests.",
|
|
390
|
+
"type": [
|
|
391
|
+
"string",
|
|
392
|
+
"null"
|
|
393
|
+
]
|
|
394
|
+
},
|
|
395
|
+
"resource": {
|
|
396
|
+
"format": "uri",
|
|
397
|
+
"description": "Protected API resource included in authorization and token requests.",
|
|
398
|
+
"type": [
|
|
399
|
+
"string",
|
|
400
|
+
"null"
|
|
401
|
+
]
|
|
402
|
+
}
|
|
403
|
+
},
|
|
404
|
+
"additionalProperties": false,
|
|
405
|
+
"type": "object"
|
|
406
|
+
},
|
|
407
|
+
{
|
|
408
|
+
"type": "null"
|
|
409
|
+
}
|
|
410
|
+
]
|
|
411
|
+
},
|
|
412
|
+
"oauth_applications": {
|
|
413
|
+
"description": "OAuth applications keyed by a stable name.",
|
|
414
|
+
"additionalProperties": {
|
|
415
|
+
"description": "OAuth application available to generated products. Public clients support interactive login; confidential clients support runtime-supplied machine credentials. Client secrets are never stored.",
|
|
416
|
+
"properties": {
|
|
417
|
+
"client_id": {
|
|
418
|
+
"description": "OAuth client identifier.",
|
|
419
|
+
"minLength": 1,
|
|
420
|
+
"maxLength": 200,
|
|
421
|
+
"type": "string"
|
|
422
|
+
},
|
|
423
|
+
"login_method": {
|
|
424
|
+
"enum": [
|
|
425
|
+
"browser",
|
|
426
|
+
"device",
|
|
427
|
+
null
|
|
428
|
+
],
|
|
429
|
+
"description": "Interactive login method. Browser login uses Authorization Code with PKCE.",
|
|
430
|
+
"type": [
|
|
431
|
+
"string",
|
|
432
|
+
"null"
|
|
433
|
+
]
|
|
434
|
+
},
|
|
435
|
+
"client_auth_method": {
|
|
436
|
+
"enum": [
|
|
437
|
+
"post",
|
|
438
|
+
"basic",
|
|
439
|
+
null
|
|
440
|
+
],
|
|
441
|
+
"description": "How a runtime-supplied client secret is sent for machine grants.",
|
|
442
|
+
"type": [
|
|
443
|
+
"string",
|
|
444
|
+
"null"
|
|
445
|
+
]
|
|
446
|
+
},
|
|
447
|
+
"redirect_uri": {
|
|
448
|
+
"format": "uri",
|
|
449
|
+
"description": "Loopback callback URL for browser login.",
|
|
450
|
+
"type": [
|
|
451
|
+
"string",
|
|
452
|
+
"null"
|
|
453
|
+
]
|
|
454
|
+
},
|
|
455
|
+
"organization_parameter": {
|
|
456
|
+
"enum": [
|
|
457
|
+
"organization",
|
|
458
|
+
"organization_id",
|
|
459
|
+
null
|
|
460
|
+
],
|
|
461
|
+
"description": "Provider parameter used to request an organization during browser login.",
|
|
462
|
+
"type": [
|
|
463
|
+
"string",
|
|
464
|
+
"null"
|
|
465
|
+
]
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
"required": [
|
|
469
|
+
"client_id"
|
|
470
|
+
],
|
|
471
|
+
"additionalProperties": false,
|
|
472
|
+
"type": "object"
|
|
473
|
+
},
|
|
273
474
|
"type": [
|
|
274
|
-
"
|
|
475
|
+
"object",
|
|
275
476
|
"null"
|
|
276
477
|
]
|
|
277
478
|
},
|
|
278
|
-
"
|
|
279
|
-
"description": "
|
|
479
|
+
"oauth_application": {
|
|
480
|
+
"description": "Default OAuth application used by generated products.",
|
|
481
|
+
"maxLength": 64,
|
|
482
|
+
"pattern": "^[a-z][a-z0-9_-]{0,63}$",
|
|
280
483
|
"type": [
|
|
281
484
|
"string",
|
|
282
485
|
"null"
|
|
283
486
|
]
|
|
284
487
|
},
|
|
285
|
-
"
|
|
286
|
-
"
|
|
488
|
+
"identity_verification": {
|
|
489
|
+
"anyOf": [
|
|
490
|
+
{
|
|
491
|
+
"description": "Authenticated identity read used to verify a login before it is saved. Operation is auto-detected when omitted. Requests must include at least one of subject_field, account_field, or organization_field.",
|
|
492
|
+
"properties": {
|
|
493
|
+
"operation": {
|
|
494
|
+
"description": "resource.method of a safe identity read with no required arguments.",
|
|
495
|
+
"maxLength": 2000,
|
|
496
|
+
"pattern": "^[\\w$]+\\.[\\w$]+$",
|
|
497
|
+
"type": "string"
|
|
498
|
+
},
|
|
499
|
+
"subject_field": {
|
|
500
|
+
"description": "JSON Pointer to the stable caller ID in the identity response.",
|
|
501
|
+
"maxLength": 512,
|
|
502
|
+
"type": "string"
|
|
503
|
+
},
|
|
504
|
+
"account_field": {
|
|
505
|
+
"description": "JSON Pointer to the customer account ID.",
|
|
506
|
+
"maxLength": 512,
|
|
507
|
+
"type": "string"
|
|
508
|
+
},
|
|
509
|
+
"organization_field": {
|
|
510
|
+
"description": "JSON Pointer to the customer organization ID.",
|
|
511
|
+
"maxLength": 512,
|
|
512
|
+
"type": "string"
|
|
513
|
+
}
|
|
514
|
+
},
|
|
515
|
+
"additionalProperties": false,
|
|
516
|
+
"type": "object"
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"type": "null"
|
|
520
|
+
}
|
|
521
|
+
]
|
|
522
|
+
},
|
|
523
|
+
"approval_url": {
|
|
524
|
+
"format": "uri",
|
|
525
|
+
"description": "Base URL of a custom browser-approval backend implementing the start, status, and revoke contract. Used only when OAuth is not configured.",
|
|
287
526
|
"type": [
|
|
288
527
|
"string",
|
|
289
528
|
"null"
|
|
290
529
|
]
|
|
291
530
|
},
|
|
292
|
-
"
|
|
293
|
-
"description": "
|
|
294
|
-
"
|
|
295
|
-
|
|
296
|
-
"
|
|
531
|
+
"environments": {
|
|
532
|
+
"description": "Authentication selections keyed by generated API environment name.",
|
|
533
|
+
"additionalProperties": {
|
|
534
|
+
"description": "OAuth application and request-value overrides for one named API environment.",
|
|
535
|
+
"properties": {
|
|
536
|
+
"oauth_application": {
|
|
537
|
+
"maxLength": 64,
|
|
538
|
+
"pattern": "^[a-z][a-z0-9_-]{0,63}$",
|
|
539
|
+
"type": [
|
|
540
|
+
"string",
|
|
541
|
+
"null"
|
|
542
|
+
]
|
|
543
|
+
},
|
|
544
|
+
"scopes": {
|
|
545
|
+
"maxItems": 20,
|
|
546
|
+
"type": [
|
|
547
|
+
"array",
|
|
548
|
+
"null"
|
|
549
|
+
]
|
|
550
|
+
},
|
|
551
|
+
"audience": {
|
|
552
|
+
"type": [
|
|
553
|
+
"string",
|
|
554
|
+
"null"
|
|
555
|
+
]
|
|
556
|
+
},
|
|
557
|
+
"resource": {
|
|
558
|
+
"format": "uri",
|
|
559
|
+
"type": [
|
|
560
|
+
"string",
|
|
561
|
+
"null"
|
|
562
|
+
]
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
"additionalProperties": false,
|
|
566
|
+
"type": "object"
|
|
297
567
|
},
|
|
298
|
-
"type":
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
568
|
+
"type": [
|
|
569
|
+
"object",
|
|
570
|
+
"null"
|
|
571
|
+
]
|
|
572
|
+
}
|
|
573
|
+
},
|
|
574
|
+
"additionalProperties": false,
|
|
575
|
+
"type": "object"
|
|
576
|
+
},
|
|
577
|
+
"cli": {
|
|
578
|
+
"description": "How the generated CLI behaves. Part of Config.",
|
|
579
|
+
"properties": {
|
|
580
|
+
"command_name": {
|
|
581
|
+
"description": "Command users run, independent of how the CLI is distributed.",
|
|
302
582
|
"type": [
|
|
303
583
|
"string",
|
|
304
584
|
"null"
|
|
@@ -315,13 +595,6 @@
|
|
|
315
595
|
"null"
|
|
316
596
|
]
|
|
317
597
|
},
|
|
318
|
-
"auth_url": {
|
|
319
|
-
"description": "Base URL of the browser-approval endpoint pair used by CLI login. The CLI keeps the verifier and receives the credential directly; no key is pasted through a conversation.",
|
|
320
|
-
"type": [
|
|
321
|
-
"string",
|
|
322
|
-
"null"
|
|
323
|
-
]
|
|
324
|
-
},
|
|
325
598
|
"mcp_url": {
|
|
326
599
|
"description": "Hosted MCP endpoint installed by the generated CLI instead of launching the package's local stdio server.",
|
|
327
600
|
"type": [
|
|
@@ -341,7 +614,7 @@
|
|
|
341
614
|
"type": "object"
|
|
342
615
|
},
|
|
343
616
|
"mcp": {
|
|
344
|
-
"description": "How
|
|
617
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave. Part of Config.",
|
|
345
618
|
"properties": {
|
|
346
619
|
"registry_name": {
|
|
347
620
|
"description": "Stable official MCP registry name, independent of the server runtime.",
|
|
@@ -350,6 +623,40 @@
|
|
|
350
623
|
"null"
|
|
351
624
|
]
|
|
352
625
|
},
|
|
626
|
+
"access": {
|
|
627
|
+
"description": "Authorization for callers connecting to a generated MCP server deployed over HTTP. The hosting application resolves upstream API credentials separately at runtime. This setting does not apply to the Typeship-hosted endpoint.",
|
|
628
|
+
"properties": {
|
|
629
|
+
"issuer": {
|
|
630
|
+
"format": "uri",
|
|
631
|
+
"description": "Exact issuer allowed to sign MCP connection tokens.",
|
|
632
|
+
"type": "string"
|
|
633
|
+
},
|
|
634
|
+
"resource": {
|
|
635
|
+
"format": "uri",
|
|
636
|
+
"description": "Canonical public URL of the self-hosted MCP endpoint that connection tokens must target.",
|
|
637
|
+
"type": "string"
|
|
638
|
+
},
|
|
639
|
+
"jwks_url": {
|
|
640
|
+
"format": "uri",
|
|
641
|
+
"description": "Public signing-key endpoint. Omit to discover it from the issuer.",
|
|
642
|
+
"type": "string"
|
|
643
|
+
},
|
|
644
|
+
"scopes": {
|
|
645
|
+
"description": "Minimum scopes required to connect to the self-hosted MCP server.",
|
|
646
|
+
"maxItems": 20,
|
|
647
|
+
"items": {
|
|
648
|
+
"type": "string"
|
|
649
|
+
},
|
|
650
|
+
"type": "array"
|
|
651
|
+
}
|
|
652
|
+
},
|
|
653
|
+
"required": [
|
|
654
|
+
"issuer",
|
|
655
|
+
"resource"
|
|
656
|
+
],
|
|
657
|
+
"additionalProperties": false,
|
|
658
|
+
"type": "object"
|
|
659
|
+
},
|
|
353
660
|
"tool_mode": {
|
|
354
661
|
"enum": [
|
|
355
662
|
"auto",
|
|
@@ -374,6 +681,41 @@
|
|
|
374
681
|
"type": "string"
|
|
375
682
|
},
|
|
376
683
|
"type": "object"
|
|
684
|
+
},
|
|
685
|
+
"reference_resolvers": {
|
|
686
|
+
"description": "Exact name-or-ID resolver overrides keyed first by the target operationId or \"METHOD /path\", then by its wire argument name. A resolver names one read collection operation plus 1-4 item fields to match case-insensitively; false opts that argument out of strict inference.",
|
|
687
|
+
"additionalProperties": {
|
|
688
|
+
"additionalProperties": {
|
|
689
|
+
"anyOf": [
|
|
690
|
+
{
|
|
691
|
+
"enum": [
|
|
692
|
+
false
|
|
693
|
+
],
|
|
694
|
+
"type": "boolean"
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"type": "object"
|
|
698
|
+
}
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
"type": "object"
|
|
702
|
+
},
|
|
703
|
+
"type": "object"
|
|
704
|
+
}
|
|
705
|
+
},
|
|
706
|
+
"additionalProperties": false,
|
|
707
|
+
"type": "object"
|
|
708
|
+
},
|
|
709
|
+
"readme": {
|
|
710
|
+
"description": "Generated README behavior. Part of Config.",
|
|
711
|
+
"properties": {
|
|
712
|
+
"quickstart_operation": {
|
|
713
|
+
"description": "operationId or \"METHOD /path\" to feature as the README's first API call. It must be present in the generated package and callable with no required input beyond path placeholders. Missing or unsuitable choices produce a warning and use the automatic example.",
|
|
714
|
+
"maxLength": 500,
|
|
715
|
+
"type": [
|
|
716
|
+
"string",
|
|
717
|
+
"null"
|
|
718
|
+
]
|
|
377
719
|
}
|
|
378
720
|
},
|
|
379
721
|
"additionalProperties": false,
|
|
@@ -767,12 +1109,39 @@
|
|
|
767
1109
|
},
|
|
768
1110
|
{
|
|
769
1111
|
"operation": "projects.list",
|
|
770
|
-
"signature": "
|
|
1112
|
+
"signature": "typeship projects list [flags]",
|
|
1113
|
+
"command": [
|
|
1114
|
+
"typeship",
|
|
1115
|
+
"projects",
|
|
1116
|
+
"list"
|
|
1117
|
+
],
|
|
1118
|
+
"parameters": [
|
|
1119
|
+
{
|
|
1120
|
+
"name": "limit",
|
|
1121
|
+
"flag": "--limit",
|
|
1122
|
+
"in": "query",
|
|
1123
|
+
"type": "number",
|
|
1124
|
+
"required": false
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
"name": "cursor",
|
|
1128
|
+
"flag": "--cursor",
|
|
1129
|
+
"in": "query",
|
|
1130
|
+
"type": "string",
|
|
1131
|
+
"required": false
|
|
1132
|
+
}
|
|
1133
|
+
],
|
|
1134
|
+
"example_command": "typeship projects list",
|
|
771
1135
|
"method": "GET",
|
|
772
1136
|
"path": "/projects",
|
|
773
1137
|
"summary": "List projects",
|
|
774
1138
|
"safety": "read",
|
|
775
1139
|
"auth": "required",
|
|
1140
|
+
"security": [
|
|
1141
|
+
{
|
|
1142
|
+
"apiKey": []
|
|
1143
|
+
}
|
|
1144
|
+
],
|
|
776
1145
|
"paginated": true,
|
|
777
1146
|
"input_schema": {
|
|
778
1147
|
"type": "object",
|
|
@@ -796,7 +1165,7 @@
|
|
|
796
1165
|
"items": {
|
|
797
1166
|
"type": "array",
|
|
798
1167
|
"items": {
|
|
799
|
-
"description": "Lean Project identity returned by collection endpoints. Retrieve the Project
|
|
1168
|
+
"description": "Lean Project identity returned by collection endpoints. Retrieve the Project for shared configuration and list its Targets for the complete canonical child collection.",
|
|
800
1169
|
"properties": {
|
|
801
1170
|
"id": {
|
|
802
1171
|
"description": "Unique identifier for a project.",
|
|
@@ -857,13 +1226,75 @@
|
|
|
857
1226
|
},
|
|
858
1227
|
{
|
|
859
1228
|
"operation": "projects.create",
|
|
860
|
-
"signature": "
|
|
1229
|
+
"signature": "typeship projects create [flags]",
|
|
1230
|
+
"command": [
|
|
1231
|
+
"typeship",
|
|
1232
|
+
"projects",
|
|
1233
|
+
"create"
|
|
1234
|
+
],
|
|
1235
|
+
"parameters": [
|
|
1236
|
+
{
|
|
1237
|
+
"name": "name",
|
|
1238
|
+
"flag": "--name",
|
|
1239
|
+
"in": "body",
|
|
1240
|
+
"type": "string",
|
|
1241
|
+
"required": true
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"name": "definition",
|
|
1245
|
+
"flag": "--definition",
|
|
1246
|
+
"in": "body",
|
|
1247
|
+
"type": "object",
|
|
1248
|
+
"required": true
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"name": "targets",
|
|
1252
|
+
"flag": "--targets",
|
|
1253
|
+
"in": "body",
|
|
1254
|
+
"type": "array",
|
|
1255
|
+
"required": true
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"name": "auto_generate",
|
|
1259
|
+
"flag": "--auto-generate",
|
|
1260
|
+
"in": "body",
|
|
1261
|
+
"type": "boolean",
|
|
1262
|
+
"required": false
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
"name": "relay_enabled",
|
|
1266
|
+
"flag": "--relay-enabled",
|
|
1267
|
+
"in": "body",
|
|
1268
|
+
"type": "boolean",
|
|
1269
|
+
"required": false
|
|
1270
|
+
},
|
|
1271
|
+
{
|
|
1272
|
+
"name": "config",
|
|
1273
|
+
"flag": "--config",
|
|
1274
|
+
"in": "body",
|
|
1275
|
+
"type": "json",
|
|
1276
|
+
"required": false
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1279
|
+
"name": "Idempotency-Key",
|
|
1280
|
+
"flag": "--idempotency-key",
|
|
1281
|
+
"in": "header",
|
|
1282
|
+
"type": "string",
|
|
1283
|
+
"required": false
|
|
1284
|
+
}
|
|
1285
|
+
],
|
|
1286
|
+
"example_command": "typeship projects create --name example --definition '{\"source\":{\"kind\":\"url\",\"url\":\"https://example.com\"}}' --targets '[{\"name\":\"example\",\"generator\":\"typescript-sdk\"}]'",
|
|
861
1287
|
"method": "POST",
|
|
862
1288
|
"path": "/projects",
|
|
863
1289
|
"summary": "Create a project",
|
|
864
1290
|
"description": "Stores a URL- or GitHub-sourced project. Free includes one stored project, every selected target, and the first 25 operations, while keeping manual and automatic regeneration, history, destination pull requests, and preview checks. Stateless POST /generate does not consume this slot. Pro adds projects and generates every operation in the Definition.",
|
|
865
1291
|
"safety": "write",
|
|
866
1292
|
"auth": "required",
|
|
1293
|
+
"security": [
|
|
1294
|
+
{
|
|
1295
|
+
"apiKey": []
|
|
1296
|
+
}
|
|
1297
|
+
],
|
|
867
1298
|
"paginated": false,
|
|
868
1299
|
"input_schema": {
|
|
869
1300
|
"type": "object",
|
|
@@ -873,7 +1304,7 @@
|
|
|
873
1304
|
"maxLength": 255,
|
|
874
1305
|
"pattern": "^[!-~]+$",
|
|
875
1306
|
"type": "string",
|
|
876
|
-
"description": "
|
|
1307
|
+
"description": "Identifies one logical write for 24 hours. The key is scoped to the authenticated account and operation; account-less generation uses a hashed network identity. Retrying the same method, path, query, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write."
|
|
877
1308
|
},
|
|
878
1309
|
"name": {
|
|
879
1310
|
"minLength": 1,
|
|
@@ -1193,10 +1624,9 @@
|
|
|
1193
1624
|
"description": "Target-specific overrides merged over Project.config. GraphQL settings are rejected here and belong to the Definition.",
|
|
1194
1625
|
"anyOf": [
|
|
1195
1626
|
{
|
|
1196
|
-
"description": "
|
|
1627
|
+
"description": "Target-specific generation and delivery overrides. Authentication may only select a Project-owned OAuth application. OAuth server metadata, applications, and identity policy remain Project-owned. Self-hosted MCP access may be overridden for a Target-specific deployment.",
|
|
1197
1628
|
"properties": {
|
|
1198
1629
|
"globals": {
|
|
1199
|
-
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-apply to every operation that accepts them; per-call values win. Names that match nothing are reported as generation warnings.",
|
|
1200
1630
|
"maxItems": 20,
|
|
1201
1631
|
"type": "array"
|
|
1202
1632
|
},
|
|
@@ -1205,7 +1635,10 @@
|
|
|
1205
1635
|
"type": "object"
|
|
1206
1636
|
},
|
|
1207
1637
|
"pagination": {
|
|
1208
|
-
"
|
|
1638
|
+
"type": "object"
|
|
1639
|
+
},
|
|
1640
|
+
"auth": {
|
|
1641
|
+
"description": "Selects a Project OAuth application for one Target. OAuth server metadata, applications, and identity policy remain Project-owned.",
|
|
1209
1642
|
"type": "object"
|
|
1210
1643
|
},
|
|
1211
1644
|
"cli": {
|
|
@@ -1213,7 +1646,11 @@
|
|
|
1213
1646
|
"type": "object"
|
|
1214
1647
|
},
|
|
1215
1648
|
"mcp": {
|
|
1216
|
-
"description": "How
|
|
1649
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave. Part of Config.",
|
|
1650
|
+
"type": "object"
|
|
1651
|
+
},
|
|
1652
|
+
"readme": {
|
|
1653
|
+
"description": "Generated README behavior. Part of Config.",
|
|
1217
1654
|
"type": "object"
|
|
1218
1655
|
},
|
|
1219
1656
|
"package": {
|
|
@@ -1221,7 +1658,7 @@
|
|
|
1221
1658
|
"type": "object"
|
|
1222
1659
|
},
|
|
1223
1660
|
"docs_url": {
|
|
1224
|
-
"
|
|
1661
|
+
"format": "uri",
|
|
1225
1662
|
"type": [
|
|
1226
1663
|
"string",
|
|
1227
1664
|
"null"
|
|
@@ -1229,7 +1666,6 @@
|
|
|
1229
1666
|
},
|
|
1230
1667
|
"docs_index_url": {
|
|
1231
1668
|
"format": "uri",
|
|
1232
|
-
"description": "Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.",
|
|
1233
1669
|
"type": [
|
|
1234
1670
|
"string",
|
|
1235
1671
|
"null"
|
|
@@ -1245,6 +1681,7 @@
|
|
|
1245
1681
|
]
|
|
1246
1682
|
},
|
|
1247
1683
|
"deliveries": {
|
|
1684
|
+
"maxItems": 2,
|
|
1248
1685
|
"items": {
|
|
1249
1686
|
"anyOf": [
|
|
1250
1687
|
{
|
|
@@ -1281,7 +1718,7 @@
|
|
|
1281
1718
|
"description": "Shared defaults inherited by every Target. GraphQL settings belong in definition.graphql.",
|
|
1282
1719
|
"anyOf": [
|
|
1283
1720
|
{
|
|
1284
|
-
"description": "Shared generated-client and tooling behavior for a stored Project. Every Target inherits these defaults. Target.config is merged over them for one Target; top-level values replace defaults while cli, mcp, and package merge by field. GraphQL-only source settings live on the Project's Definition and are rejected in both stored config scopes.",
|
|
1721
|
+
"description": "Shared generated-client and tooling behavior for a stored Project. Every Target inherits these defaults. Target.config is merged over them for one Target; top-level values replace defaults while cli, mcp, auth, readme, and package merge by field. GraphQL-only source settings live on the Project's Definition and are rejected in both stored config scopes.",
|
|
1285
1722
|
"properties": {
|
|
1286
1723
|
"globals": {
|
|
1287
1724
|
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-apply to every operation that accepts them; per-call values win. Names that match nothing are reported as generation warnings.",
|
|
@@ -1348,59 +1785,91 @@
|
|
|
1348
1785
|
},
|
|
1349
1786
|
"type": "object"
|
|
1350
1787
|
},
|
|
1351
|
-
"
|
|
1352
|
-
"description": "
|
|
1788
|
+
"auth": {
|
|
1789
|
+
"description": "Public authentication defaults for generated clients and tools. Stored Projects own the OAuth server, application catalog, and identity policy; stateless generation accepts the same shape for one run. Runtime credentials and client secrets are never accepted.",
|
|
1353
1790
|
"properties": {
|
|
1354
|
-
"
|
|
1355
|
-
"
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1791
|
+
"oauth_server": {
|
|
1792
|
+
"anyOf": [
|
|
1793
|
+
{
|
|
1794
|
+
"description": "Authorization-server metadata used by generated OAuth flows. Secrets and runtime credentials are never accepted here.",
|
|
1795
|
+
"type": "object"
|
|
1796
|
+
},
|
|
1797
|
+
{
|
|
1798
|
+
"type": "null"
|
|
1799
|
+
}
|
|
1359
1800
|
]
|
|
1360
1801
|
},
|
|
1361
|
-
"
|
|
1362
|
-
"description": "
|
|
1802
|
+
"oauth_applications": {
|
|
1803
|
+
"description": "OAuth applications keyed by a stable name.",
|
|
1804
|
+
"additionalProperties": {
|
|
1805
|
+
"description": "OAuth application available to generated products. Public clients support interactive login; confidential clients support runtime-supplied machine credentials. Client secrets are never stored.",
|
|
1806
|
+
"type": "object"
|
|
1807
|
+
},
|
|
1363
1808
|
"type": [
|
|
1364
|
-
"
|
|
1809
|
+
"object",
|
|
1365
1810
|
"null"
|
|
1366
1811
|
]
|
|
1367
1812
|
},
|
|
1368
|
-
"
|
|
1369
|
-
"description": "OAuth
|
|
1813
|
+
"oauth_application": {
|
|
1814
|
+
"description": "Default OAuth application used by generated products.",
|
|
1815
|
+
"maxLength": 64,
|
|
1816
|
+
"pattern": "^[a-z][a-z0-9_-]{0,63}$",
|
|
1370
1817
|
"type": [
|
|
1371
1818
|
"string",
|
|
1372
1819
|
"null"
|
|
1373
1820
|
]
|
|
1374
1821
|
},
|
|
1375
|
-
"
|
|
1376
|
-
"
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
"description": "Audience sent with the device-authorization request, for authorization servers that require one to issue API-valid access tokens.",
|
|
1385
|
-
"type": [
|
|
1386
|
-
"string",
|
|
1387
|
-
"null"
|
|
1822
|
+
"identity_verification": {
|
|
1823
|
+
"anyOf": [
|
|
1824
|
+
{
|
|
1825
|
+
"description": "Authenticated identity read used to verify a login before it is saved. Operation is auto-detected when omitted. Requests must include at least one of subject_field, account_field, or organization_field.",
|
|
1826
|
+
"type": "object"
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"type": "null"
|
|
1830
|
+
}
|
|
1388
1831
|
]
|
|
1389
1832
|
},
|
|
1390
|
-
"
|
|
1391
|
-
"
|
|
1392
|
-
"
|
|
1393
|
-
},
|
|
1394
|
-
"support_url": {
|
|
1395
|
-
"description": "Where the generated CLI's feedback command sends users. GitHub issues/new URLs get a prefilled title and environment details.",
|
|
1833
|
+
"approval_url": {
|
|
1834
|
+
"format": "uri",
|
|
1835
|
+
"description": "Base URL of a custom browser-approval backend implementing the start, status, and revoke contract. Used only when OAuth is not configured.",
|
|
1396
1836
|
"type": [
|
|
1397
1837
|
"string",
|
|
1398
1838
|
"null"
|
|
1399
1839
|
]
|
|
1400
1840
|
},
|
|
1401
|
-
"
|
|
1402
|
-
"description": "
|
|
1403
|
-
"
|
|
1841
|
+
"environments": {
|
|
1842
|
+
"description": "Authentication selections keyed by generated API environment name.",
|
|
1843
|
+
"additionalProperties": {
|
|
1844
|
+
"description": "OAuth application and request-value overrides for one named API environment.",
|
|
1845
|
+
"type": "object"
|
|
1846
|
+
},
|
|
1847
|
+
"type": [
|
|
1848
|
+
"object",
|
|
1849
|
+
"null"
|
|
1850
|
+
]
|
|
1851
|
+
}
|
|
1852
|
+
},
|
|
1853
|
+
"additionalProperties": false,
|
|
1854
|
+
"type": "object"
|
|
1855
|
+
},
|
|
1856
|
+
"cli": {
|
|
1857
|
+
"description": "How the generated CLI behaves. Part of Config.",
|
|
1858
|
+
"properties": {
|
|
1859
|
+
"command_name": {
|
|
1860
|
+
"description": "Command users run, independent of how the CLI is distributed.",
|
|
1861
|
+
"type": [
|
|
1862
|
+
"string",
|
|
1863
|
+
"null"
|
|
1864
|
+
]
|
|
1865
|
+
},
|
|
1866
|
+
"update_notice": {
|
|
1867
|
+
"description": "Opt in to a once-a-day registry check that prints an upgrade hint. Off by default; generated code phones nobody unless this is enabled.",
|
|
1868
|
+
"type": "boolean"
|
|
1869
|
+
},
|
|
1870
|
+
"support_url": {
|
|
1871
|
+
"description": "Where the generated CLI's feedback command sends users. GitHub issues/new URLs get a prefilled title and environment details.",
|
|
1872
|
+
"type": [
|
|
1404
1873
|
"string",
|
|
1405
1874
|
"null"
|
|
1406
1875
|
]
|
|
@@ -1424,7 +1893,7 @@
|
|
|
1424
1893
|
"type": "object"
|
|
1425
1894
|
},
|
|
1426
1895
|
"mcp": {
|
|
1427
|
-
"description": "How
|
|
1896
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave. Part of Config.",
|
|
1428
1897
|
"properties": {
|
|
1429
1898
|
"registry_name": {
|
|
1430
1899
|
"description": "Stable official MCP registry name, independent of the server runtime.",
|
|
@@ -1433,6 +1902,37 @@
|
|
|
1433
1902
|
"null"
|
|
1434
1903
|
]
|
|
1435
1904
|
},
|
|
1905
|
+
"access": {
|
|
1906
|
+
"description": "Authorization for callers connecting to a generated MCP server deployed over HTTP. The hosting application resolves upstream API credentials separately at runtime. This setting does not apply to the Typeship-hosted endpoint.",
|
|
1907
|
+
"properties": {
|
|
1908
|
+
"issuer": {
|
|
1909
|
+
"format": "uri",
|
|
1910
|
+
"description": "Exact issuer allowed to sign MCP connection tokens.",
|
|
1911
|
+
"type": "string"
|
|
1912
|
+
},
|
|
1913
|
+
"resource": {
|
|
1914
|
+
"format": "uri",
|
|
1915
|
+
"description": "Canonical public URL of the self-hosted MCP endpoint that connection tokens must target.",
|
|
1916
|
+
"type": "string"
|
|
1917
|
+
},
|
|
1918
|
+
"jwks_url": {
|
|
1919
|
+
"format": "uri",
|
|
1920
|
+
"description": "Public signing-key endpoint. Omit to discover it from the issuer.",
|
|
1921
|
+
"type": "string"
|
|
1922
|
+
},
|
|
1923
|
+
"scopes": {
|
|
1924
|
+
"description": "Minimum scopes required to connect to the self-hosted MCP server.",
|
|
1925
|
+
"maxItems": 20,
|
|
1926
|
+
"type": "array"
|
|
1927
|
+
}
|
|
1928
|
+
},
|
|
1929
|
+
"required": [
|
|
1930
|
+
"issuer",
|
|
1931
|
+
"resource"
|
|
1932
|
+
],
|
|
1933
|
+
"additionalProperties": false,
|
|
1934
|
+
"type": "object"
|
|
1935
|
+
},
|
|
1436
1936
|
"tool_mode": {
|
|
1437
1937
|
"enum": [
|
|
1438
1938
|
"auto",
|
|
@@ -1457,6 +1957,28 @@
|
|
|
1457
1957
|
"type": "string"
|
|
1458
1958
|
},
|
|
1459
1959
|
"type": "object"
|
|
1960
|
+
},
|
|
1961
|
+
"reference_resolvers": {
|
|
1962
|
+
"description": "Exact name-or-ID resolver overrides keyed first by the target operationId or \"METHOD /path\", then by its wire argument name. A resolver names one read collection operation plus 1-4 item fields to match case-insensitively; false opts that argument out of strict inference.",
|
|
1963
|
+
"additionalProperties": {
|
|
1964
|
+
"type": "object"
|
|
1965
|
+
},
|
|
1966
|
+
"type": "object"
|
|
1967
|
+
}
|
|
1968
|
+
},
|
|
1969
|
+
"additionalProperties": false,
|
|
1970
|
+
"type": "object"
|
|
1971
|
+
},
|
|
1972
|
+
"readme": {
|
|
1973
|
+
"description": "Generated README behavior. Part of Config.",
|
|
1974
|
+
"properties": {
|
|
1975
|
+
"quickstart_operation": {
|
|
1976
|
+
"description": "operationId or \"METHOD /path\" to feature as the README's first API call. It must be present in the generated package and callable with no required input beyond path placeholders. Missing or unsuitable choices produce a warning and use the automatic example.",
|
|
1977
|
+
"maxLength": 500,
|
|
1978
|
+
"type": [
|
|
1979
|
+
"string",
|
|
1980
|
+
"null"
|
|
1981
|
+
]
|
|
1460
1982
|
}
|
|
1461
1983
|
},
|
|
1462
1984
|
"additionalProperties": false,
|
|
@@ -1539,6 +2061,7 @@
|
|
|
1539
2061
|
]
|
|
1540
2062
|
},
|
|
1541
2063
|
"output_schema": {
|
|
2064
|
+
"description": "Project-owned identity, Definition reference, generation controls, and shared configuration.",
|
|
1542
2065
|
"properties": {
|
|
1543
2066
|
"id": {
|
|
1544
2067
|
"description": "Unique identifier for a project.",
|
|
@@ -1564,131 +2087,6 @@
|
|
|
1564
2087
|
"pattern": "^def_[a-z0-9]{16}$",
|
|
1565
2088
|
"type": "string"
|
|
1566
2089
|
},
|
|
1567
|
-
"targets": {
|
|
1568
|
-
"description": "All configured Targets, including disabled Targets and their saved Deliveries.",
|
|
1569
|
-
"items": {
|
|
1570
|
-
"properties": {
|
|
1571
|
-
"id": {
|
|
1572
|
-
"description": "Stable identifier for one configured generated product.",
|
|
1573
|
-
"examples": [
|
|
1574
|
-
"tgt_5m8q2v7k1p9d4h6c"
|
|
1575
|
-
],
|
|
1576
|
-
"pattern": "^tgt_[a-z0-9]{16}$",
|
|
1577
|
-
"type": "string"
|
|
1578
|
-
},
|
|
1579
|
-
"object": {
|
|
1580
|
-
"const": "target",
|
|
1581
|
-
"type": "string"
|
|
1582
|
-
},
|
|
1583
|
-
"project_id": {
|
|
1584
|
-
"description": "Unique identifier for a project.",
|
|
1585
|
-
"examples": [
|
|
1586
|
-
"prj_4f8k2m7x9q1v6b3n"
|
|
1587
|
-
],
|
|
1588
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
1589
|
-
"type": "string"
|
|
1590
|
-
},
|
|
1591
|
-
"definition_id": {
|
|
1592
|
-
"description": "Unique identifier for a project's logical API Definition.",
|
|
1593
|
-
"examples": [
|
|
1594
|
-
"def_2p8m4q7k1v9d6h3c"
|
|
1595
|
-
],
|
|
1596
|
-
"pattern": "^def_[a-z0-9]{16}$",
|
|
1597
|
-
"type": "string"
|
|
1598
|
-
},
|
|
1599
|
-
"name": {
|
|
1600
|
-
"type": "string"
|
|
1601
|
-
},
|
|
1602
|
-
"generator": {
|
|
1603
|
-
"enum": [
|
|
1604
|
-
"typescript-sdk",
|
|
1605
|
-
"python-sdk",
|
|
1606
|
-
"go-sdk",
|
|
1607
|
-
"cli",
|
|
1608
|
-
"mcp"
|
|
1609
|
-
],
|
|
1610
|
-
"description": "Generator implementation selected by a Target.",
|
|
1611
|
-
"type": "string"
|
|
1612
|
-
},
|
|
1613
|
-
"state": {
|
|
1614
|
-
"enum": [
|
|
1615
|
-
"active",
|
|
1616
|
-
"disabled"
|
|
1617
|
-
],
|
|
1618
|
-
"type": "string"
|
|
1619
|
-
},
|
|
1620
|
-
"edition": {
|
|
1621
|
-
"type": "string"
|
|
1622
|
-
},
|
|
1623
|
-
"release_channel": {
|
|
1624
|
-
"enum": [
|
|
1625
|
-
"stable",
|
|
1626
|
-
"prerelease"
|
|
1627
|
-
],
|
|
1628
|
-
"type": "string"
|
|
1629
|
-
},
|
|
1630
|
-
"version_policy": {
|
|
1631
|
-
"type": "object"
|
|
1632
|
-
},
|
|
1633
|
-
"current_version": {
|
|
1634
|
-
"type": "string"
|
|
1635
|
-
},
|
|
1636
|
-
"proposed_version": {
|
|
1637
|
-
"type": [
|
|
1638
|
-
"string",
|
|
1639
|
-
"null"
|
|
1640
|
-
]
|
|
1641
|
-
},
|
|
1642
|
-
"config": {
|
|
1643
|
-
"description": "Target-specific overrides merged over Project.config.",
|
|
1644
|
-
"anyOf": [
|
|
1645
|
-
{
|
|
1646
|
-
"description": "Shared generated-client and tooling behavior for a stored Project.",
|
|
1647
|
-
"type": "object"
|
|
1648
|
-
},
|
|
1649
|
-
{
|
|
1650
|
-
"type": "null"
|
|
1651
|
-
}
|
|
1652
|
-
]
|
|
1653
|
-
},
|
|
1654
|
-
"deliveries": {
|
|
1655
|
-
"type": "array"
|
|
1656
|
-
},
|
|
1657
|
-
"created_at": {
|
|
1658
|
-
"format": "date-time",
|
|
1659
|
-
"type": "string"
|
|
1660
|
-
},
|
|
1661
|
-
"updated_at": {
|
|
1662
|
-
"format": "date-time",
|
|
1663
|
-
"type": "string"
|
|
1664
|
-
},
|
|
1665
|
-
"request_id": {
|
|
1666
|
-
"description": "Server-generated identifier used to correlate this response with Typeship logs.",
|
|
1667
|
-
"examples": [
|
|
1668
|
-
"req_3k8m1v6q9p2d7h4c"
|
|
1669
|
-
],
|
|
1670
|
-
"pattern": "^req_[a-z0-9]{16}$",
|
|
1671
|
-
"type": "string"
|
|
1672
|
-
}
|
|
1673
|
-
},
|
|
1674
|
-
"type": "object"
|
|
1675
|
-
},
|
|
1676
|
-
"type": "array"
|
|
1677
|
-
},
|
|
1678
|
-
"deliveries": {
|
|
1679
|
-
"description": "Flattened convenience view derived from the same Target bundles.",
|
|
1680
|
-
"items": {
|
|
1681
|
-
"anyOf": [
|
|
1682
|
-
{
|
|
1683
|
-
"type": "object"
|
|
1684
|
-
},
|
|
1685
|
-
{
|
|
1686
|
-
"type": "object"
|
|
1687
|
-
}
|
|
1688
|
-
]
|
|
1689
|
-
},
|
|
1690
|
-
"type": "array"
|
|
1691
|
-
},
|
|
1692
2090
|
"auto_generate": {
|
|
1693
2091
|
"description": "Regenerate when the Definition changes: on every push to the default branch for a repository source…",
|
|
1694
2092
|
"type": "boolean"
|
|
@@ -1716,12 +2114,20 @@
|
|
|
1716
2114
|
"description": "Per-operation pagination control, keyed by operationId or \"METHOD /path\".",
|
|
1717
2115
|
"type": "object"
|
|
1718
2116
|
},
|
|
2117
|
+
"auth": {
|
|
2118
|
+
"description": "Public authentication defaults for generated clients and tools.",
|
|
2119
|
+
"type": "object"
|
|
2120
|
+
},
|
|
1719
2121
|
"cli": {
|
|
1720
2122
|
"description": "How the generated CLI behaves.",
|
|
1721
2123
|
"type": "object"
|
|
1722
2124
|
},
|
|
1723
2125
|
"mcp": {
|
|
1724
|
-
"description": "How
|
|
2126
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave.",
|
|
2127
|
+
"type": "object"
|
|
2128
|
+
},
|
|
2129
|
+
"readme": {
|
|
2130
|
+
"description": "Generated README behavior.",
|
|
1725
2131
|
"type": "object"
|
|
1726
2132
|
},
|
|
1727
2133
|
"package": {
|
|
@@ -1789,22 +2195,43 @@
|
|
|
1789
2195
|
},
|
|
1790
2196
|
{
|
|
1791
2197
|
"operation": "projects.retrieve",
|
|
1792
|
-
"signature": "
|
|
2198
|
+
"signature": "typeship projects retrieve <project_id> [flags]",
|
|
2199
|
+
"command": [
|
|
2200
|
+
"typeship",
|
|
2201
|
+
"projects",
|
|
2202
|
+
"retrieve"
|
|
2203
|
+
],
|
|
2204
|
+
"parameters": [
|
|
2205
|
+
{
|
|
2206
|
+
"name": "project_id",
|
|
2207
|
+
"positional": true,
|
|
2208
|
+
"in": "path",
|
|
2209
|
+
"type": "string",
|
|
2210
|
+
"required": true
|
|
2211
|
+
}
|
|
2212
|
+
],
|
|
2213
|
+
"example_command": "typeship projects retrieve prj_4f8k2m7x9q1v6b3n",
|
|
1793
2214
|
"method": "GET",
|
|
1794
2215
|
"path": "/projects/{project_id}",
|
|
1795
2216
|
"summary": "Retrieve a project",
|
|
2217
|
+
"description": "Returns Project-owned fields only. List Targets separately for Target and Delivery data.",
|
|
1796
2218
|
"safety": "read",
|
|
1797
2219
|
"auth": "required",
|
|
2220
|
+
"security": [
|
|
2221
|
+
{
|
|
2222
|
+
"apiKey": []
|
|
2223
|
+
}
|
|
2224
|
+
],
|
|
1798
2225
|
"paginated": false,
|
|
1799
2226
|
"input_schema": {
|
|
1800
2227
|
"type": "object",
|
|
1801
2228
|
"properties": {
|
|
1802
2229
|
"project_id": {
|
|
1803
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
2230
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
1804
2231
|
"examples": [
|
|
2232
|
+
"example-name",
|
|
1805
2233
|
"prj_4f8k2m7x9q1v6b3n"
|
|
1806
2234
|
],
|
|
1807
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
1808
2235
|
"type": "string"
|
|
1809
2236
|
}
|
|
1810
2237
|
},
|
|
@@ -1813,6 +2240,7 @@
|
|
|
1813
2240
|
]
|
|
1814
2241
|
},
|
|
1815
2242
|
"output_schema": {
|
|
2243
|
+
"description": "Project-owned identity, Definition reference, generation controls, and shared configuration.",
|
|
1816
2244
|
"properties": {
|
|
1817
2245
|
"id": {
|
|
1818
2246
|
"description": "Unique identifier for a project.",
|
|
@@ -1838,131 +2266,6 @@
|
|
|
1838
2266
|
"pattern": "^def_[a-z0-9]{16}$",
|
|
1839
2267
|
"type": "string"
|
|
1840
2268
|
},
|
|
1841
|
-
"targets": {
|
|
1842
|
-
"description": "All configured Targets, including disabled Targets and their saved Deliveries.",
|
|
1843
|
-
"items": {
|
|
1844
|
-
"properties": {
|
|
1845
|
-
"id": {
|
|
1846
|
-
"description": "Stable identifier for one configured generated product.",
|
|
1847
|
-
"examples": [
|
|
1848
|
-
"tgt_5m8q2v7k1p9d4h6c"
|
|
1849
|
-
],
|
|
1850
|
-
"pattern": "^tgt_[a-z0-9]{16}$",
|
|
1851
|
-
"type": "string"
|
|
1852
|
-
},
|
|
1853
|
-
"object": {
|
|
1854
|
-
"const": "target",
|
|
1855
|
-
"type": "string"
|
|
1856
|
-
},
|
|
1857
|
-
"project_id": {
|
|
1858
|
-
"description": "Unique identifier for a project.",
|
|
1859
|
-
"examples": [
|
|
1860
|
-
"prj_4f8k2m7x9q1v6b3n"
|
|
1861
|
-
],
|
|
1862
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
1863
|
-
"type": "string"
|
|
1864
|
-
},
|
|
1865
|
-
"definition_id": {
|
|
1866
|
-
"description": "Unique identifier for a project's logical API Definition.",
|
|
1867
|
-
"examples": [
|
|
1868
|
-
"def_2p8m4q7k1v9d6h3c"
|
|
1869
|
-
],
|
|
1870
|
-
"pattern": "^def_[a-z0-9]{16}$",
|
|
1871
|
-
"type": "string"
|
|
1872
|
-
},
|
|
1873
|
-
"name": {
|
|
1874
|
-
"type": "string"
|
|
1875
|
-
},
|
|
1876
|
-
"generator": {
|
|
1877
|
-
"enum": [
|
|
1878
|
-
"typescript-sdk",
|
|
1879
|
-
"python-sdk",
|
|
1880
|
-
"go-sdk",
|
|
1881
|
-
"cli",
|
|
1882
|
-
"mcp"
|
|
1883
|
-
],
|
|
1884
|
-
"description": "Generator implementation selected by a Target.",
|
|
1885
|
-
"type": "string"
|
|
1886
|
-
},
|
|
1887
|
-
"state": {
|
|
1888
|
-
"enum": [
|
|
1889
|
-
"active",
|
|
1890
|
-
"disabled"
|
|
1891
|
-
],
|
|
1892
|
-
"type": "string"
|
|
1893
|
-
},
|
|
1894
|
-
"edition": {
|
|
1895
|
-
"type": "string"
|
|
1896
|
-
},
|
|
1897
|
-
"release_channel": {
|
|
1898
|
-
"enum": [
|
|
1899
|
-
"stable",
|
|
1900
|
-
"prerelease"
|
|
1901
|
-
],
|
|
1902
|
-
"type": "string"
|
|
1903
|
-
},
|
|
1904
|
-
"version_policy": {
|
|
1905
|
-
"type": "object"
|
|
1906
|
-
},
|
|
1907
|
-
"current_version": {
|
|
1908
|
-
"type": "string"
|
|
1909
|
-
},
|
|
1910
|
-
"proposed_version": {
|
|
1911
|
-
"type": [
|
|
1912
|
-
"string",
|
|
1913
|
-
"null"
|
|
1914
|
-
]
|
|
1915
|
-
},
|
|
1916
|
-
"config": {
|
|
1917
|
-
"description": "Target-specific overrides merged over Project.config.",
|
|
1918
|
-
"anyOf": [
|
|
1919
|
-
{
|
|
1920
|
-
"description": "Shared generated-client and tooling behavior for a stored Project.",
|
|
1921
|
-
"type": "object"
|
|
1922
|
-
},
|
|
1923
|
-
{
|
|
1924
|
-
"type": "null"
|
|
1925
|
-
}
|
|
1926
|
-
]
|
|
1927
|
-
},
|
|
1928
|
-
"deliveries": {
|
|
1929
|
-
"type": "array"
|
|
1930
|
-
},
|
|
1931
|
-
"created_at": {
|
|
1932
|
-
"format": "date-time",
|
|
1933
|
-
"type": "string"
|
|
1934
|
-
},
|
|
1935
|
-
"updated_at": {
|
|
1936
|
-
"format": "date-time",
|
|
1937
|
-
"type": "string"
|
|
1938
|
-
},
|
|
1939
|
-
"request_id": {
|
|
1940
|
-
"description": "Server-generated identifier used to correlate this response with Typeship logs.",
|
|
1941
|
-
"examples": [
|
|
1942
|
-
"req_3k8m1v6q9p2d7h4c"
|
|
1943
|
-
],
|
|
1944
|
-
"pattern": "^req_[a-z0-9]{16}$",
|
|
1945
|
-
"type": "string"
|
|
1946
|
-
}
|
|
1947
|
-
},
|
|
1948
|
-
"type": "object"
|
|
1949
|
-
},
|
|
1950
|
-
"type": "array"
|
|
1951
|
-
},
|
|
1952
|
-
"deliveries": {
|
|
1953
|
-
"description": "Flattened convenience view derived from the same Target bundles.",
|
|
1954
|
-
"items": {
|
|
1955
|
-
"anyOf": [
|
|
1956
|
-
{
|
|
1957
|
-
"type": "object"
|
|
1958
|
-
},
|
|
1959
|
-
{
|
|
1960
|
-
"type": "object"
|
|
1961
|
-
}
|
|
1962
|
-
]
|
|
1963
|
-
},
|
|
1964
|
-
"type": "array"
|
|
1965
|
-
},
|
|
1966
2269
|
"auto_generate": {
|
|
1967
2270
|
"description": "Regenerate when the Definition changes: on every push to the default branch for a repository source…",
|
|
1968
2271
|
"type": "boolean"
|
|
@@ -1990,12 +2293,20 @@
|
|
|
1990
2293
|
"description": "Per-operation pagination control, keyed by operationId or \"METHOD /path\".",
|
|
1991
2294
|
"type": "object"
|
|
1992
2295
|
},
|
|
2296
|
+
"auth": {
|
|
2297
|
+
"description": "Public authentication defaults for generated clients and tools.",
|
|
2298
|
+
"type": "object"
|
|
2299
|
+
},
|
|
1993
2300
|
"cli": {
|
|
1994
2301
|
"description": "How the generated CLI behaves.",
|
|
1995
2302
|
"type": "object"
|
|
1996
2303
|
},
|
|
1997
2304
|
"mcp": {
|
|
1998
|
-
"description": "How
|
|
2305
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave.",
|
|
2306
|
+
"type": "object"
|
|
2307
|
+
},
|
|
2308
|
+
"readme": {
|
|
2309
|
+
"description": "Generated README behavior.",
|
|
1999
2310
|
"type": "object"
|
|
2000
2311
|
},
|
|
2001
2312
|
"package": {
|
|
@@ -2051,22 +2362,42 @@
|
|
|
2051
2362
|
},
|
|
2052
2363
|
{
|
|
2053
2364
|
"operation": "projects.delete",
|
|
2054
|
-
"signature": "
|
|
2365
|
+
"signature": "typeship projects delete <project_id> [flags]",
|
|
2366
|
+
"command": [
|
|
2367
|
+
"typeship",
|
|
2368
|
+
"projects",
|
|
2369
|
+
"delete"
|
|
2370
|
+
],
|
|
2371
|
+
"parameters": [
|
|
2372
|
+
{
|
|
2373
|
+
"name": "project_id",
|
|
2374
|
+
"positional": true,
|
|
2375
|
+
"in": "path",
|
|
2376
|
+
"type": "string",
|
|
2377
|
+
"required": true
|
|
2378
|
+
}
|
|
2379
|
+
],
|
|
2380
|
+
"example_command": "typeship projects delete prj_4f8k2m7x9q1v6b3n --force",
|
|
2055
2381
|
"method": "DELETE",
|
|
2056
2382
|
"path": "/projects/{project_id}",
|
|
2057
2383
|
"summary": "Delete a project",
|
|
2058
2384
|
"safety": "destructive",
|
|
2059
2385
|
"auth": "required",
|
|
2386
|
+
"security": [
|
|
2387
|
+
{
|
|
2388
|
+
"apiKey": []
|
|
2389
|
+
}
|
|
2390
|
+
],
|
|
2060
2391
|
"paginated": false,
|
|
2061
2392
|
"input_schema": {
|
|
2062
2393
|
"type": "object",
|
|
2063
2394
|
"properties": {
|
|
2064
2395
|
"project_id": {
|
|
2065
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
2396
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
2066
2397
|
"examples": [
|
|
2398
|
+
"example-name",
|
|
2067
2399
|
"prj_4f8k2m7x9q1v6b3n"
|
|
2068
2400
|
],
|
|
2069
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
2070
2401
|
"type": "string"
|
|
2071
2402
|
}
|
|
2072
2403
|
},
|
|
@@ -2109,22 +2440,70 @@
|
|
|
2109
2440
|
},
|
|
2110
2441
|
{
|
|
2111
2442
|
"operation": "projects.update",
|
|
2112
|
-
"signature": "
|
|
2443
|
+
"signature": "typeship projects update <project_id> [flags]",
|
|
2444
|
+
"command": [
|
|
2445
|
+
"typeship",
|
|
2446
|
+
"projects",
|
|
2447
|
+
"update"
|
|
2448
|
+
],
|
|
2449
|
+
"parameters": [
|
|
2450
|
+
{
|
|
2451
|
+
"name": "project_id",
|
|
2452
|
+
"positional": true,
|
|
2453
|
+
"in": "path",
|
|
2454
|
+
"type": "string",
|
|
2455
|
+
"required": true
|
|
2456
|
+
},
|
|
2457
|
+
{
|
|
2458
|
+
"name": "name",
|
|
2459
|
+
"flag": "--name",
|
|
2460
|
+
"in": "body",
|
|
2461
|
+
"type": "string",
|
|
2462
|
+
"required": false
|
|
2463
|
+
},
|
|
2464
|
+
{
|
|
2465
|
+
"name": "auto_generate",
|
|
2466
|
+
"flag": "--auto-generate",
|
|
2467
|
+
"in": "body",
|
|
2468
|
+
"type": "boolean",
|
|
2469
|
+
"required": false
|
|
2470
|
+
},
|
|
2471
|
+
{
|
|
2472
|
+
"name": "relay_enabled",
|
|
2473
|
+
"flag": "--relay-enabled",
|
|
2474
|
+
"in": "body",
|
|
2475
|
+
"type": "boolean",
|
|
2476
|
+
"required": false
|
|
2477
|
+
},
|
|
2478
|
+
{
|
|
2479
|
+
"name": "config",
|
|
2480
|
+
"flag": "--config",
|
|
2481
|
+
"in": "body",
|
|
2482
|
+
"type": "json",
|
|
2483
|
+
"required": false
|
|
2484
|
+
}
|
|
2485
|
+
],
|
|
2486
|
+
"example_command": "typeship projects update prj_4f8k2m7x9q1v6b3n",
|
|
2113
2487
|
"method": "PATCH",
|
|
2114
2488
|
"path": "/projects/{project_id}",
|
|
2115
2489
|
"summary": "Update a project",
|
|
2116
2490
|
"safety": "write",
|
|
2117
2491
|
"auth": "required",
|
|
2492
|
+
"security": [
|
|
2493
|
+
{
|
|
2494
|
+
"apiKey": []
|
|
2495
|
+
}
|
|
2496
|
+
],
|
|
2118
2497
|
"paginated": false,
|
|
2119
2498
|
"input_schema": {
|
|
2120
2499
|
"type": "object",
|
|
2121
2500
|
"properties": {
|
|
2122
2501
|
"project_id": {
|
|
2123
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
2502
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
2124
2503
|
"examples": [
|
|
2504
|
+
"example-name",
|
|
2125
2505
|
"prj_4f8k2m7x9q1v6b3n"
|
|
2126
2506
|
],
|
|
2127
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
2128
2507
|
"type": "string"
|
|
2129
2508
|
},
|
|
2130
2509
|
"name": {
|
|
@@ -2143,7 +2522,7 @@
|
|
|
2143
2522
|
"description": "Replaces the Project's shared Target defaults. Send null to clear them.",
|
|
2144
2523
|
"anyOf": [
|
|
2145
2524
|
{
|
|
2146
|
-
"description": "Shared generated-client and tooling behavior for a stored Project. Every Target inherits these defaults. Target.config is merged over them for one Target; top-level values replace defaults while cli, mcp, and package merge by field. GraphQL-only source settings live on the Project's Definition and are rejected in both stored config scopes.",
|
|
2525
|
+
"description": "Shared generated-client and tooling behavior for a stored Project. Every Target inherits these defaults. Target.config is merged over them for one Target; top-level values replace defaults while cli, mcp, auth, readme, and package merge by field. GraphQL-only source settings live on the Project's Definition and are rejected in both stored config scopes.",
|
|
2147
2526
|
"properties": {
|
|
2148
2527
|
"globals": {
|
|
2149
2528
|
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-apply to every operation that accepts them; per-call values win. Names that match nothing are reported as generation warnings.",
|
|
@@ -2210,40 +2589,79 @@
|
|
|
2210
2589
|
},
|
|
2211
2590
|
"type": "object"
|
|
2212
2591
|
},
|
|
2213
|
-
"
|
|
2214
|
-
"description": "
|
|
2592
|
+
"auth": {
|
|
2593
|
+
"description": "Public authentication defaults for generated clients and tools. Stored Projects own the OAuth server, application catalog, and identity policy; stateless generation accepts the same shape for one run. Runtime credentials and client secrets are never accepted.",
|
|
2215
2594
|
"properties": {
|
|
2216
|
-
"
|
|
2217
|
-
"
|
|
2595
|
+
"oauth_server": {
|
|
2596
|
+
"anyOf": [
|
|
2597
|
+
{
|
|
2598
|
+
"description": "Authorization-server metadata used by generated OAuth flows. Secrets and runtime credentials are never accepted here.",
|
|
2599
|
+
"type": "object"
|
|
2600
|
+
},
|
|
2601
|
+
{
|
|
2602
|
+
"type": "null"
|
|
2603
|
+
}
|
|
2604
|
+
]
|
|
2605
|
+
},
|
|
2606
|
+
"oauth_applications": {
|
|
2607
|
+
"description": "OAuth applications keyed by a stable name.",
|
|
2608
|
+
"additionalProperties": {
|
|
2609
|
+
"description": "OAuth application available to generated products. Public clients support interactive login; confidential clients support runtime-supplied machine credentials. Client secrets are never stored.",
|
|
2610
|
+
"type": "object"
|
|
2611
|
+
},
|
|
2218
2612
|
"type": [
|
|
2219
|
-
"
|
|
2613
|
+
"object",
|
|
2220
2614
|
"null"
|
|
2221
2615
|
]
|
|
2222
2616
|
},
|
|
2223
|
-
"
|
|
2224
|
-
"description": "
|
|
2617
|
+
"oauth_application": {
|
|
2618
|
+
"description": "Default OAuth application used by generated products.",
|
|
2619
|
+
"maxLength": 64,
|
|
2620
|
+
"pattern": "^[a-z][a-z0-9_-]{0,63}$",
|
|
2225
2621
|
"type": [
|
|
2226
2622
|
"string",
|
|
2227
2623
|
"null"
|
|
2228
2624
|
]
|
|
2229
2625
|
},
|
|
2230
|
-
"
|
|
2231
|
-
"
|
|
2626
|
+
"identity_verification": {
|
|
2627
|
+
"anyOf": [
|
|
2628
|
+
{
|
|
2629
|
+
"description": "Authenticated identity read used to verify a login before it is saved. Operation is auto-detected when omitted. Requests must include at least one of subject_field, account_field, or organization_field.",
|
|
2630
|
+
"type": "object"
|
|
2631
|
+
},
|
|
2632
|
+
{
|
|
2633
|
+
"type": "null"
|
|
2634
|
+
}
|
|
2635
|
+
]
|
|
2636
|
+
},
|
|
2637
|
+
"approval_url": {
|
|
2638
|
+
"format": "uri",
|
|
2639
|
+
"description": "Base URL of a custom browser-approval backend implementing the start, status, and revoke contract. Used only when OAuth is not configured.",
|
|
2232
2640
|
"type": [
|
|
2233
2641
|
"string",
|
|
2234
2642
|
"null"
|
|
2235
2643
|
]
|
|
2236
2644
|
},
|
|
2237
|
-
"
|
|
2238
|
-
"description": "
|
|
2239
|
-
"
|
|
2240
|
-
|
|
2241
|
-
"type": "
|
|
2645
|
+
"environments": {
|
|
2646
|
+
"description": "Authentication selections keyed by generated API environment name.",
|
|
2647
|
+
"additionalProperties": {
|
|
2648
|
+
"description": "OAuth application and request-value overrides for one named API environment.",
|
|
2649
|
+
"type": "object"
|
|
2242
2650
|
},
|
|
2243
|
-
"type":
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2651
|
+
"type": [
|
|
2652
|
+
"object",
|
|
2653
|
+
"null"
|
|
2654
|
+
]
|
|
2655
|
+
}
|
|
2656
|
+
},
|
|
2657
|
+
"additionalProperties": false,
|
|
2658
|
+
"type": "object"
|
|
2659
|
+
},
|
|
2660
|
+
"cli": {
|
|
2661
|
+
"description": "How the generated CLI behaves. Part of Config.",
|
|
2662
|
+
"properties": {
|
|
2663
|
+
"command_name": {
|
|
2664
|
+
"description": "Command users run, independent of how the CLI is distributed.",
|
|
2247
2665
|
"type": [
|
|
2248
2666
|
"string",
|
|
2249
2667
|
"null"
|
|
@@ -2260,13 +2678,6 @@
|
|
|
2260
2678
|
"null"
|
|
2261
2679
|
]
|
|
2262
2680
|
},
|
|
2263
|
-
"auth_url": {
|
|
2264
|
-
"description": "Base URL of the browser-approval endpoint pair used by CLI login. The CLI keeps the verifier and receives the credential directly; no key is pasted through a conversation.",
|
|
2265
|
-
"type": [
|
|
2266
|
-
"string",
|
|
2267
|
-
"null"
|
|
2268
|
-
]
|
|
2269
|
-
},
|
|
2270
2681
|
"mcp_url": {
|
|
2271
2682
|
"description": "Hosted MCP endpoint installed by the generated CLI instead of launching the package's local stdio server.",
|
|
2272
2683
|
"type": [
|
|
@@ -2286,7 +2697,7 @@
|
|
|
2286
2697
|
"type": "object"
|
|
2287
2698
|
},
|
|
2288
2699
|
"mcp": {
|
|
2289
|
-
"description": "How
|
|
2700
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave. Part of Config.",
|
|
2290
2701
|
"properties": {
|
|
2291
2702
|
"registry_name": {
|
|
2292
2703
|
"description": "Stable official MCP registry name, independent of the server runtime.",
|
|
@@ -2295,6 +2706,37 @@
|
|
|
2295
2706
|
"null"
|
|
2296
2707
|
]
|
|
2297
2708
|
},
|
|
2709
|
+
"access": {
|
|
2710
|
+
"description": "Authorization for callers connecting to a generated MCP server deployed over HTTP. The hosting application resolves upstream API credentials separately at runtime. This setting does not apply to the Typeship-hosted endpoint.",
|
|
2711
|
+
"properties": {
|
|
2712
|
+
"issuer": {
|
|
2713
|
+
"format": "uri",
|
|
2714
|
+
"description": "Exact issuer allowed to sign MCP connection tokens.",
|
|
2715
|
+
"type": "string"
|
|
2716
|
+
},
|
|
2717
|
+
"resource": {
|
|
2718
|
+
"format": "uri",
|
|
2719
|
+
"description": "Canonical public URL of the self-hosted MCP endpoint that connection tokens must target.",
|
|
2720
|
+
"type": "string"
|
|
2721
|
+
},
|
|
2722
|
+
"jwks_url": {
|
|
2723
|
+
"format": "uri",
|
|
2724
|
+
"description": "Public signing-key endpoint. Omit to discover it from the issuer.",
|
|
2725
|
+
"type": "string"
|
|
2726
|
+
},
|
|
2727
|
+
"scopes": {
|
|
2728
|
+
"description": "Minimum scopes required to connect to the self-hosted MCP server.",
|
|
2729
|
+
"maxItems": 20,
|
|
2730
|
+
"type": "array"
|
|
2731
|
+
}
|
|
2732
|
+
},
|
|
2733
|
+
"required": [
|
|
2734
|
+
"issuer",
|
|
2735
|
+
"resource"
|
|
2736
|
+
],
|
|
2737
|
+
"additionalProperties": false,
|
|
2738
|
+
"type": "object"
|
|
2739
|
+
},
|
|
2298
2740
|
"tool_mode": {
|
|
2299
2741
|
"enum": [
|
|
2300
2742
|
"auto",
|
|
@@ -2319,6 +2761,28 @@
|
|
|
2319
2761
|
"type": "string"
|
|
2320
2762
|
},
|
|
2321
2763
|
"type": "object"
|
|
2764
|
+
},
|
|
2765
|
+
"reference_resolvers": {
|
|
2766
|
+
"description": "Exact name-or-ID resolver overrides keyed first by the target operationId or \"METHOD /path\", then by its wire argument name. A resolver names one read collection operation plus 1-4 item fields to match case-insensitively; false opts that argument out of strict inference.",
|
|
2767
|
+
"additionalProperties": {
|
|
2768
|
+
"type": "object"
|
|
2769
|
+
},
|
|
2770
|
+
"type": "object"
|
|
2771
|
+
}
|
|
2772
|
+
},
|
|
2773
|
+
"additionalProperties": false,
|
|
2774
|
+
"type": "object"
|
|
2775
|
+
},
|
|
2776
|
+
"readme": {
|
|
2777
|
+
"description": "Generated README behavior. Part of Config.",
|
|
2778
|
+
"properties": {
|
|
2779
|
+
"quickstart_operation": {
|
|
2780
|
+
"description": "operationId or \"METHOD /path\" to feature as the README's first API call. It must be present in the generated package and callable with no required input beyond path placeholders. Missing or unsuitable choices produce a warning and use the automatic example.",
|
|
2781
|
+
"maxLength": 500,
|
|
2782
|
+
"type": [
|
|
2783
|
+
"string",
|
|
2784
|
+
"null"
|
|
2785
|
+
]
|
|
2322
2786
|
}
|
|
2323
2787
|
},
|
|
2324
2788
|
"additionalProperties": false,
|
|
@@ -2399,6 +2863,7 @@
|
|
|
2399
2863
|
]
|
|
2400
2864
|
},
|
|
2401
2865
|
"output_schema": {
|
|
2866
|
+
"description": "Project-owned identity, Definition reference, generation controls, and shared configuration.",
|
|
2402
2867
|
"properties": {
|
|
2403
2868
|
"id": {
|
|
2404
2869
|
"description": "Unique identifier for a project.",
|
|
@@ -2424,131 +2889,6 @@
|
|
|
2424
2889
|
"pattern": "^def_[a-z0-9]{16}$",
|
|
2425
2890
|
"type": "string"
|
|
2426
2891
|
},
|
|
2427
|
-
"targets": {
|
|
2428
|
-
"description": "All configured Targets, including disabled Targets and their saved Deliveries.",
|
|
2429
|
-
"items": {
|
|
2430
|
-
"properties": {
|
|
2431
|
-
"id": {
|
|
2432
|
-
"description": "Stable identifier for one configured generated product.",
|
|
2433
|
-
"examples": [
|
|
2434
|
-
"tgt_5m8q2v7k1p9d4h6c"
|
|
2435
|
-
],
|
|
2436
|
-
"pattern": "^tgt_[a-z0-9]{16}$",
|
|
2437
|
-
"type": "string"
|
|
2438
|
-
},
|
|
2439
|
-
"object": {
|
|
2440
|
-
"const": "target",
|
|
2441
|
-
"type": "string"
|
|
2442
|
-
},
|
|
2443
|
-
"project_id": {
|
|
2444
|
-
"description": "Unique identifier for a project.",
|
|
2445
|
-
"examples": [
|
|
2446
|
-
"prj_4f8k2m7x9q1v6b3n"
|
|
2447
|
-
],
|
|
2448
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
2449
|
-
"type": "string"
|
|
2450
|
-
},
|
|
2451
|
-
"definition_id": {
|
|
2452
|
-
"description": "Unique identifier for a project's logical API Definition.",
|
|
2453
|
-
"examples": [
|
|
2454
|
-
"def_2p8m4q7k1v9d6h3c"
|
|
2455
|
-
],
|
|
2456
|
-
"pattern": "^def_[a-z0-9]{16}$",
|
|
2457
|
-
"type": "string"
|
|
2458
|
-
},
|
|
2459
|
-
"name": {
|
|
2460
|
-
"type": "string"
|
|
2461
|
-
},
|
|
2462
|
-
"generator": {
|
|
2463
|
-
"enum": [
|
|
2464
|
-
"typescript-sdk",
|
|
2465
|
-
"python-sdk",
|
|
2466
|
-
"go-sdk",
|
|
2467
|
-
"cli",
|
|
2468
|
-
"mcp"
|
|
2469
|
-
],
|
|
2470
|
-
"description": "Generator implementation selected by a Target.",
|
|
2471
|
-
"type": "string"
|
|
2472
|
-
},
|
|
2473
|
-
"state": {
|
|
2474
|
-
"enum": [
|
|
2475
|
-
"active",
|
|
2476
|
-
"disabled"
|
|
2477
|
-
],
|
|
2478
|
-
"type": "string"
|
|
2479
|
-
},
|
|
2480
|
-
"edition": {
|
|
2481
|
-
"type": "string"
|
|
2482
|
-
},
|
|
2483
|
-
"release_channel": {
|
|
2484
|
-
"enum": [
|
|
2485
|
-
"stable",
|
|
2486
|
-
"prerelease"
|
|
2487
|
-
],
|
|
2488
|
-
"type": "string"
|
|
2489
|
-
},
|
|
2490
|
-
"version_policy": {
|
|
2491
|
-
"type": "object"
|
|
2492
|
-
},
|
|
2493
|
-
"current_version": {
|
|
2494
|
-
"type": "string"
|
|
2495
|
-
},
|
|
2496
|
-
"proposed_version": {
|
|
2497
|
-
"type": [
|
|
2498
|
-
"string",
|
|
2499
|
-
"null"
|
|
2500
|
-
]
|
|
2501
|
-
},
|
|
2502
|
-
"config": {
|
|
2503
|
-
"description": "Target-specific overrides merged over Project.config.",
|
|
2504
|
-
"anyOf": [
|
|
2505
|
-
{
|
|
2506
|
-
"description": "Shared generated-client and tooling behavior for a stored Project.",
|
|
2507
|
-
"type": "object"
|
|
2508
|
-
},
|
|
2509
|
-
{
|
|
2510
|
-
"type": "null"
|
|
2511
|
-
}
|
|
2512
|
-
]
|
|
2513
|
-
},
|
|
2514
|
-
"deliveries": {
|
|
2515
|
-
"type": "array"
|
|
2516
|
-
},
|
|
2517
|
-
"created_at": {
|
|
2518
|
-
"format": "date-time",
|
|
2519
|
-
"type": "string"
|
|
2520
|
-
},
|
|
2521
|
-
"updated_at": {
|
|
2522
|
-
"format": "date-time",
|
|
2523
|
-
"type": "string"
|
|
2524
|
-
},
|
|
2525
|
-
"request_id": {
|
|
2526
|
-
"description": "Server-generated identifier used to correlate this response with Typeship logs.",
|
|
2527
|
-
"examples": [
|
|
2528
|
-
"req_3k8m1v6q9p2d7h4c"
|
|
2529
|
-
],
|
|
2530
|
-
"pattern": "^req_[a-z0-9]{16}$",
|
|
2531
|
-
"type": "string"
|
|
2532
|
-
}
|
|
2533
|
-
},
|
|
2534
|
-
"type": "object"
|
|
2535
|
-
},
|
|
2536
|
-
"type": "array"
|
|
2537
|
-
},
|
|
2538
|
-
"deliveries": {
|
|
2539
|
-
"description": "Flattened convenience view derived from the same Target bundles.",
|
|
2540
|
-
"items": {
|
|
2541
|
-
"anyOf": [
|
|
2542
|
-
{
|
|
2543
|
-
"type": "object"
|
|
2544
|
-
},
|
|
2545
|
-
{
|
|
2546
|
-
"type": "object"
|
|
2547
|
-
}
|
|
2548
|
-
]
|
|
2549
|
-
},
|
|
2550
|
-
"type": "array"
|
|
2551
|
-
},
|
|
2552
2892
|
"auto_generate": {
|
|
2553
2893
|
"description": "Regenerate when the Definition changes: on every push to the default branch for a repository source…",
|
|
2554
2894
|
"type": "boolean"
|
|
@@ -2576,12 +2916,20 @@
|
|
|
2576
2916
|
"description": "Per-operation pagination control, keyed by operationId or \"METHOD /path\".",
|
|
2577
2917
|
"type": "object"
|
|
2578
2918
|
},
|
|
2919
|
+
"auth": {
|
|
2920
|
+
"description": "Public authentication defaults for generated clients and tools.",
|
|
2921
|
+
"type": "object"
|
|
2922
|
+
},
|
|
2579
2923
|
"cli": {
|
|
2580
2924
|
"description": "How the generated CLI behaves.",
|
|
2581
2925
|
"type": "object"
|
|
2582
2926
|
},
|
|
2583
2927
|
"mcp": {
|
|
2584
|
-
"description": "How
|
|
2928
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave.",
|
|
2929
|
+
"type": "object"
|
|
2930
|
+
},
|
|
2931
|
+
"readme": {
|
|
2932
|
+
"description": "Generated README behavior.",
|
|
2585
2933
|
"type": "object"
|
|
2586
2934
|
},
|
|
2587
2935
|
"package": {
|
|
@@ -2637,23 +2985,43 @@
|
|
|
2637
2985
|
},
|
|
2638
2986
|
{
|
|
2639
2987
|
"operation": "projects.retrieveDiagnostics",
|
|
2640
|
-
"signature": "
|
|
2988
|
+
"signature": "typeship projects retrieve-diagnostics <project_id> [flags]",
|
|
2989
|
+
"command": [
|
|
2990
|
+
"typeship",
|
|
2991
|
+
"projects",
|
|
2992
|
+
"retrieve-diagnostics"
|
|
2993
|
+
],
|
|
2994
|
+
"parameters": [
|
|
2995
|
+
{
|
|
2996
|
+
"name": "project_id",
|
|
2997
|
+
"positional": true,
|
|
2998
|
+
"in": "path",
|
|
2999
|
+
"type": "string",
|
|
3000
|
+
"required": true
|
|
3001
|
+
}
|
|
3002
|
+
],
|
|
3003
|
+
"example_command": "typeship projects retrieve-diagnostics prj_4f8k2m7x9q1v6b3n",
|
|
2641
3004
|
"method": "GET",
|
|
2642
3005
|
"path": "/projects/{project_id}/diagnostics",
|
|
2643
3006
|
"summary": "Analyze a project's latest Definition Revision",
|
|
2644
3007
|
"description": "Runs deterministic OpenAPI or GraphQL authorship checks against the latest observed immutable Definition Revision after applying the Definition's existing patches. Diagnostics group every affected location under a stable rule. Exact patches are included only when Typeship can derive the change without inventing API behavior.",
|
|
2645
3008
|
"safety": "read",
|
|
2646
3009
|
"auth": "required",
|
|
3010
|
+
"security": [
|
|
3011
|
+
{
|
|
3012
|
+
"apiKey": []
|
|
3013
|
+
}
|
|
3014
|
+
],
|
|
2647
3015
|
"paginated": false,
|
|
2648
3016
|
"input_schema": {
|
|
2649
3017
|
"type": "object",
|
|
2650
3018
|
"properties": {
|
|
2651
3019
|
"project_id": {
|
|
2652
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
3020
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
2653
3021
|
"examples": [
|
|
3022
|
+
"example-name",
|
|
2654
3023
|
"prj_4f8k2m7x9q1v6b3n"
|
|
2655
3024
|
],
|
|
2656
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
2657
3025
|
"type": "string"
|
|
2658
3026
|
}
|
|
2659
3027
|
},
|
|
@@ -2915,24 +3283,58 @@
|
|
|
2915
3283
|
},
|
|
2916
3284
|
{
|
|
2917
3285
|
"operation": "projects.refreshDiagnostics",
|
|
2918
|
-
"signature": "
|
|
3286
|
+
"signature": "typeship projects refresh-diagnostics <project_id> [flags]",
|
|
3287
|
+
"command": [
|
|
3288
|
+
"typeship",
|
|
3289
|
+
"projects",
|
|
3290
|
+
"refresh-diagnostics"
|
|
3291
|
+
],
|
|
3292
|
+
"parameters": [
|
|
3293
|
+
{
|
|
3294
|
+
"name": "project_id",
|
|
3295
|
+
"positional": true,
|
|
3296
|
+
"in": "path",
|
|
3297
|
+
"type": "string",
|
|
3298
|
+
"required": true
|
|
3299
|
+
},
|
|
3300
|
+
{
|
|
3301
|
+
"name": "Idempotency-Key",
|
|
3302
|
+
"flag": "--idempotency-key",
|
|
3303
|
+
"in": "header",
|
|
3304
|
+
"type": "string",
|
|
3305
|
+
"required": false
|
|
3306
|
+
}
|
|
3307
|
+
],
|
|
3308
|
+
"example_command": "typeship projects refresh-diagnostics prj_4f8k2m7x9q1v6b3n",
|
|
2919
3309
|
"method": "POST",
|
|
2920
3310
|
"path": "/projects/{project_id}/diagnostics",
|
|
2921
3311
|
"summary": "Refresh a project's Diagnostics from its configured source",
|
|
2922
3312
|
"description": "Fetches the complete configured source, records a new immutable revision only when content changed, and returns its Diagnostics. This does not generate targets or consume a metered generation.",
|
|
2923
3313
|
"safety": "write",
|
|
2924
3314
|
"auth": "required",
|
|
3315
|
+
"security": [
|
|
3316
|
+
{
|
|
3317
|
+
"apiKey": []
|
|
3318
|
+
}
|
|
3319
|
+
],
|
|
2925
3320
|
"paginated": false,
|
|
2926
3321
|
"input_schema": {
|
|
2927
3322
|
"type": "object",
|
|
2928
3323
|
"properties": {
|
|
2929
3324
|
"project_id": {
|
|
2930
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
3325
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
2931
3326
|
"examples": [
|
|
3327
|
+
"example-name",
|
|
2932
3328
|
"prj_4f8k2m7x9q1v6b3n"
|
|
2933
3329
|
],
|
|
2934
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
2935
3330
|
"type": "string"
|
|
3331
|
+
},
|
|
3332
|
+
"Idempotency-Key": {
|
|
3333
|
+
"minLength": 1,
|
|
3334
|
+
"maxLength": 255,
|
|
3335
|
+
"pattern": "^[!-~]+$",
|
|
3336
|
+
"type": "string",
|
|
3337
|
+
"description": "Identifies one logical write for 24 hours. The key is scoped to the authenticated account and operation; account-less generation uses a hashed network identity. Retrying the same method, path, query, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write."
|
|
2936
3338
|
}
|
|
2937
3339
|
},
|
|
2938
3340
|
"required": [
|
|
@@ -3193,25 +3595,66 @@
|
|
|
3193
3595
|
},
|
|
3194
3596
|
{
|
|
3195
3597
|
"operation": "projects.remediateDiagnostics",
|
|
3196
|
-
"signature": "
|
|
3598
|
+
"signature": "typeship projects remediate-diagnostics <project_id> [flags]",
|
|
3599
|
+
"command": [
|
|
3600
|
+
"typeship",
|
|
3601
|
+
"projects",
|
|
3602
|
+
"remediate-diagnostics"
|
|
3603
|
+
],
|
|
3604
|
+
"parameters": [
|
|
3605
|
+
{
|
|
3606
|
+
"name": "project_id",
|
|
3607
|
+
"positional": true,
|
|
3608
|
+
"in": "path",
|
|
3609
|
+
"type": "string",
|
|
3610
|
+
"required": true
|
|
3611
|
+
},
|
|
3612
|
+
{
|
|
3613
|
+
"name": "diagnostic_ids",
|
|
3614
|
+
"flag": "--diagnostic-ids",
|
|
3615
|
+
"in": "body",
|
|
3616
|
+
"type": "array",
|
|
3617
|
+
"required": true
|
|
3618
|
+
},
|
|
3619
|
+
{
|
|
3620
|
+
"name": "Idempotency-Key",
|
|
3621
|
+
"flag": "--idempotency-key",
|
|
3622
|
+
"in": "header",
|
|
3623
|
+
"type": "string",
|
|
3624
|
+
"required": false
|
|
3625
|
+
}
|
|
3626
|
+
],
|
|
3627
|
+
"example_command": "typeship projects remediate-diagnostics prj_4f8k2m7x9q1v6b3n --diagnostic-ids '[\"value\"]'",
|
|
3197
3628
|
"method": "POST",
|
|
3198
3629
|
"path": "/projects/{project_id}/diagnostics/remediations",
|
|
3199
3630
|
"summary": "Apply exact, reviewed diagnostic remediations",
|
|
3200
3631
|
"description": "Applies only deterministic patches. Repository sources receive an updateable source pull request; URL sources receive project overlays. Diagnostics that require API-owner intent return 422 and include an authoring_brief in the Diagnostic instead.",
|
|
3201
3632
|
"safety": "write",
|
|
3202
3633
|
"auth": "required",
|
|
3634
|
+
"security": [
|
|
3635
|
+
{
|
|
3636
|
+
"apiKey": []
|
|
3637
|
+
}
|
|
3638
|
+
],
|
|
3203
3639
|
"paginated": false,
|
|
3204
3640
|
"input_schema": {
|
|
3205
3641
|
"type": "object",
|
|
3206
3642
|
"properties": {
|
|
3207
3643
|
"project_id": {
|
|
3208
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
3644
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
3209
3645
|
"examples": [
|
|
3646
|
+
"example-name",
|
|
3210
3647
|
"prj_4f8k2m7x9q1v6b3n"
|
|
3211
3648
|
],
|
|
3212
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
3213
3649
|
"type": "string"
|
|
3214
3650
|
},
|
|
3651
|
+
"Idempotency-Key": {
|
|
3652
|
+
"minLength": 1,
|
|
3653
|
+
"maxLength": 255,
|
|
3654
|
+
"pattern": "^[!-~]+$",
|
|
3655
|
+
"type": "string",
|
|
3656
|
+
"description": "Identifies one logical write for 24 hours. The key is scoped to the authenticated account and operation; account-less generation uses a hashed network identity. Retrying the same method, path, query, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write."
|
|
3657
|
+
},
|
|
3215
3658
|
"diagnostic_ids": {
|
|
3216
3659
|
"description": "Stable IDs of current diagnostics whose exact patches should be reviewed and applied.",
|
|
3217
3660
|
"minItems": 1,
|
|
@@ -3273,23 +3716,43 @@
|
|
|
3273
3716
|
},
|
|
3274
3717
|
{
|
|
3275
3718
|
"operation": "projects.retrieveIntegrationHealth",
|
|
3276
|
-
"signature": "
|
|
3719
|
+
"signature": "typeship projects retrieve-integration-health <project_id> [flags]",
|
|
3720
|
+
"command": [
|
|
3721
|
+
"typeship",
|
|
3722
|
+
"projects",
|
|
3723
|
+
"retrieve-integration-health"
|
|
3724
|
+
],
|
|
3725
|
+
"parameters": [
|
|
3726
|
+
{
|
|
3727
|
+
"name": "project_id",
|
|
3728
|
+
"positional": true,
|
|
3729
|
+
"in": "path",
|
|
3730
|
+
"type": "string",
|
|
3731
|
+
"required": true
|
|
3732
|
+
}
|
|
3733
|
+
],
|
|
3734
|
+
"example_command": "typeship projects retrieve-integration-health prj_4f8k2m7x9q1v6b3n",
|
|
3277
3735
|
"method": "GET",
|
|
3278
3736
|
"path": "/projects/{project_id}/integration-health",
|
|
3279
3737
|
"summary": "Diagnose a project's repository integrations",
|
|
3280
3738
|
"description": "Returns provider-neutral, machine-actionable source and destination access, Definition readability, source-approval label setup, required status names, and the latest durable webhook delivery. The Console renders this same result.",
|
|
3281
3739
|
"safety": "read",
|
|
3282
3740
|
"auth": "required",
|
|
3741
|
+
"security": [
|
|
3742
|
+
{
|
|
3743
|
+
"apiKey": []
|
|
3744
|
+
}
|
|
3745
|
+
],
|
|
3283
3746
|
"paginated": false,
|
|
3284
3747
|
"input_schema": {
|
|
3285
3748
|
"type": "object",
|
|
3286
3749
|
"properties": {
|
|
3287
3750
|
"project_id": {
|
|
3288
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
3751
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
3289
3752
|
"examples": [
|
|
3753
|
+
"example-name",
|
|
3290
3754
|
"prj_4f8k2m7x9q1v6b3n"
|
|
3291
3755
|
],
|
|
3292
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
3293
3756
|
"type": "string"
|
|
3294
3757
|
}
|
|
3295
3758
|
},
|
|
@@ -3468,22 +3931,63 @@
|
|
|
3468
3931
|
},
|
|
3469
3932
|
{
|
|
3470
3933
|
"operation": "projects.listGenerations",
|
|
3471
|
-
"signature": "
|
|
3934
|
+
"signature": "typeship projects list-generations <project_id> [flags]",
|
|
3935
|
+
"command": [
|
|
3936
|
+
"typeship",
|
|
3937
|
+
"projects",
|
|
3938
|
+
"list-generations"
|
|
3939
|
+
],
|
|
3940
|
+
"parameters": [
|
|
3941
|
+
{
|
|
3942
|
+
"name": "project_id",
|
|
3943
|
+
"positional": true,
|
|
3944
|
+
"in": "path",
|
|
3945
|
+
"type": "string",
|
|
3946
|
+
"required": true
|
|
3947
|
+
},
|
|
3948
|
+
{
|
|
3949
|
+
"name": "limit",
|
|
3950
|
+
"flag": "--limit",
|
|
3951
|
+
"in": "query",
|
|
3952
|
+
"type": "number",
|
|
3953
|
+
"required": false
|
|
3954
|
+
},
|
|
3955
|
+
{
|
|
3956
|
+
"name": "cursor",
|
|
3957
|
+
"flag": "--cursor",
|
|
3958
|
+
"in": "query",
|
|
3959
|
+
"type": "string",
|
|
3960
|
+
"required": false
|
|
3961
|
+
},
|
|
3962
|
+
{
|
|
3963
|
+
"name": "target_id",
|
|
3964
|
+
"flag": "--target-id",
|
|
3965
|
+
"in": "query",
|
|
3966
|
+
"type": "string",
|
|
3967
|
+
"required": false
|
|
3968
|
+
}
|
|
3969
|
+
],
|
|
3970
|
+
"example_command": "typeship projects list-generations prj_4f8k2m7x9q1v6b3n",
|
|
3472
3971
|
"method": "GET",
|
|
3473
3972
|
"path": "/projects/{project_id}/generations",
|
|
3474
3973
|
"summary": "List a project's generations",
|
|
3475
3974
|
"safety": "read",
|
|
3476
3975
|
"auth": "required",
|
|
3976
|
+
"security": [
|
|
3977
|
+
{
|
|
3978
|
+
"apiKey": []
|
|
3979
|
+
}
|
|
3980
|
+
],
|
|
3477
3981
|
"paginated": true,
|
|
3478
3982
|
"input_schema": {
|
|
3479
3983
|
"type": "object",
|
|
3480
3984
|
"properties": {
|
|
3481
3985
|
"project_id": {
|
|
3482
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
3986
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
3483
3987
|
"examples": [
|
|
3988
|
+
"example-name",
|
|
3484
3989
|
"prj_4f8k2m7x9q1v6b3n"
|
|
3485
3990
|
],
|
|
3486
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
3487
3991
|
"type": "string"
|
|
3488
3992
|
},
|
|
3489
3993
|
"limit": {
|
|
@@ -3498,7 +4002,7 @@
|
|
|
3498
4002
|
"description": "Opaque cursor from the preceding page's next_cursor. Valid only for the same account, operation, filters, and ordering that issued it."
|
|
3499
4003
|
},
|
|
3500
4004
|
"target_id": {
|
|
3501
|
-
"description": "Stable identifier for one configured generated product.
|
|
4005
|
+
"description": "Stable identifier for one configured generated product.",
|
|
3502
4006
|
"examples": [
|
|
3503
4007
|
"tgt_5m8q2v7k1p9d4h6c"
|
|
3504
4008
|
],
|
|
@@ -3516,6 +4020,7 @@
|
|
|
3516
4020
|
"items": {
|
|
3517
4021
|
"type": "array",
|
|
3518
4022
|
"items": {
|
|
4023
|
+
"description": "Generation metadata returned by collection endpoints.",
|
|
3519
4024
|
"examples": [
|
|
3520
4025
|
{
|
|
3521
4026
|
"id": "gen_7h2p5d9c3m8w1k6q",
|
|
@@ -3565,16 +4070,6 @@
|
|
|
3565
4070
|
"const": "generation",
|
|
3566
4071
|
"type": "string"
|
|
3567
4072
|
},
|
|
3568
|
-
"files_omitted": {
|
|
3569
|
-
"description": "Present and true when the generated target was too large to inline; files_index lists paths, fetche…",
|
|
3570
|
-
"type": "boolean"
|
|
3571
|
-
},
|
|
3572
|
-
"files_index": {
|
|
3573
|
-
"items": {
|
|
3574
|
-
"type": "object"
|
|
3575
|
-
},
|
|
3576
|
-
"type": "array"
|
|
3577
|
-
},
|
|
3578
4073
|
"project_id": {
|
|
3579
4074
|
"description": "Unique identifier for a project.",
|
|
3580
4075
|
"examples": [
|
|
@@ -3712,13 +4207,6 @@
|
|
|
3712
4207
|
},
|
|
3713
4208
|
"type": "array"
|
|
3714
4209
|
},
|
|
3715
|
-
"files": {
|
|
3716
|
-
"description": "Present on retrieve and create; omitted in lists.",
|
|
3717
|
-
"items": {
|
|
3718
|
-
"type": "object"
|
|
3719
|
-
},
|
|
3720
|
-
"type": "array"
|
|
3721
|
-
},
|
|
3722
4210
|
"error": {
|
|
3723
4211
|
"type": [
|
|
3724
4212
|
"string",
|
|
@@ -3728,14 +4216,6 @@
|
|
|
3728
4216
|
"created_at": {
|
|
3729
4217
|
"format": "date-time",
|
|
3730
4218
|
"type": "string"
|
|
3731
|
-
},
|
|
3732
|
-
"request_id": {
|
|
3733
|
-
"description": "Server-generated identifier used to correlate this response with Typeship logs.",
|
|
3734
|
-
"examples": [
|
|
3735
|
-
"req_3k8m1v6q9p2d7h4c"
|
|
3736
|
-
],
|
|
3737
|
-
"pattern": "^req_[a-z0-9]{16}$",
|
|
3738
|
-
"type": "string"
|
|
3739
4219
|
}
|
|
3740
4220
|
},
|
|
3741
4221
|
"type": "object"
|
|
@@ -3763,24 +4243,58 @@
|
|
|
3763
4243
|
},
|
|
3764
4244
|
{
|
|
3765
4245
|
"operation": "projects.generate",
|
|
3766
|
-
"signature": "
|
|
4246
|
+
"signature": "typeship projects generate <project_id> [flags]",
|
|
4247
|
+
"command": [
|
|
4248
|
+
"typeship",
|
|
4249
|
+
"projects",
|
|
4250
|
+
"generate"
|
|
4251
|
+
],
|
|
4252
|
+
"parameters": [
|
|
4253
|
+
{
|
|
4254
|
+
"name": "project_id",
|
|
4255
|
+
"positional": true,
|
|
4256
|
+
"in": "path",
|
|
4257
|
+
"type": "string",
|
|
4258
|
+
"required": true
|
|
4259
|
+
},
|
|
4260
|
+
{
|
|
4261
|
+
"name": "Idempotency-Key",
|
|
4262
|
+
"flag": "--idempotency-key",
|
|
4263
|
+
"in": "header",
|
|
4264
|
+
"type": "string",
|
|
4265
|
+
"required": false
|
|
4266
|
+
}
|
|
4267
|
+
],
|
|
4268
|
+
"example_command": "typeship projects generate prj_4f8k2m7x9q1v6b3n",
|
|
3767
4269
|
"method": "POST",
|
|
3768
4270
|
"path": "/projects/{project_id}/generations",
|
|
3769
4271
|
"summary": "Generate targets and open pull requests",
|
|
3770
4272
|
"description": "Resolves the project's URL or GitHub source, generates every\nconfigured delivery package, stores each result in the project's history,\nand attempts to open a pull request in every configured destination.\nWhen the complete generated tree already matches a destination, no\ncommit, branch, or pull request is created and that generation reports\n`pr_status: no_changes`. This is the same pipeline automatic\nregeneration runs after a source change.",
|
|
3771
4273
|
"safety": "write",
|
|
3772
4274
|
"auth": "required",
|
|
4275
|
+
"security": [
|
|
4276
|
+
{
|
|
4277
|
+
"apiKey": []
|
|
4278
|
+
}
|
|
4279
|
+
],
|
|
3773
4280
|
"paginated": false,
|
|
3774
4281
|
"input_schema": {
|
|
3775
4282
|
"type": "object",
|
|
3776
4283
|
"properties": {
|
|
3777
4284
|
"project_id": {
|
|
3778
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
4285
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
3779
4286
|
"examples": [
|
|
4287
|
+
"example-name",
|
|
3780
4288
|
"prj_4f8k2m7x9q1v6b3n"
|
|
3781
4289
|
],
|
|
3782
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
3783
4290
|
"type": "string"
|
|
4291
|
+
},
|
|
4292
|
+
"Idempotency-Key": {
|
|
4293
|
+
"minLength": 1,
|
|
4294
|
+
"maxLength": 255,
|
|
4295
|
+
"pattern": "^[!-~]+$",
|
|
4296
|
+
"type": "string",
|
|
4297
|
+
"description": "Identifies one logical write for 24 hours. The key is scoped to the authenticated account and operation; account-less generation uses a hashed network identity. Retrying the same method, path, query, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write."
|
|
3784
4298
|
}
|
|
3785
4299
|
},
|
|
3786
4300
|
"required": [
|
|
@@ -3788,11 +4302,13 @@
|
|
|
3788
4302
|
]
|
|
3789
4303
|
},
|
|
3790
4304
|
"output_schema": {
|
|
4305
|
+
"description": "Metadata for each Target generation attempted by a Project run. Retrieve one Generation separately for generated files.",
|
|
3791
4306
|
"properties": {
|
|
3792
4307
|
"data": {
|
|
3793
4308
|
"items": {
|
|
3794
4309
|
"anyOf": [
|
|
3795
4310
|
{
|
|
4311
|
+
"description": "Generation metadata returned by collection endpoints. Generated file contents and file indexes are available only from retrieve and create operations.",
|
|
3796
4312
|
"examples": [
|
|
3797
4313
|
{
|
|
3798
4314
|
"id": "gen_7h2p5d9c3m8w1k6q",
|
|
@@ -3842,13 +4358,6 @@
|
|
|
3842
4358
|
"const": "generation",
|
|
3843
4359
|
"type": "string"
|
|
3844
4360
|
},
|
|
3845
|
-
"files_omitted": {
|
|
3846
|
-
"description": "Present and true when the generated target was too large to inline; files_index lists paths, fetched one at a time via GET /generations/{generation_id}/file.",
|
|
3847
|
-
"type": "boolean"
|
|
3848
|
-
},
|
|
3849
|
-
"files_index": {
|
|
3850
|
-
"type": "array"
|
|
3851
|
-
},
|
|
3852
4361
|
"project_id": {
|
|
3853
4362
|
"description": "Unique identifier for a project.",
|
|
3854
4363
|
"examples": [
|
|
@@ -3932,10 +4441,6 @@
|
|
|
3932
4441
|
"warnings": {
|
|
3933
4442
|
"type": "array"
|
|
3934
4443
|
},
|
|
3935
|
-
"files": {
|
|
3936
|
-
"description": "Present on retrieve and create; omitted in lists.",
|
|
3937
|
-
"type": "array"
|
|
3938
|
-
},
|
|
3939
4444
|
"error": {
|
|
3940
4445
|
"type": [
|
|
3941
4446
|
"string",
|
|
@@ -3945,14 +4450,6 @@
|
|
|
3945
4450
|
"created_at": {
|
|
3946
4451
|
"format": "date-time",
|
|
3947
4452
|
"type": "string"
|
|
3948
|
-
},
|
|
3949
|
-
"request_id": {
|
|
3950
|
-
"description": "Server-generated identifier used to correlate this response with Typeship logs.",
|
|
3951
|
-
"examples": [
|
|
3952
|
-
"req_3k8m1v6q9p2d7h4c"
|
|
3953
|
-
],
|
|
3954
|
-
"pattern": "^req_[a-z0-9]{16}$",
|
|
3955
|
-
"type": "string"
|
|
3956
4453
|
}
|
|
3957
4454
|
},
|
|
3958
4455
|
"type": "object"
|
|
@@ -4010,12 +4507,32 @@
|
|
|
4010
4507
|
},
|
|
4011
4508
|
{
|
|
4012
4509
|
"operation": "definitions.retrieve",
|
|
4013
|
-
"signature": "
|
|
4510
|
+
"signature": "typeship definitions retrieve <definition_id> [flags]",
|
|
4511
|
+
"command": [
|
|
4512
|
+
"typeship",
|
|
4513
|
+
"definitions",
|
|
4514
|
+
"retrieve"
|
|
4515
|
+
],
|
|
4516
|
+
"parameters": [
|
|
4517
|
+
{
|
|
4518
|
+
"name": "definition_id",
|
|
4519
|
+
"positional": true,
|
|
4520
|
+
"in": "path",
|
|
4521
|
+
"type": "string",
|
|
4522
|
+
"required": true
|
|
4523
|
+
}
|
|
4524
|
+
],
|
|
4525
|
+
"example_command": "typeship definitions retrieve def_2p8m4q7k1v9d6h3c",
|
|
4014
4526
|
"method": "GET",
|
|
4015
4527
|
"path": "/definitions/{definition_id}",
|
|
4016
4528
|
"summary": "Retrieve a Definition",
|
|
4017
4529
|
"safety": "read",
|
|
4018
4530
|
"auth": "required",
|
|
4531
|
+
"security": [
|
|
4532
|
+
{
|
|
4533
|
+
"apiKey": []
|
|
4534
|
+
}
|
|
4535
|
+
],
|
|
4019
4536
|
"paginated": false,
|
|
4020
4537
|
"input_schema": {
|
|
4021
4538
|
"type": "object",
|
|
@@ -4317,13 +4834,68 @@
|
|
|
4317
4834
|
},
|
|
4318
4835
|
{
|
|
4319
4836
|
"operation": "definitions.update",
|
|
4320
|
-
"signature": "
|
|
4837
|
+
"signature": "typeship definitions update <definition_id> [flags]",
|
|
4838
|
+
"command": [
|
|
4839
|
+
"typeship",
|
|
4840
|
+
"definitions",
|
|
4841
|
+
"update"
|
|
4842
|
+
],
|
|
4843
|
+
"parameters": [
|
|
4844
|
+
{
|
|
4845
|
+
"name": "definition_id",
|
|
4846
|
+
"positional": true,
|
|
4847
|
+
"in": "path",
|
|
4848
|
+
"type": "string",
|
|
4849
|
+
"required": true
|
|
4850
|
+
},
|
|
4851
|
+
{
|
|
4852
|
+
"name": "source",
|
|
4853
|
+
"flag": "--source",
|
|
4854
|
+
"in": "body",
|
|
4855
|
+
"type": "json",
|
|
4856
|
+
"required": false
|
|
4857
|
+
},
|
|
4858
|
+
{
|
|
4859
|
+
"name": "patches",
|
|
4860
|
+
"flag": "--patches",
|
|
4861
|
+
"in": "body",
|
|
4862
|
+
"type": "array",
|
|
4863
|
+
"required": false
|
|
4864
|
+
},
|
|
4865
|
+
{
|
|
4866
|
+
"name": "graphql",
|
|
4867
|
+
"flag": "--graphql",
|
|
4868
|
+
"in": "body",
|
|
4869
|
+
"type": "json",
|
|
4870
|
+
"required": false
|
|
4871
|
+
},
|
|
4872
|
+
{
|
|
4873
|
+
"name": "diagnostic_policy",
|
|
4874
|
+
"flag": "--diagnostic-policy",
|
|
4875
|
+
"in": "body",
|
|
4876
|
+
"type": "object",
|
|
4877
|
+
"required": false
|
|
4878
|
+
},
|
|
4879
|
+
{
|
|
4880
|
+
"name": "Idempotency-Key",
|
|
4881
|
+
"flag": "--idempotency-key",
|
|
4882
|
+
"in": "header",
|
|
4883
|
+
"type": "string",
|
|
4884
|
+
"required": false
|
|
4885
|
+
}
|
|
4886
|
+
],
|
|
4887
|
+
"example_command": "typeship definitions update def_2p8m4q7k1v9d6h3c",
|
|
4321
4888
|
"method": "PATCH",
|
|
4322
4889
|
"path": "/definitions/{definition_id}",
|
|
4323
4890
|
"summary": "Update and resolve a Definition",
|
|
4324
4891
|
"description": "Resolves the complete document graph and records a new immutable revision before saving.",
|
|
4325
4892
|
"safety": "write",
|
|
4326
4893
|
"auth": "required",
|
|
4894
|
+
"security": [
|
|
4895
|
+
{
|
|
4896
|
+
"apiKey": []
|
|
4897
|
+
}
|
|
4898
|
+
],
|
|
4327
4899
|
"paginated": false,
|
|
4328
4900
|
"input_schema": {
|
|
4329
4901
|
"type": "object",
|
|
@@ -4336,6 +4908,13 @@
|
|
|
4336
4908
|
"pattern": "^def_[a-z0-9]{16}$",
|
|
4337
4909
|
"type": "string"
|
|
4338
4910
|
},
|
|
4911
|
+
"Idempotency-Key": {
|
|
4912
|
+
"minLength": 1,
|
|
4913
|
+
"maxLength": 255,
|
|
4914
|
+
"pattern": "^[!-~]+$",
|
|
4915
|
+
"type": "string",
|
|
4916
|
+
"description": "Identifies one logical write for 24 hours. The key is scoped to the authenticated account and operation; account-less generation uses a hashed network identity. Retrying the same method, path, query, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write."
|
|
4917
|
+
},
|
|
4339
4918
|
"source": {
|
|
4340
4919
|
"anyOf": [
|
|
4341
4920
|
{
|
|
@@ -4894,22 +5473,56 @@
|
|
|
4894
5473
|
},
|
|
4895
5474
|
{
|
|
4896
5475
|
"operation": "targets.list",
|
|
4897
|
-
"signature": "
|
|
5476
|
+
"signature": "typeship targets list <project_id> [flags]",
|
|
5477
|
+
"command": [
|
|
5478
|
+
"typeship",
|
|
5479
|
+
"targets",
|
|
5480
|
+
"list"
|
|
5481
|
+
],
|
|
5482
|
+
"parameters": [
|
|
5483
|
+
{
|
|
5484
|
+
"name": "project_id",
|
|
5485
|
+
"positional": true,
|
|
5486
|
+
"in": "path",
|
|
5487
|
+
"type": "string",
|
|
5488
|
+
"required": true
|
|
5489
|
+
},
|
|
5490
|
+
{
|
|
5491
|
+
"name": "limit",
|
|
5492
|
+
"flag": "--limit",
|
|
5493
|
+
"in": "query",
|
|
5494
|
+
"type": "number",
|
|
5495
|
+
"required": false
|
|
5496
|
+
},
|
|
5497
|
+
{
|
|
5498
|
+
"name": "cursor",
|
|
5499
|
+
"flag": "--cursor",
|
|
5500
|
+
"in": "query",
|
|
5501
|
+
"type": "string",
|
|
5502
|
+
"required": false
|
|
5503
|
+
}
|
|
5504
|
+
],
|
|
5505
|
+
"example_command": "typeship targets list prj_4f8k2m7x9q1v6b3n",
|
|
4898
5506
|
"method": "GET",
|
|
4899
5507
|
"path": "/projects/{project_id}/targets",
|
|
4900
5508
|
"summary": "List a project's Targets",
|
|
4901
5509
|
"safety": "read",
|
|
4902
5510
|
"auth": "required",
|
|
5511
|
+
"security": [
|
|
5512
|
+
{
|
|
5513
|
+
"apiKey": []
|
|
5514
|
+
}
|
|
5515
|
+
],
|
|
4903
5516
|
"paginated": true,
|
|
4904
5517
|
"input_schema": {
|
|
4905
5518
|
"type": "object",
|
|
4906
5519
|
"properties": {
|
|
4907
5520
|
"project_id": {
|
|
4908
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
5521
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
4909
5522
|
"examples": [
|
|
5523
|
+
"example-name",
|
|
4910
5524
|
"prj_4f8k2m7x9q1v6b3n"
|
|
4911
5525
|
],
|
|
4912
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
4913
5526
|
"type": "string"
|
|
4914
5527
|
},
|
|
4915
5528
|
"limit": {
|
|
@@ -5020,10 +5633,9 @@
|
|
|
5020
5633
|
"description": "Target-specific overrides merged over Project.config. GraphQL settings are Definition-owned and never appear here.",
|
|
5021
5634
|
"anyOf": [
|
|
5022
5635
|
{
|
|
5023
|
-
"description": "
|
|
5636
|
+
"description": "Target-specific generation and delivery overrides. Authentication may only select a Project-owned OAuth application. OAuth server metadata, applications, and identity policy remain Project-owned. Self-hosted MCP access may be overridden for a Target-specific deployment.",
|
|
5024
5637
|
"properties": {
|
|
5025
5638
|
"globals": {
|
|
5026
|
-
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-apply to every operation that accepts them; per-call values win. Names that match nothing are reported as generation warnings.",
|
|
5027
5639
|
"maxItems": 20,
|
|
5028
5640
|
"type": "array"
|
|
5029
5641
|
},
|
|
@@ -5032,7 +5644,10 @@
|
|
|
5032
5644
|
"type": "object"
|
|
5033
5645
|
},
|
|
5034
5646
|
"pagination": {
|
|
5035
|
-
"
|
|
5647
|
+
"type": "object"
|
|
5648
|
+
},
|
|
5649
|
+
"auth": {
|
|
5650
|
+
"description": "Selects a Project OAuth application for one Target. OAuth server metadata, applications, and identity policy remain Project-owned.",
|
|
5036
5651
|
"type": "object"
|
|
5037
5652
|
},
|
|
5038
5653
|
"cli": {
|
|
@@ -5040,7 +5655,11 @@
|
|
|
5040
5655
|
"type": "object"
|
|
5041
5656
|
},
|
|
5042
5657
|
"mcp": {
|
|
5043
|
-
"description": "How
|
|
5658
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave. Part of Config.",
|
|
5659
|
+
"type": "object"
|
|
5660
|
+
},
|
|
5661
|
+
"readme": {
|
|
5662
|
+
"description": "Generated README behavior. Part of Config.",
|
|
5044
5663
|
"type": "object"
|
|
5045
5664
|
},
|
|
5046
5665
|
"package": {
|
|
@@ -5048,7 +5667,7 @@
|
|
|
5048
5667
|
"type": "object"
|
|
5049
5668
|
},
|
|
5050
5669
|
"docs_url": {
|
|
5051
|
-
"
|
|
5670
|
+
"format": "uri",
|
|
5052
5671
|
"type": [
|
|
5053
5672
|
"string",
|
|
5054
5673
|
"null"
|
|
@@ -5056,7 +5675,6 @@
|
|
|
5056
5675
|
},
|
|
5057
5676
|
"docs_index_url": {
|
|
5058
5677
|
"format": "uri",
|
|
5059
|
-
"description": "Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.",
|
|
5060
5678
|
"type": [
|
|
5061
5679
|
"string",
|
|
5062
5680
|
"null"
|
|
@@ -5071,6 +5689,8 @@
|
|
|
5071
5689
|
]
|
|
5072
5690
|
},
|
|
5073
5691
|
"deliveries": {
|
|
5692
|
+
"description": "At most one repository and one hosted MCP Delivery.",
|
|
5693
|
+
"maxItems": 2,
|
|
5074
5694
|
"items": {
|
|
5075
5695
|
"anyOf": [
|
|
5076
5696
|
{
|
|
@@ -5125,25 +5745,122 @@
|
|
|
5125
5745
|
},
|
|
5126
5746
|
{
|
|
5127
5747
|
"operation": "targets.create",
|
|
5128
|
-
"signature": "
|
|
5748
|
+
"signature": "typeship targets create <project_id> [flags]",
|
|
5749
|
+
"command": [
|
|
5750
|
+
"typeship",
|
|
5751
|
+
"targets",
|
|
5752
|
+
"create"
|
|
5753
|
+
],
|
|
5754
|
+
"parameters": [
|
|
5755
|
+
{
|
|
5756
|
+
"name": "project_id",
|
|
5757
|
+
"positional": true,
|
|
5758
|
+
"in": "path",
|
|
5759
|
+
"type": "string",
|
|
5760
|
+
"required": true
|
|
5761
|
+
},
|
|
5762
|
+
{
|
|
5763
|
+
"name": "name",
|
|
5764
|
+
"flag": "--name",
|
|
5765
|
+
"in": "body",
|
|
5766
|
+
"type": "string",
|
|
5767
|
+
"required": true
|
|
5768
|
+
},
|
|
5769
|
+
{
|
|
5770
|
+
"name": "definition_id",
|
|
5771
|
+
"flag": "--definition-id",
|
|
5772
|
+
"in": "body",
|
|
5773
|
+
"type": "string",
|
|
5774
|
+
"required": true
|
|
5775
|
+
},
|
|
5776
|
+
{
|
|
5777
|
+
"name": "generator",
|
|
5778
|
+
"flag": "--generator",
|
|
5779
|
+
"in": "body",
|
|
5780
|
+
"type": "string",
|
|
5781
|
+
"required": true
|
|
5782
|
+
},
|
|
5783
|
+
{
|
|
5784
|
+
"name": "state",
|
|
5785
|
+
"flag": "--state",
|
|
5786
|
+
"in": "body",
|
|
5787
|
+
"type": "string",
|
|
5788
|
+
"required": false
|
|
5789
|
+
},
|
|
5790
|
+
{
|
|
5791
|
+
"name": "edition",
|
|
5792
|
+
"flag": "--edition",
|
|
5793
|
+
"in": "body",
|
|
5794
|
+
"type": "string",
|
|
5795
|
+
"required": false
|
|
5796
|
+
},
|
|
5797
|
+
{
|
|
5798
|
+
"name": "release_channel",
|
|
5799
|
+
"flag": "--release-channel",
|
|
5800
|
+
"in": "body",
|
|
5801
|
+
"type": "string",
|
|
5802
|
+
"required": false
|
|
5803
|
+
},
|
|
5804
|
+
{
|
|
5805
|
+
"name": "proposed_version",
|
|
5806
|
+
"flag": "--proposed-version",
|
|
5807
|
+
"in": "body",
|
|
5808
|
+
"type": "string",
|
|
5809
|
+
"required": false
|
|
5810
|
+
},
|
|
5811
|
+
{
|
|
5812
|
+
"name": "config",
|
|
5813
|
+
"flag": "--config",
|
|
5814
|
+
"in": "body",
|
|
5815
|
+
"type": "json",
|
|
5816
|
+
"required": false
|
|
5817
|
+
},
|
|
5818
|
+
{
|
|
5819
|
+
"name": "deliveries",
|
|
5820
|
+
"flag": "--deliveries",
|
|
5821
|
+
"in": "body",
|
|
5822
|
+
"type": "array",
|
|
5823
|
+
"required": false
|
|
5824
|
+
},
|
|
5825
|
+
{
|
|
5826
|
+
"name": "Idempotency-Key",
|
|
5827
|
+
"flag": "--idempotency-key",
|
|
5828
|
+
"in": "header",
|
|
5829
|
+
"type": "string",
|
|
5830
|
+
"required": false
|
|
5831
|
+
}
|
|
5832
|
+
],
|
|
5833
|
+
"example_command": "typeship targets create prj_4f8k2m7x9q1v6b3n --name example --definition-id def_2p8m4q7k1v9d6h3c --generator typescript-sdk",
|
|
5129
5834
|
"method": "POST",
|
|
5130
5835
|
"path": "/projects/{project_id}/targets",
|
|
5131
5836
|
"summary": "Create an independently configured Target",
|
|
5132
5837
|
"description": "Several Targets may use the same generator with distinct configuration, Deliveries, and release streams.",
|
|
5133
5838
|
"safety": "write",
|
|
5134
5839
|
"auth": "required",
|
|
5840
|
+
"security": [
|
|
5841
|
+
{
|
|
5842
|
+
"apiKey": []
|
|
5843
|
+
}
|
|
5844
|
+
],
|
|
5135
5845
|
"paginated": false,
|
|
5136
5846
|
"input_schema": {
|
|
5137
5847
|
"type": "object",
|
|
5138
5848
|
"properties": {
|
|
5139
5849
|
"project_id": {
|
|
5140
|
-
"description": "Unique identifier for a project. IDs come from projects_list.",
|
|
5850
|
+
"description": "Unique identifier for a project. Accepts an ID or an exact name (resolved via projects_list). IDs come from projects_list.",
|
|
5141
5851
|
"examples": [
|
|
5852
|
+
"example-name",
|
|
5142
5853
|
"prj_4f8k2m7x9q1v6b3n"
|
|
5143
5854
|
],
|
|
5144
|
-
"pattern": "^prj_[a-z0-9]{16}$",
|
|
5145
5855
|
"type": "string"
|
|
5146
5856
|
},
|
|
5857
|
+
"Idempotency-Key": {
|
|
5858
|
+
"minLength": 1,
|
|
5859
|
+
"maxLength": 255,
|
|
5860
|
+
"pattern": "^[!-~]+$",
|
|
5861
|
+
"type": "string",
|
|
5862
|
+
"description": "Identifies one logical write for 24 hours. The key is scoped to the authenticated account and operation; account-less generation uses a hashed network identity. Retrying the same method, path, query, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write."
|
|
5863
|
+
},
|
|
5147
5864
|
"name": {
|
|
5148
5865
|
"minLength": 1,
|
|
5149
5866
|
"maxLength": 80,
|
|
@@ -5202,10 +5919,9 @@
|
|
|
5202
5919
|
"description": "Target-specific overrides merged over Project.config. GraphQL settings are rejected here and belong to the Definition.",
|
|
5203
5920
|
"anyOf": [
|
|
5204
5921
|
{
|
|
5205
|
-
"description": "
|
|
5922
|
+
"description": "Target-specific generation and delivery overrides. Authentication may only select a Project-owned OAuth application. OAuth server metadata, applications, and identity policy remain Project-owned. Self-hosted MCP access may be overridden for a Target-specific deployment.",
|
|
5206
5923
|
"properties": {
|
|
5207
5924
|
"globals": {
|
|
5208
|
-
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-apply to every operation that accepts them; per-call values win. Names that match nothing are reported as generation warnings.",
|
|
5209
5925
|
"maxItems": 20,
|
|
5210
5926
|
"items": {
|
|
5211
5927
|
"type": "string"
|
|
@@ -5255,54 +5971,49 @@
|
|
|
5255
5971
|
"type": "object"
|
|
5256
5972
|
},
|
|
5257
5973
|
"pagination": {
|
|
5258
|
-
"description": "Per-operation pagination control, keyed by operationId or \"METHOD /path\". Unmatched keys are reported as generation warnings.",
|
|
5259
5974
|
"additionalProperties": {
|
|
5260
5975
|
"anyOf": [
|
|
5261
5976
|
{
|
|
5262
5977
|
"type": "object"
|
|
5263
5978
|
},
|
|
5264
5979
|
{
|
|
5265
|
-
"description": "false disables pagination detection for the operation.",
|
|
5266
5980
|
"type": "boolean"
|
|
5267
5981
|
}
|
|
5268
5982
|
]
|
|
5269
5983
|
},
|
|
5270
5984
|
"type": "object"
|
|
5271
5985
|
},
|
|
5272
|
-
"
|
|
5273
|
-
"description": "
|
|
5986
|
+
"auth": {
|
|
5987
|
+
"description": "Selects a Project OAuth application for one Target. OAuth server metadata, applications, and identity policy remain Project-owned.",
|
|
5274
5988
|
"properties": {
|
|
5275
|
-
"
|
|
5276
|
-
"description": "
|
|
5277
|
-
"
|
|
5278
|
-
|
|
5279
|
-
"null"
|
|
5280
|
-
]
|
|
5281
|
-
},
|
|
5282
|
-
"whoami_operation": {
|
|
5283
|
-
"description": "resource.method of a zero-argument GET that the generated CLI's whoami command calls. Overrides auto-detection; a value that matches nothing is reported as a generation warning.",
|
|
5989
|
+
"oauth_application": {
|
|
5990
|
+
"description": "Project OAuth application to use. Omit to inherit the Project default.",
|
|
5991
|
+
"maxLength": 64,
|
|
5992
|
+
"pattern": "^[a-z][a-z0-9_-]{0,63}$",
|
|
5284
5993
|
"type": [
|
|
5285
5994
|
"string",
|
|
5286
5995
|
"null"
|
|
5287
5996
|
]
|
|
5288
5997
|
},
|
|
5289
|
-
"
|
|
5290
|
-
"description": "OAuth
|
|
5998
|
+
"environments": {
|
|
5999
|
+
"description": "Project OAuth application selections keyed by API environment.",
|
|
6000
|
+
"additionalProperties": {
|
|
6001
|
+
"type": "object"
|
|
6002
|
+
},
|
|
5291
6003
|
"type": [
|
|
5292
|
-
"
|
|
6004
|
+
"object",
|
|
5293
6005
|
"null"
|
|
5294
6006
|
]
|
|
5295
|
-
}
|
|
5296
|
-
|
|
5297
|
-
|
|
5298
|
-
|
|
5299
|
-
|
|
5300
|
-
|
|
5301
|
-
|
|
5302
|
-
|
|
5303
|
-
|
|
5304
|
-
|
|
5305
|
-
"description": "Audience sent with the device-authorization request, for authorization servers that require one to issue API-valid access tokens.",
|
|
6007
|
+
}
|
|
6008
|
+
},
|
|
6009
|
+
"additionalProperties": false,
|
|
6010
|
+
"type": "object"
|
|
6011
|
+
},
|
|
6012
|
+
"cli": {
|
|
6013
|
+
"description": "How the generated CLI behaves. Part of Config.",
|
|
6014
|
+
"properties": {
|
|
6015
|
+
"command_name": {
|
|
6016
|
+
"description": "Command users run, independent of how the CLI is distributed.",
|
|
5306
6017
|
"type": [
|
|
5307
6018
|
"string",
|
|
5308
6019
|
"null"
|
|
@@ -5319,13 +6030,6 @@
|
|
|
5319
6030
|
"null"
|
|
5320
6031
|
]
|
|
5321
6032
|
},
|
|
5322
|
-
"auth_url": {
|
|
5323
|
-
"description": "Base URL of the browser-approval endpoint pair used by CLI login. The CLI keeps the verifier and receives the credential directly; no key is pasted through a conversation.",
|
|
5324
|
-
"type": [
|
|
5325
|
-
"string",
|
|
5326
|
-
"null"
|
|
5327
|
-
]
|
|
5328
|
-
},
|
|
5329
6033
|
"mcp_url": {
|
|
5330
6034
|
"description": "Hosted MCP endpoint installed by the generated CLI instead of launching the package's local stdio server.",
|
|
5331
6035
|
"type": [
|
|
@@ -5345,7 +6049,7 @@
|
|
|
5345
6049
|
"type": "object"
|
|
5346
6050
|
},
|
|
5347
6051
|
"mcp": {
|
|
5348
|
-
"description": "How
|
|
6052
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave. Part of Config.",
|
|
5349
6053
|
"properties": {
|
|
5350
6054
|
"registry_name": {
|
|
5351
6055
|
"description": "Stable official MCP registry name, independent of the server runtime.",
|
|
@@ -5354,6 +6058,37 @@
|
|
|
5354
6058
|
"null"
|
|
5355
6059
|
]
|
|
5356
6060
|
},
|
|
6061
|
+
"access": {
|
|
6062
|
+
"description": "Authorization for callers connecting to a generated MCP server deployed over HTTP. The hosting application resolves upstream API credentials separately at runtime. This setting does not apply to the Typeship-hosted endpoint.",
|
|
6063
|
+
"properties": {
|
|
6064
|
+
"issuer": {
|
|
6065
|
+
"format": "uri",
|
|
6066
|
+
"description": "Exact issuer allowed to sign MCP connection tokens.",
|
|
6067
|
+
"type": "string"
|
|
6068
|
+
},
|
|
6069
|
+
"resource": {
|
|
6070
|
+
"format": "uri",
|
|
6071
|
+
"description": "Canonical public URL of the self-hosted MCP endpoint that connection tokens must target.",
|
|
6072
|
+
"type": "string"
|
|
6073
|
+
},
|
|
6074
|
+
"jwks_url": {
|
|
6075
|
+
"format": "uri",
|
|
6076
|
+
"description": "Public signing-key endpoint. Omit to discover it from the issuer.",
|
|
6077
|
+
"type": "string"
|
|
6078
|
+
},
|
|
6079
|
+
"scopes": {
|
|
6080
|
+
"description": "Minimum scopes required to connect to the self-hosted MCP server.",
|
|
6081
|
+
"maxItems": 20,
|
|
6082
|
+
"type": "array"
|
|
6083
|
+
}
|
|
6084
|
+
},
|
|
6085
|
+
"required": [
|
|
6086
|
+
"issuer",
|
|
6087
|
+
"resource"
|
|
6088
|
+
],
|
|
6089
|
+
"additionalProperties": false,
|
|
6090
|
+
"type": "object"
|
|
6091
|
+
},
|
|
5357
6092
|
"tool_mode": {
|
|
5358
6093
|
"enum": [
|
|
5359
6094
|
"auto",
|
|
@@ -5378,6 +6113,28 @@
|
|
|
5378
6113
|
"type": "string"
|
|
5379
6114
|
},
|
|
5380
6115
|
"type": "object"
|
|
6116
|
+
},
|
|
6117
|
+
"reference_resolvers": {
|
|
6118
|
+
"description": "Exact name-or-ID resolver overrides keyed first by the target operationId or \"METHOD /path\", then by its wire argument name. A resolver names one read collection operation plus 1-4 item fields to match case-insensitively; false opts that argument out of strict inference.",
|
|
6119
|
+
"additionalProperties": {
|
|
6120
|
+
"type": "object"
|
|
6121
|
+
},
|
|
6122
|
+
"type": "object"
|
|
6123
|
+
}
|
|
6124
|
+
},
|
|
6125
|
+
"additionalProperties": false,
|
|
6126
|
+
"type": "object"
|
|
6127
|
+
},
|
|
6128
|
+
"readme": {
|
|
6129
|
+
"description": "Generated README behavior. Part of Config.",
|
|
6130
|
+
"properties": {
|
|
6131
|
+
"quickstart_operation": {
|
|
6132
|
+
"description": "operationId or \"METHOD /path\" to feature as the README's first API call. It must be present in the generated package and callable with no required input beyond path placeholders. Missing or unsuitable choices produce a warning and use the automatic example.",
|
|
6133
|
+
"maxLength": 500,
|
|
6134
|
+
"type": [
|
|
6135
|
+
"string",
|
|
6136
|
+
"null"
|
|
6137
|
+
]
|
|
5381
6138
|
}
|
|
5382
6139
|
},
|
|
5383
6140
|
"additionalProperties": false,
|
|
@@ -5429,7 +6186,7 @@
|
|
|
5429
6186
|
"type": "object"
|
|
5430
6187
|
},
|
|
5431
6188
|
"docs_url": {
|
|
5432
|
-
"
|
|
6189
|
+
"format": "uri",
|
|
5433
6190
|
"type": [
|
|
5434
6191
|
"string",
|
|
5435
6192
|
"null"
|
|
@@ -5437,7 +6194,6 @@
|
|
|
5437
6194
|
},
|
|
5438
6195
|
"docs_index_url": {
|
|
5439
6196
|
"format": "uri",
|
|
5440
|
-
"description": "Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.",
|
|
5441
6197
|
"type": [
|
|
5442
6198
|
"string",
|
|
5443
6199
|
"null"
|
|
@@ -5453,6 +6209,7 @@
|
|
|
5453
6209
|
]
|
|
5454
6210
|
},
|
|
5455
6211
|
"deliveries": {
|
|
6212
|
+
"maxItems": 2,
|
|
5456
6213
|
"items": {
|
|
5457
6214
|
"anyOf": [
|
|
5458
6215
|
{
|
|
@@ -5626,10 +6383,9 @@
|
|
|
5626
6383
|
"description": "Target-specific overrides merged over Project.config.",
|
|
5627
6384
|
"anyOf": [
|
|
5628
6385
|
{
|
|
5629
|
-
"description": "
|
|
6386
|
+
"description": "Target-specific generation and delivery overrides.",
|
|
5630
6387
|
"properties": {
|
|
5631
6388
|
"globals": {
|
|
5632
|
-
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-ap…",
|
|
5633
6389
|
"maxItems": 20,
|
|
5634
6390
|
"type": "array"
|
|
5635
6391
|
},
|
|
@@ -5638,7 +6394,10 @@
|
|
|
5638
6394
|
"type": "object"
|
|
5639
6395
|
},
|
|
5640
6396
|
"pagination": {
|
|
5641
|
-
"
|
|
6397
|
+
"type": "object"
|
|
6398
|
+
},
|
|
6399
|
+
"auth": {
|
|
6400
|
+
"description": "Selects a Project OAuth application for one Target.",
|
|
5642
6401
|
"type": "object"
|
|
5643
6402
|
},
|
|
5644
6403
|
"cli": {
|
|
@@ -5646,7 +6405,11 @@
|
|
|
5646
6405
|
"type": "object"
|
|
5647
6406
|
},
|
|
5648
6407
|
"mcp": {
|
|
5649
|
-
"description": "How
|
|
6408
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave.",
|
|
6409
|
+
"type": "object"
|
|
6410
|
+
},
|
|
6411
|
+
"readme": {
|
|
6412
|
+
"description": "Generated README behavior.",
|
|
5650
6413
|
"type": "object"
|
|
5651
6414
|
},
|
|
5652
6415
|
"package": {
|
|
@@ -5654,7 +6417,7 @@
|
|
|
5654
6417
|
"type": "object"
|
|
5655
6418
|
},
|
|
5656
6419
|
"docs_url": {
|
|
5657
|
-
"
|
|
6420
|
+
"format": "uri",
|
|
5658
6421
|
"type": [
|
|
5659
6422
|
"string",
|
|
5660
6423
|
"null"
|
|
@@ -5662,7 +6425,6 @@
|
|
|
5662
6425
|
},
|
|
5663
6426
|
"docs_index_url": {
|
|
5664
6427
|
"format": "uri",
|
|
5665
|
-
"description": "Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.",
|
|
5666
6428
|
"type": [
|
|
5667
6429
|
"string",
|
|
5668
6430
|
"null"
|
|
@@ -5677,6 +6439,8 @@
|
|
|
5677
6439
|
]
|
|
5678
6440
|
},
|
|
5679
6441
|
"deliveries": {
|
|
6442
|
+
"description": "At most one repository and one hosted MCP Delivery.",
|
|
6443
|
+
"maxItems": 2,
|
|
5680
6444
|
"items": {
|
|
5681
6445
|
"anyOf": [
|
|
5682
6446
|
{
|
|
@@ -5717,18 +6481,38 @@
|
|
|
5717
6481
|
},
|
|
5718
6482
|
{
|
|
5719
6483
|
"operation": "targets.retrieve",
|
|
5720
|
-
"signature": "
|
|
6484
|
+
"signature": "typeship targets retrieve <target_id> [flags]",
|
|
6485
|
+
"command": [
|
|
6486
|
+
"typeship",
|
|
6487
|
+
"targets",
|
|
6488
|
+
"retrieve"
|
|
6489
|
+
],
|
|
6490
|
+
"parameters": [
|
|
6491
|
+
{
|
|
6492
|
+
"name": "target_id",
|
|
6493
|
+
"positional": true,
|
|
6494
|
+
"in": "path",
|
|
6495
|
+
"type": "string",
|
|
6496
|
+
"required": true
|
|
6497
|
+
}
|
|
6498
|
+
],
|
|
6499
|
+
"example_command": "typeship targets retrieve tgt_5m8q2v7k1p9d4h6c",
|
|
5721
6500
|
"method": "GET",
|
|
5722
6501
|
"path": "/targets/{target_id}",
|
|
5723
6502
|
"summary": "Retrieve a Target",
|
|
5724
6503
|
"safety": "read",
|
|
5725
6504
|
"auth": "required",
|
|
6505
|
+
"security": [
|
|
6506
|
+
{
|
|
6507
|
+
"apiKey": []
|
|
6508
|
+
}
|
|
6509
|
+
],
|
|
5726
6510
|
"paginated": false,
|
|
5727
6511
|
"input_schema": {
|
|
5728
6512
|
"type": "object",
|
|
5729
6513
|
"properties": {
|
|
5730
6514
|
"target_id": {
|
|
5731
|
-
"description": "Stable identifier for one configured generated product.
|
|
6515
|
+
"description": "Stable identifier for one configured generated product.",
|
|
5732
6516
|
"examples": [
|
|
5733
6517
|
"tgt_5m8q2v7k1p9d4h6c"
|
|
5734
6518
|
],
|
|
@@ -5827,10 +6611,9 @@
|
|
|
5827
6611
|
"description": "Target-specific overrides merged over Project.config.",
|
|
5828
6612
|
"anyOf": [
|
|
5829
6613
|
{
|
|
5830
|
-
"description": "
|
|
6614
|
+
"description": "Target-specific generation and delivery overrides.",
|
|
5831
6615
|
"properties": {
|
|
5832
6616
|
"globals": {
|
|
5833
|
-
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-ap…",
|
|
5834
6617
|
"maxItems": 20,
|
|
5835
6618
|
"type": "array"
|
|
5836
6619
|
},
|
|
@@ -5839,7 +6622,10 @@
|
|
|
5839
6622
|
"type": "object"
|
|
5840
6623
|
},
|
|
5841
6624
|
"pagination": {
|
|
5842
|
-
"
|
|
6625
|
+
"type": "object"
|
|
6626
|
+
},
|
|
6627
|
+
"auth": {
|
|
6628
|
+
"description": "Selects a Project OAuth application for one Target.",
|
|
5843
6629
|
"type": "object"
|
|
5844
6630
|
},
|
|
5845
6631
|
"cli": {
|
|
@@ -5847,7 +6633,11 @@
|
|
|
5847
6633
|
"type": "object"
|
|
5848
6634
|
},
|
|
5849
6635
|
"mcp": {
|
|
5850
|
-
"description": "How
|
|
6636
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave.",
|
|
6637
|
+
"type": "object"
|
|
6638
|
+
},
|
|
6639
|
+
"readme": {
|
|
6640
|
+
"description": "Generated README behavior.",
|
|
5851
6641
|
"type": "object"
|
|
5852
6642
|
},
|
|
5853
6643
|
"package": {
|
|
@@ -5855,7 +6645,7 @@
|
|
|
5855
6645
|
"type": "object"
|
|
5856
6646
|
},
|
|
5857
6647
|
"docs_url": {
|
|
5858
|
-
"
|
|
6648
|
+
"format": "uri",
|
|
5859
6649
|
"type": [
|
|
5860
6650
|
"string",
|
|
5861
6651
|
"null"
|
|
@@ -5863,7 +6653,6 @@
|
|
|
5863
6653
|
},
|
|
5864
6654
|
"docs_index_url": {
|
|
5865
6655
|
"format": "uri",
|
|
5866
|
-
"description": "Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.",
|
|
5867
6656
|
"type": [
|
|
5868
6657
|
"string",
|
|
5869
6658
|
"null"
|
|
@@ -5878,6 +6667,8 @@
|
|
|
5878
6667
|
]
|
|
5879
6668
|
},
|
|
5880
6669
|
"deliveries": {
|
|
6670
|
+
"description": "At most one repository and one hosted MCP Delivery.",
|
|
6671
|
+
"maxItems": 2,
|
|
5881
6672
|
"items": {
|
|
5882
6673
|
"anyOf": [
|
|
5883
6674
|
{
|
|
@@ -5915,19 +6706,39 @@
|
|
|
5915
6706
|
},
|
|
5916
6707
|
{
|
|
5917
6708
|
"operation": "targets.delete",
|
|
5918
|
-
"signature": "
|
|
6709
|
+
"signature": "typeship targets delete <target_id> [flags]",
|
|
6710
|
+
"command": [
|
|
6711
|
+
"typeship",
|
|
6712
|
+
"targets",
|
|
6713
|
+
"delete"
|
|
6714
|
+
],
|
|
6715
|
+
"parameters": [
|
|
6716
|
+
{
|
|
6717
|
+
"name": "target_id",
|
|
6718
|
+
"positional": true,
|
|
6719
|
+
"in": "path",
|
|
6720
|
+
"type": "string",
|
|
6721
|
+
"required": true
|
|
6722
|
+
}
|
|
6723
|
+
],
|
|
6724
|
+
"example_command": "typeship targets delete tgt_5m8q2v7k1p9d4h6c --force",
|
|
5919
6725
|
"method": "DELETE",
|
|
5920
6726
|
"path": "/targets/{target_id}",
|
|
5921
6727
|
"summary": "Delete an unused Target",
|
|
5922
6728
|
"description": "Targets with Generation or release history, or an active release candidate, must be disabled instead.",
|
|
5923
6729
|
"safety": "destructive",
|
|
5924
6730
|
"auth": "required",
|
|
6731
|
+
"security": [
|
|
6732
|
+
{
|
|
6733
|
+
"apiKey": []
|
|
6734
|
+
}
|
|
6735
|
+
],
|
|
5925
6736
|
"paginated": false,
|
|
5926
6737
|
"input_schema": {
|
|
5927
6738
|
"type": "object",
|
|
5928
6739
|
"properties": {
|
|
5929
6740
|
"target_id": {
|
|
5930
|
-
"description": "Stable identifier for one configured generated product.
|
|
6741
|
+
"description": "Stable identifier for one configured generated product.",
|
|
5931
6742
|
"examples": [
|
|
5932
6743
|
"tgt_5m8q2v7k1p9d4h6c"
|
|
5933
6744
|
],
|
|
@@ -5974,18 +6785,87 @@
|
|
|
5974
6785
|
},
|
|
5975
6786
|
{
|
|
5976
6787
|
"operation": "targets.update",
|
|
5977
|
-
"signature": "
|
|
6788
|
+
"signature": "typeship targets update <target_id> [flags]",
|
|
6789
|
+
"command": [
|
|
6790
|
+
"typeship",
|
|
6791
|
+
"targets",
|
|
6792
|
+
"update"
|
|
6793
|
+
],
|
|
6794
|
+
"parameters": [
|
|
6795
|
+
{
|
|
6796
|
+
"name": "target_id",
|
|
6797
|
+
"positional": true,
|
|
6798
|
+
"in": "path",
|
|
6799
|
+
"type": "string",
|
|
6800
|
+
"required": true
|
|
6801
|
+
},
|
|
6802
|
+
{
|
|
6803
|
+
"name": "name",
|
|
6804
|
+
"flag": "--name",
|
|
6805
|
+
"in": "body",
|
|
6806
|
+
"type": "string",
|
|
6807
|
+
"required": false
|
|
6808
|
+
},
|
|
6809
|
+
{
|
|
6810
|
+
"name": "state",
|
|
6811
|
+
"flag": "--state",
|
|
6812
|
+
"in": "body",
|
|
6813
|
+
"type": "string",
|
|
6814
|
+
"required": false
|
|
6815
|
+
},
|
|
6816
|
+
{
|
|
6817
|
+
"name": "edition",
|
|
6818
|
+
"flag": "--edition",
|
|
6819
|
+
"in": "body",
|
|
6820
|
+
"type": "string",
|
|
6821
|
+
"required": false
|
|
6822
|
+
},
|
|
6823
|
+
{
|
|
6824
|
+
"name": "release_channel",
|
|
6825
|
+
"flag": "--release-channel",
|
|
6826
|
+
"in": "body",
|
|
6827
|
+
"type": "string",
|
|
6828
|
+
"required": false
|
|
6829
|
+
},
|
|
6830
|
+
{
|
|
6831
|
+
"name": "proposed_version",
|
|
6832
|
+
"flag": "--proposed-version",
|
|
6833
|
+
"in": "body",
|
|
6834
|
+
"type": "string",
|
|
6835
|
+
"required": false
|
|
6836
|
+
},
|
|
6837
|
+
{
|
|
6838
|
+
"name": "config",
|
|
6839
|
+
"flag": "--config",
|
|
6840
|
+
"in": "body",
|
|
6841
|
+
"type": "json",
|
|
6842
|
+
"required": false
|
|
6843
|
+
},
|
|
6844
|
+
{
|
|
6845
|
+
"name": "deliveries",
|
|
6846
|
+
"flag": "--deliveries",
|
|
6847
|
+
"in": "body",
|
|
6848
|
+
"type": "array",
|
|
6849
|
+
"required": false
|
|
6850
|
+
}
|
|
6851
|
+
],
|
|
6852
|
+
"example_command": "typeship targets update tgt_5m8q2v7k1p9d4h6c",
|
|
5978
6853
|
"method": "PATCH",
|
|
5979
6854
|
"path": "/targets/{target_id}",
|
|
5980
6855
|
"summary": "Update a Target, its Deliveries, or its next reviewed version",
|
|
5981
6856
|
"safety": "write",
|
|
5982
6857
|
"auth": "required",
|
|
6858
|
+
"security": [
|
|
6859
|
+
{
|
|
6860
|
+
"apiKey": []
|
|
6861
|
+
}
|
|
6862
|
+
],
|
|
5983
6863
|
"paginated": false,
|
|
5984
6864
|
"input_schema": {
|
|
5985
6865
|
"type": "object",
|
|
5986
6866
|
"properties": {
|
|
5987
6867
|
"target_id": {
|
|
5988
|
-
"description": "Stable identifier for one configured generated product.
|
|
6868
|
+
"description": "Stable identifier for one configured generated product.",
|
|
5989
6869
|
"examples": [
|
|
5990
6870
|
"tgt_5m8q2v7k1p9d4h6c"
|
|
5991
6871
|
],
|
|
@@ -6024,10 +6904,9 @@
|
|
|
6024
6904
|
"description": "Target-specific overrides merged over Project.config. GraphQL settings are rejected here and belong to the Definition.",
|
|
6025
6905
|
"anyOf": [
|
|
6026
6906
|
{
|
|
6027
|
-
"description": "
|
|
6907
|
+
"description": "Target-specific generation and delivery overrides. Authentication may only select a Project-owned OAuth application. OAuth server metadata, applications, and identity policy remain Project-owned. Self-hosted MCP access may be overridden for a Target-specific deployment.",
|
|
6028
6908
|
"properties": {
|
|
6029
6909
|
"globals": {
|
|
6030
|
-
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-apply to every operation that accepts them; per-call values win. Names that match nothing are reported as generation warnings.",
|
|
6031
6910
|
"maxItems": 20,
|
|
6032
6911
|
"items": {
|
|
6033
6912
|
"type": "string"
|
|
@@ -6077,54 +6956,49 @@
|
|
|
6077
6956
|
"type": "object"
|
|
6078
6957
|
},
|
|
6079
6958
|
"pagination": {
|
|
6080
|
-
"description": "Per-operation pagination control, keyed by operationId or \"METHOD /path\". Unmatched keys are reported as generation warnings.",
|
|
6081
6959
|
"additionalProperties": {
|
|
6082
6960
|
"anyOf": [
|
|
6083
6961
|
{
|
|
6084
6962
|
"type": "object"
|
|
6085
6963
|
},
|
|
6086
6964
|
{
|
|
6087
|
-
"description": "false disables pagination detection for the operation.",
|
|
6088
6965
|
"type": "boolean"
|
|
6089
6966
|
}
|
|
6090
6967
|
]
|
|
6091
6968
|
},
|
|
6092
6969
|
"type": "object"
|
|
6093
6970
|
},
|
|
6094
|
-
"
|
|
6095
|
-
"description": "
|
|
6971
|
+
"auth": {
|
|
6972
|
+
"description": "Selects a Project OAuth application for one Target. OAuth server metadata, applications, and identity policy remain Project-owned.",
|
|
6096
6973
|
"properties": {
|
|
6097
|
-
"
|
|
6098
|
-
"description": "
|
|
6099
|
-
"
|
|
6100
|
-
|
|
6101
|
-
"null"
|
|
6102
|
-
]
|
|
6103
|
-
},
|
|
6104
|
-
"whoami_operation": {
|
|
6105
|
-
"description": "resource.method of a zero-argument GET that the generated CLI's whoami command calls. Overrides auto-detection; a value that matches nothing is reported as a generation warning.",
|
|
6974
|
+
"oauth_application": {
|
|
6975
|
+
"description": "Project OAuth application to use. Omit to inherit the Project default.",
|
|
6976
|
+
"maxLength": 64,
|
|
6977
|
+
"pattern": "^[a-z][a-z0-9_-]{0,63}$",
|
|
6106
6978
|
"type": [
|
|
6107
6979
|
"string",
|
|
6108
6980
|
"null"
|
|
6109
6981
|
]
|
|
6110
6982
|
},
|
|
6111
|
-
"
|
|
6112
|
-
"description": "OAuth
|
|
6983
|
+
"environments": {
|
|
6984
|
+
"description": "Project OAuth application selections keyed by API environment.",
|
|
6985
|
+
"additionalProperties": {
|
|
6986
|
+
"type": "object"
|
|
6987
|
+
},
|
|
6113
6988
|
"type": [
|
|
6114
|
-
"
|
|
6989
|
+
"object",
|
|
6115
6990
|
"null"
|
|
6116
6991
|
]
|
|
6117
|
-
}
|
|
6118
|
-
|
|
6119
|
-
|
|
6120
|
-
|
|
6121
|
-
|
|
6122
|
-
|
|
6123
|
-
|
|
6124
|
-
|
|
6125
|
-
|
|
6126
|
-
|
|
6127
|
-
"description": "Audience sent with the device-authorization request, for authorization servers that require one to issue API-valid access tokens.",
|
|
6992
|
+
}
|
|
6993
|
+
},
|
|
6994
|
+
"additionalProperties": false,
|
|
6995
|
+
"type": "object"
|
|
6996
|
+
},
|
|
6997
|
+
"cli": {
|
|
6998
|
+
"description": "How the generated CLI behaves. Part of Config.",
|
|
6999
|
+
"properties": {
|
|
7000
|
+
"command_name": {
|
|
7001
|
+
"description": "Command users run, independent of how the CLI is distributed.",
|
|
6128
7002
|
"type": [
|
|
6129
7003
|
"string",
|
|
6130
7004
|
"null"
|
|
@@ -6141,13 +7015,6 @@
|
|
|
6141
7015
|
"null"
|
|
6142
7016
|
]
|
|
6143
7017
|
},
|
|
6144
|
-
"auth_url": {
|
|
6145
|
-
"description": "Base URL of the browser-approval endpoint pair used by CLI login. The CLI keeps the verifier and receives the credential directly; no key is pasted through a conversation.",
|
|
6146
|
-
"type": [
|
|
6147
|
-
"string",
|
|
6148
|
-
"null"
|
|
6149
|
-
]
|
|
6150
|
-
},
|
|
6151
7018
|
"mcp_url": {
|
|
6152
7019
|
"description": "Hosted MCP endpoint installed by the generated CLI instead of launching the package's local stdio server.",
|
|
6153
7020
|
"type": [
|
|
@@ -6167,7 +7034,7 @@
|
|
|
6167
7034
|
"type": "object"
|
|
6168
7035
|
},
|
|
6169
7036
|
"mcp": {
|
|
6170
|
-
"description": "How
|
|
7037
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave. Part of Config.",
|
|
6171
7038
|
"properties": {
|
|
6172
7039
|
"registry_name": {
|
|
6173
7040
|
"description": "Stable official MCP registry name, independent of the server runtime.",
|
|
@@ -6176,6 +7043,37 @@
|
|
|
6176
7043
|
"null"
|
|
6177
7044
|
]
|
|
6178
7045
|
},
|
|
7046
|
+
"access": {
|
|
7047
|
+
"description": "Authorization for callers connecting to a generated MCP server deployed over HTTP. The hosting application resolves upstream API credentials separately at runtime. This setting does not apply to the Typeship-hosted endpoint.",
|
|
7048
|
+
"properties": {
|
|
7049
|
+
"issuer": {
|
|
7050
|
+
"format": "uri",
|
|
7051
|
+
"description": "Exact issuer allowed to sign MCP connection tokens.",
|
|
7052
|
+
"type": "string"
|
|
7053
|
+
},
|
|
7054
|
+
"resource": {
|
|
7055
|
+
"format": "uri",
|
|
7056
|
+
"description": "Canonical public URL of the self-hosted MCP endpoint that connection tokens must target.",
|
|
7057
|
+
"type": "string"
|
|
7058
|
+
},
|
|
7059
|
+
"jwks_url": {
|
|
7060
|
+
"format": "uri",
|
|
7061
|
+
"description": "Public signing-key endpoint. Omit to discover it from the issuer.",
|
|
7062
|
+
"type": "string"
|
|
7063
|
+
},
|
|
7064
|
+
"scopes": {
|
|
7065
|
+
"description": "Minimum scopes required to connect to the self-hosted MCP server.",
|
|
7066
|
+
"maxItems": 20,
|
|
7067
|
+
"type": "array"
|
|
7068
|
+
}
|
|
7069
|
+
},
|
|
7070
|
+
"required": [
|
|
7071
|
+
"issuer",
|
|
7072
|
+
"resource"
|
|
7073
|
+
],
|
|
7074
|
+
"additionalProperties": false,
|
|
7075
|
+
"type": "object"
|
|
7076
|
+
},
|
|
6179
7077
|
"tool_mode": {
|
|
6180
7078
|
"enum": [
|
|
6181
7079
|
"auto",
|
|
@@ -6200,6 +7098,28 @@
|
|
|
6200
7098
|
"type": "string"
|
|
6201
7099
|
},
|
|
6202
7100
|
"type": "object"
|
|
7101
|
+
},
|
|
7102
|
+
"reference_resolvers": {
|
|
7103
|
+
"description": "Exact name-or-ID resolver overrides keyed first by the target operationId or \"METHOD /path\", then by its wire argument name. A resolver names one read collection operation plus 1-4 item fields to match case-insensitively; false opts that argument out of strict inference.",
|
|
7104
|
+
"additionalProperties": {
|
|
7105
|
+
"type": "object"
|
|
7106
|
+
},
|
|
7107
|
+
"type": "object"
|
|
7108
|
+
}
|
|
7109
|
+
},
|
|
7110
|
+
"additionalProperties": false,
|
|
7111
|
+
"type": "object"
|
|
7112
|
+
},
|
|
7113
|
+
"readme": {
|
|
7114
|
+
"description": "Generated README behavior. Part of Config.",
|
|
7115
|
+
"properties": {
|
|
7116
|
+
"quickstart_operation": {
|
|
7117
|
+
"description": "operationId or \"METHOD /path\" to feature as the README's first API call. It must be present in the generated package and callable with no required input beyond path placeholders. Missing or unsuitable choices produce a warning and use the automatic example.",
|
|
7118
|
+
"maxLength": 500,
|
|
7119
|
+
"type": [
|
|
7120
|
+
"string",
|
|
7121
|
+
"null"
|
|
7122
|
+
]
|
|
6203
7123
|
}
|
|
6204
7124
|
},
|
|
6205
7125
|
"additionalProperties": false,
|
|
@@ -6251,7 +7171,7 @@
|
|
|
6251
7171
|
"type": "object"
|
|
6252
7172
|
},
|
|
6253
7173
|
"docs_url": {
|
|
6254
|
-
"
|
|
7174
|
+
"format": "uri",
|
|
6255
7175
|
"type": [
|
|
6256
7176
|
"string",
|
|
6257
7177
|
"null"
|
|
@@ -6259,7 +7179,6 @@
|
|
|
6259
7179
|
},
|
|
6260
7180
|
"docs_index_url": {
|
|
6261
7181
|
"format": "uri",
|
|
6262
|
-
"description": "Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.",
|
|
6263
7182
|
"type": [
|
|
6264
7183
|
"string",
|
|
6265
7184
|
"null"
|
|
@@ -6275,6 +7194,7 @@
|
|
|
6275
7194
|
]
|
|
6276
7195
|
},
|
|
6277
7196
|
"deliveries": {
|
|
7197
|
+
"maxItems": 2,
|
|
6278
7198
|
"items": {
|
|
6279
7199
|
"anyOf": [
|
|
6280
7200
|
{
|
|
@@ -6445,10 +7365,9 @@
|
|
|
6445
7365
|
"description": "Target-specific overrides merged over Project.config.",
|
|
6446
7366
|
"anyOf": [
|
|
6447
7367
|
{
|
|
6448
|
-
"description": "
|
|
7368
|
+
"description": "Target-specific generation and delivery overrides.",
|
|
6449
7369
|
"properties": {
|
|
6450
7370
|
"globals": {
|
|
6451
|
-
"description": "Wire names of query/header parameters that become settable once on the generated client and auto-ap…",
|
|
6452
7371
|
"maxItems": 20,
|
|
6453
7372
|
"type": "array"
|
|
6454
7373
|
},
|
|
@@ -6457,7 +7376,10 @@
|
|
|
6457
7376
|
"type": "object"
|
|
6458
7377
|
},
|
|
6459
7378
|
"pagination": {
|
|
6460
|
-
"
|
|
7379
|
+
"type": "object"
|
|
7380
|
+
},
|
|
7381
|
+
"auth": {
|
|
7382
|
+
"description": "Selects a Project OAuth application for one Target.",
|
|
6461
7383
|
"type": "object"
|
|
6462
7384
|
},
|
|
6463
7385
|
"cli": {
|
|
@@ -6465,7 +7387,11 @@
|
|
|
6465
7387
|
"type": "object"
|
|
6466
7388
|
},
|
|
6467
7389
|
"mcp": {
|
|
6468
|
-
"description": "How
|
|
7390
|
+
"description": "How generated MCP servers and the Typeship-hosted endpoint behave.",
|
|
7391
|
+
"type": "object"
|
|
7392
|
+
},
|
|
7393
|
+
"readme": {
|
|
7394
|
+
"description": "Generated README behavior.",
|
|
6469
7395
|
"type": "object"
|
|
6470
7396
|
},
|
|
6471
7397
|
"package": {
|
|
@@ -6473,7 +7399,7 @@
|
|
|
6473
7399
|
"type": "object"
|
|
6474
7400
|
},
|
|
6475
7401
|
"docs_url": {
|
|
6476
|
-
"
|
|
7402
|
+
"format": "uri",
|
|
6477
7403
|
"type": [
|
|
6478
7404
|
"string",
|
|
6479
7405
|
"null"
|
|
@@ -6481,7 +7407,6 @@
|
|
|
6481
7407
|
},
|
|
6482
7408
|
"docs_index_url": {
|
|
6483
7409
|
"format": "uri",
|
|
6484
|
-
"description": "Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.",
|
|
6485
7410
|
"type": [
|
|
6486
7411
|
"string",
|
|
6487
7412
|
"null"
|
|
@@ -6496,6 +7421,8 @@
|
|
|
6496
7421
|
]
|
|
6497
7422
|
},
|
|
6498
7423
|
"deliveries": {
|
|
7424
|
+
"description": "At most one repository and one hosted MCP Delivery.",
|
|
7425
|
+
"maxItems": 2,
|
|
6499
7426
|
"items": {
|
|
6500
7427
|
"anyOf": [
|
|
6501
7428
|
{
|
|
@@ -6533,18 +7460,52 @@
|
|
|
6533
7460
|
},
|
|
6534
7461
|
{
|
|
6535
7462
|
"operation": "targets.listReleases",
|
|
6536
|
-
"signature": "
|
|
7463
|
+
"signature": "typeship targets list-releases <target_id> [flags]",
|
|
7464
|
+
"command": [
|
|
7465
|
+
"typeship",
|
|
7466
|
+
"targets",
|
|
7467
|
+
"list-releases"
|
|
7468
|
+
],
|
|
7469
|
+
"parameters": [
|
|
7470
|
+
{
|
|
7471
|
+
"name": "target_id",
|
|
7472
|
+
"positional": true,
|
|
7473
|
+
"in": "path",
|
|
7474
|
+
"type": "string",
|
|
7475
|
+
"required": true
|
|
7476
|
+
},
|
|
7477
|
+
{
|
|
7478
|
+
"name": "limit",
|
|
7479
|
+
"flag": "--limit",
|
|
7480
|
+
"in": "query",
|
|
7481
|
+
"type": "number",
|
|
7482
|
+
"required": false
|
|
7483
|
+
},
|
|
7484
|
+
{
|
|
7485
|
+
"name": "cursor",
|
|
7486
|
+
"flag": "--cursor",
|
|
7487
|
+
"in": "query",
|
|
7488
|
+
"type": "string",
|
|
7489
|
+
"required": false
|
|
7490
|
+
}
|
|
7491
|
+
],
|
|
7492
|
+
"example_command": "typeship targets list-releases tgt_5m8q2v7k1p9d4h6c",
|
|
6537
7493
|
"method": "GET",
|
|
6538
7494
|
"path": "/targets/{target_id}/releases",
|
|
6539
7495
|
"summary": "List immutable releases for a Target",
|
|
6540
7496
|
"safety": "read",
|
|
6541
7497
|
"auth": "required",
|
|
7498
|
+
"security": [
|
|
7499
|
+
{
|
|
7500
|
+
"apiKey": []
|
|
7501
|
+
}
|
|
7502
|
+
],
|
|
6542
7503
|
"paginated": true,
|
|
6543
7504
|
"input_schema": {
|
|
6544
7505
|
"type": "object",
|
|
6545
7506
|
"properties": {
|
|
6546
7507
|
"target_id": {
|
|
6547
|
-
"description": "Stable identifier for one configured generated product.
|
|
7508
|
+
"description": "Stable identifier for one configured generated product.",
|
|
6548
7509
|
"examples": [
|
|
6549
7510
|
"tgt_5m8q2v7k1p9d4h6c"
|
|
6550
7511
|
],
|
|
@@ -6700,12 +7661,32 @@
|
|
|
6700
7661
|
},
|
|
6701
7662
|
{
|
|
6702
7663
|
"operation": "targets.retrieveRelease",
|
|
6703
|
-
"signature": "
|
|
7664
|
+
"signature": "typeship targets retrieve-release <target_release_id> [flags]",
|
|
7665
|
+
"command": [
|
|
7666
|
+
"typeship",
|
|
7667
|
+
"targets",
|
|
7668
|
+
"retrieve-release"
|
|
7669
|
+
],
|
|
7670
|
+
"parameters": [
|
|
7671
|
+
{
|
|
7672
|
+
"name": "target_release_id",
|
|
7673
|
+
"positional": true,
|
|
7674
|
+
"in": "path",
|
|
7675
|
+
"type": "string",
|
|
7676
|
+
"required": true
|
|
7677
|
+
}
|
|
7678
|
+
],
|
|
7679
|
+
"example_command": "typeship targets retrieve-release rel_7m2q8v4k1p9d5h6c",
|
|
6704
7680
|
"method": "GET",
|
|
6705
7681
|
"path": "/target_releases/{target_release_id}",
|
|
6706
7682
|
"summary": "Retrieve an immutable Target release",
|
|
6707
7683
|
"safety": "read",
|
|
6708
7684
|
"auth": "required",
|
|
7685
|
+
"security": [
|
|
7686
|
+
{
|
|
7687
|
+
"apiKey": []
|
|
7688
|
+
}
|
|
7689
|
+
],
|
|
6709
7690
|
"paginated": false,
|
|
6710
7691
|
"input_schema": {
|
|
6711
7692
|
"type": "object",
|
|
@@ -6833,13 +7814,33 @@
|
|
|
6833
7814
|
},
|
|
6834
7815
|
{
|
|
6835
7816
|
"operation": "generations.retrieve",
|
|
6836
|
-
"signature": "
|
|
7817
|
+
"signature": "typeship generations retrieve <generation_id> [flags]",
|
|
7818
|
+
"command": [
|
|
7819
|
+
"typeship",
|
|
7820
|
+
"generations",
|
|
7821
|
+
"retrieve"
|
|
7822
|
+
],
|
|
7823
|
+
"parameters": [
|
|
7824
|
+
{
|
|
7825
|
+
"name": "generation_id",
|
|
7826
|
+
"positional": true,
|
|
7827
|
+
"in": "path",
|
|
7828
|
+
"type": "string",
|
|
7829
|
+
"required": true
|
|
7830
|
+
}
|
|
7831
|
+
],
|
|
7832
|
+
"example_command": "typeship generations retrieve gen_7h2p5d9c3m8w1k6q",
|
|
6837
7833
|
"method": "GET",
|
|
6838
7834
|
"path": "/generations/{generation_id}",
|
|
6839
7835
|
"summary": "Retrieve a generation",
|
|
6840
7836
|
"description": "Includes the generated files when the generation succeeded.",
|
|
6841
7837
|
"safety": "read",
|
|
6842
7838
|
"auth": "required",
|
|
7839
|
+
"security": [
|
|
7840
|
+
{
|
|
7841
|
+
"apiKey": []
|
|
7842
|
+
}
|
|
7843
|
+
],
|
|
6843
7844
|
"paginated": false,
|
|
6844
7845
|
"input_schema": {
|
|
6845
7846
|
"type": "object",
|
|
@@ -7052,13 +8053,40 @@
|
|
|
7052
8053
|
},
|
|
7053
8054
|
{
|
|
7054
8055
|
"operation": "generations.retrieveFile",
|
|
7055
|
-
"signature": "
|
|
8056
|
+
"signature": "typeship generations retrieve-file <generation_id> [flags]",
|
|
8057
|
+
"command": [
|
|
8058
|
+
"typeship",
|
|
8059
|
+
"generations",
|
|
8060
|
+
"retrieve-file"
|
|
8061
|
+
],
|
|
8062
|
+
"parameters": [
|
|
8063
|
+
{
|
|
8064
|
+
"name": "generation_id",
|
|
8065
|
+
"positional": true,
|
|
8066
|
+
"in": "path",
|
|
8067
|
+
"type": "string",
|
|
8068
|
+
"required": true
|
|
8069
|
+
},
|
|
8070
|
+
{
|
|
8071
|
+
"name": "path",
|
|
8072
|
+
"flag": "--path",
|
|
8073
|
+
"in": "query",
|
|
8074
|
+
"type": "string",
|
|
8075
|
+
"required": true
|
|
8076
|
+
}
|
|
8077
|
+
],
|
|
8078
|
+
"example_command": "typeship generations retrieve-file gen_7h2p5d9c3m8w1k6q --path openapi.yaml",
|
|
7056
8079
|
"method": "GET",
|
|
7057
8080
|
"path": "/generations/{generation_id}/file",
|
|
7058
8081
|
"summary": "Fetch one file from a generation",
|
|
7059
8082
|
"description": "Raw file content, for generations whose target was too large to inline (files_omitted true). The generation's files_index lists valid paths.",
|
|
7060
8083
|
"safety": "read",
|
|
7061
8084
|
"auth": "required",
|
|
8085
|
+
"security": [
|
|
8086
|
+
{
|
|
8087
|
+
"apiKey": []
|
|
8088
|
+
}
|
|
8089
|
+
],
|
|
7062
8090
|
"paginated": false,
|
|
7063
8091
|
"input_schema": {
|
|
7064
8092
|
"type": "object",
|
|
@@ -7088,13 +8116,47 @@
|
|
|
7088
8116
|
},
|
|
7089
8117
|
{
|
|
7090
8118
|
"operation": "definitionRevisions.list",
|
|
7091
|
-
"signature": "
|
|
8119
|
+
"signature": "typeship definition-revisions list <definition_id> [flags]",
|
|
8120
|
+
"command": [
|
|
8121
|
+
"typeship",
|
|
8122
|
+
"definition-revisions",
|
|
8123
|
+
"list"
|
|
8124
|
+
],
|
|
8125
|
+
"parameters": [
|
|
8126
|
+
{
|
|
8127
|
+
"name": "definition_id",
|
|
8128
|
+
"positional": true,
|
|
8129
|
+
"in": "path",
|
|
8130
|
+
"type": "string",
|
|
8131
|
+
"required": true
|
|
8132
|
+
},
|
|
8133
|
+
{
|
|
8134
|
+
"name": "limit",
|
|
8135
|
+
"flag": "--limit",
|
|
8136
|
+
"in": "query",
|
|
8137
|
+
"type": "number",
|
|
8138
|
+
"required": false
|
|
8139
|
+
},
|
|
8140
|
+
{
|
|
8141
|
+
"name": "cursor",
|
|
8142
|
+
"flag": "--cursor",
|
|
8143
|
+
"in": "query",
|
|
8144
|
+
"type": "string",
|
|
8145
|
+
"required": false
|
|
8146
|
+
}
|
|
8147
|
+
],
|
|
8148
|
+
"example_command": "typeship definition-revisions list def_2p8m4q7k1v9d6h3c",
|
|
7092
8149
|
"method": "GET",
|
|
7093
8150
|
"path": "/definitions/{definition_id}/revisions",
|
|
7094
8151
|
"summary": "List Definition Revisions",
|
|
7095
8152
|
"description": "Immutable snapshots of the complete resolved document graph this Definition observed, newest first. Content is available from the revision and document endpoints and is never embedded in a list response.",
|
|
7096
8153
|
"safety": "read",
|
|
7097
8154
|
"auth": "required",
|
|
8155
|
+
"security": [
|
|
8156
|
+
{
|
|
8157
|
+
"apiKey": []
|
|
8158
|
+
}
|
|
8159
|
+
],
|
|
7098
8160
|
"paginated": true,
|
|
7099
8161
|
"input_schema": {
|
|
7100
8162
|
"type": "object",
|
|
@@ -7274,19 +8336,39 @@
|
|
|
7274
8336
|
},
|
|
7275
8337
|
{
|
|
7276
8338
|
"operation": "definitionRevisions.retrieve",
|
|
7277
|
-
"signature": "
|
|
8339
|
+
"signature": "typeship definition-revisions retrieve <definition_revision_id> [flags]",
|
|
8340
|
+
"command": [
|
|
8341
|
+
"typeship",
|
|
8342
|
+
"definition-revisions",
|
|
8343
|
+
"retrieve"
|
|
8344
|
+
],
|
|
8345
|
+
"parameters": [
|
|
8346
|
+
{
|
|
8347
|
+
"name": "definition_revision_id",
|
|
8348
|
+
"positional": true,
|
|
8349
|
+
"in": "path",
|
|
8350
|
+
"type": "string",
|
|
8351
|
+
"required": true
|
|
8352
|
+
}
|
|
8353
|
+
],
|
|
8354
|
+
"example_command": "typeship definition-revisions retrieve drev_6m1q8v4k2p9d7h3c",
|
|
7278
8355
|
"method": "GET",
|
|
7279
8356
|
"path": "/definition_revisions/{definition_revision_id}",
|
|
7280
8357
|
"summary": "Retrieve a Definition Revision",
|
|
7281
8358
|
"description": "Metadata for one immutable resolved document graph. Fetch its canonical content or individual source documents from the content endpoints.",
|
|
7282
8359
|
"safety": "read",
|
|
7283
8360
|
"auth": "required",
|
|
8361
|
+
"security": [
|
|
8362
|
+
{
|
|
8363
|
+
"apiKey": []
|
|
8364
|
+
}
|
|
8365
|
+
],
|
|
7284
8366
|
"paginated": false,
|
|
7285
8367
|
"input_schema": {
|
|
7286
8368
|
"type": "object",
|
|
7287
8369
|
"properties": {
|
|
7288
8370
|
"definition_revision_id": {
|
|
7289
|
-
"description": "Unique identifier for an immutable resolved Definition Revision.
|
|
8371
|
+
"description": "Unique identifier for an immutable resolved Definition Revision.",
|
|
7290
8372
|
"examples": [
|
|
7291
8373
|
"drev_6m1q8v4k2p9d7h3c"
|
|
7292
8374
|
],
|
|
@@ -7464,19 +8546,39 @@
|
|
|
7464
8546
|
},
|
|
7465
8547
|
{
|
|
7466
8548
|
"operation": "definitionRevisions.retrieveContent",
|
|
7467
|
-
"signature": "
|
|
8549
|
+
"signature": "typeship definition-revisions retrieve-content <definition_revision_id> [flags]",
|
|
8550
|
+
"command": [
|
|
8551
|
+
"typeship",
|
|
8552
|
+
"definition-revisions",
|
|
8553
|
+
"retrieve-content"
|
|
8554
|
+
],
|
|
8555
|
+
"parameters": [
|
|
8556
|
+
{
|
|
8557
|
+
"name": "definition_revision_id",
|
|
8558
|
+
"positional": true,
|
|
8559
|
+
"in": "path",
|
|
8560
|
+
"type": "string",
|
|
8561
|
+
"required": true
|
|
8562
|
+
}
|
|
8563
|
+
],
|
|
8564
|
+
"example_command": "typeship definition-revisions retrieve-content drev_6m1q8v4k2p9d7h3c",
|
|
7468
8565
|
"method": "GET",
|
|
7469
8566
|
"path": "/definition_revisions/{definition_revision_id}/content",
|
|
7470
8567
|
"summary": "Retrieve a Definition Revision's canonical content",
|
|
7471
8568
|
"description": "Returns the exact canonical resolved content identified by the revision's graph digest, suitable for saving or piping into a diff.",
|
|
7472
8569
|
"safety": "read",
|
|
7473
8570
|
"auth": "required",
|
|
8571
|
+
"security": [
|
|
8572
|
+
{
|
|
8573
|
+
"apiKey": []
|
|
8574
|
+
}
|
|
8575
|
+
],
|
|
7474
8576
|
"paginated": false,
|
|
7475
8577
|
"input_schema": {
|
|
7476
8578
|
"type": "object",
|
|
7477
8579
|
"properties": {
|
|
7478
8580
|
"definition_revision_id": {
|
|
7479
|
-
"description": "Unique identifier for an immutable resolved Definition Revision.
|
|
8581
|
+
"description": "Unique identifier for an immutable resolved Definition Revision.",
|
|
7480
8582
|
"examples": [
|
|
7481
8583
|
"drev_6m1q8v4k2p9d7h3c"
|
|
7482
8584
|
],
|
|
@@ -7494,18 +8596,45 @@
|
|
|
7494
8596
|
},
|
|
7495
8597
|
{
|
|
7496
8598
|
"operation": "definitionRevisions.retrieveDocumentContent",
|
|
7497
|
-
"signature": "
|
|
8599
|
+
"signature": "typeship definition-revisions retrieve-document-content <definition_revision_id> <document_id> [flags]",
|
|
8600
|
+
"command": [
|
|
8601
|
+
"typeship",
|
|
8602
|
+
"definition-revisions",
|
|
8603
|
+
"retrieve-document-content"
|
|
8604
|
+
],
|
|
8605
|
+
"parameters": [
|
|
8606
|
+
{
|
|
8607
|
+
"name": "definition_revision_id",
|
|
8608
|
+
"positional": true,
|
|
8609
|
+
"in": "path",
|
|
8610
|
+
"type": "string",
|
|
8611
|
+
"required": true
|
|
8612
|
+
},
|
|
8613
|
+
{
|
|
8614
|
+
"name": "document_id",
|
|
8615
|
+
"positional": true,
|
|
8616
|
+
"in": "path",
|
|
8617
|
+
"type": "string",
|
|
8618
|
+
"required": true
|
|
8619
|
+
}
|
|
8620
|
+
],
|
|
8621
|
+
"example_command": "typeship definition-revisions retrieve-document-content drev_6m1q8v4k2p9d7h3c doc_8q2m5v1k9p4d7h3c",
|
|
7498
8622
|
"method": "GET",
|
|
7499
8623
|
"path": "/definition_revisions/{definition_revision_id}/documents/{document_id}/content",
|
|
7500
8624
|
"summary": "Retrieve one source document from a Definition Revision",
|
|
7501
8625
|
"safety": "read",
|
|
7502
8626
|
"auth": "required",
|
|
8627
|
+
"security": [
|
|
8628
|
+
{
|
|
8629
|
+
"apiKey": []
|
|
8630
|
+
}
|
|
8631
|
+
],
|
|
7503
8632
|
"paginated": false,
|
|
7504
8633
|
"input_schema": {
|
|
7505
8634
|
"type": "object",
|
|
7506
8635
|
"properties": {
|
|
7507
8636
|
"definition_revision_id": {
|
|
7508
|
-
"description": "Unique identifier for an immutable resolved Definition Revision.
|
|
8637
|
+
"description": "Unique identifier for an immutable resolved Definition Revision.",
|
|
7509
8638
|
"examples": [
|
|
7510
8639
|
"drev_6m1q8v4k2p9d7h3c"
|
|
7511
8640
|
],
|
|
@@ -7533,13 +8662,25 @@
|
|
|
7533
8662
|
},
|
|
7534
8663
|
{
|
|
7535
8664
|
"operation": "account.retrieve",
|
|
7536
|
-
"signature": "
|
|
8665
|
+
"signature": "typeship account retrieve [flags]",
|
|
8666
|
+
"command": [
|
|
8667
|
+
"typeship",
|
|
8668
|
+
"account",
|
|
8669
|
+
"retrieve"
|
|
8670
|
+
],
|
|
8671
|
+
"parameters": [],
|
|
8672
|
+
"example_command": "typeship account retrieve",
|
|
7537
8673
|
"method": "GET",
|
|
7538
8674
|
"path": "/me",
|
|
7539
8675
|
"summary": "The account behind the presented credentials",
|
|
7540
8676
|
"description": "Returns the account that owns the presented API key. This is also the\nidentity endpoint the generated typeship CLI's `whoami` calls.",
|
|
7541
8677
|
"safety": "read",
|
|
7542
8678
|
"auth": "required",
|
|
8679
|
+
"security": [
|
|
8680
|
+
{
|
|
8681
|
+
"apiKey": []
|
|
8682
|
+
}
|
|
8683
|
+
],
|
|
7543
8684
|
"paginated": false,
|
|
7544
8685
|
"input_schema": {
|
|
7545
8686
|
"type": "object",
|
|
@@ -7590,13 +8731,40 @@
|
|
|
7590
8731
|
},
|
|
7591
8732
|
{
|
|
7592
8733
|
"operation": "apiKeys.list",
|
|
7593
|
-
"signature": "
|
|
8734
|
+
"signature": "typeship api-keys list [flags]",
|
|
8735
|
+
"command": [
|
|
8736
|
+
"typeship",
|
|
8737
|
+
"api-keys",
|
|
8738
|
+
"list"
|
|
8739
|
+
],
|
|
8740
|
+
"parameters": [
|
|
8741
|
+
{
|
|
8742
|
+
"name": "limit",
|
|
8743
|
+
"flag": "--limit",
|
|
8744
|
+
"in": "query",
|
|
8745
|
+
"type": "number",
|
|
8746
|
+
"required": false
|
|
8747
|
+
},
|
|
8748
|
+
{
|
|
8749
|
+
"name": "cursor",
|
|
8750
|
+
"flag": "--cursor",
|
|
8751
|
+
"in": "query",
|
|
8752
|
+
"type": "string",
|
|
8753
|
+
"required": false
|
|
8754
|
+
}
|
|
8755
|
+
],
|
|
8756
|
+
"example_command": "typeship api-keys list",
|
|
7594
8757
|
"method": "GET",
|
|
7595
8758
|
"path": "/api_keys",
|
|
7596
8759
|
"summary": "List API keys",
|
|
7597
8760
|
"description": "Keys are never returned in full — only their identity and last four. Creation stays in the console deliberately: a leaked key that can mint more keys is a leaked account.",
|
|
7598
8761
|
"safety": "read",
|
|
7599
8762
|
"auth": "required",
|
|
8763
|
+
"security": [
|
|
8764
|
+
{
|
|
8765
|
+
"apiKey": []
|
|
8766
|
+
}
|
|
8767
|
+
],
|
|
7600
8768
|
"paginated": true,
|
|
7601
8769
|
"input_schema": {
|
|
7602
8770
|
"type": "object",
|
|
@@ -7681,20 +8849,43 @@
|
|
|
7681
8849
|
},
|
|
7682
8850
|
{
|
|
7683
8851
|
"operation": "apiKeys.revoke",
|
|
7684
|
-
"signature": "
|
|
8852
|
+
"signature": "typeship api-keys revoke <api_key_id> [flags]",
|
|
8853
|
+
"command": [
|
|
8854
|
+
"typeship",
|
|
8855
|
+
"api-keys",
|
|
8856
|
+
"revoke"
|
|
8857
|
+
],
|
|
8858
|
+
"parameters": [
|
|
8859
|
+
{
|
|
8860
|
+
"name": "api_key_id",
|
|
8861
|
+
"positional": true,
|
|
8862
|
+
"in": "path",
|
|
8863
|
+
"type": "string",
|
|
8864
|
+
"required": true
|
|
8865
|
+
}
|
|
8866
|
+
],
|
|
8867
|
+
"example_command": "typeship api-keys revoke api_key_123 --force",
|
|
7685
8868
|
"method": "DELETE",
|
|
7686
8869
|
"path": "/api_keys/{api_key_id}",
|
|
7687
8870
|
"summary": "Revoke an API key",
|
|
7688
8871
|
"description": "Idempotent: revoking an already-revoked key returns the same body, so a rotation script that re-runs does not have to special-case having already succeeded. An OAuth member may revoke a key they created; an organization admin may revoke any key. Organization API keys retain account-wide authority.",
|
|
7689
8872
|
"safety": "destructive",
|
|
7690
8873
|
"auth": "required",
|
|
8874
|
+
"security": [
|
|
8875
|
+
{
|
|
8876
|
+
"apiKey": []
|
|
8877
|
+
}
|
|
8878
|
+
],
|
|
7691
8879
|
"paginated": false,
|
|
7692
8880
|
"input_schema": {
|
|
7693
8881
|
"type": "object",
|
|
7694
8882
|
"properties": {
|
|
7695
8883
|
"api_key_id": {
|
|
7696
|
-
"description": "Identifier returned by the API key list. IDs come from api_keys_list.",
|
|
7697
|
-
"type": "string"
|
|
8884
|
+
"description": "Identifier returned by the API key list. Accepts an ID or an exact name (resolved via api_keys_list). IDs come from api_keys_list.",
|
|
8885
|
+
"type": "string",
|
|
8886
|
+
"examples": [
|
|
8887
|
+
"example-name"
|
|
8888
|
+
]
|
|
7698
8889
|
}
|
|
7699
8890
|
},
|
|
7700
8891
|
"required": [
|