@vercel/sdk 1.16.0 → 1.16.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.
Files changed (191) hide show
  1. package/README.md +39 -37
  2. package/bin/mcp-server.js +1263 -912
  3. package/bin/mcp-server.js.map +42 -39
  4. package/docs/sdks/logdrains/README.md +7 -7
  5. package/docs/sdks/projects/README.md +78 -0
  6. package/docs/sdks/teams/README.md +1 -1
  7. package/esm/__tests__/accessgroups.test.js +6 -2
  8. package/esm/__tests__/accessgroups.test.js.map +1 -1
  9. package/esm/__tests__/domains.test.js +5 -5
  10. package/esm/__tests__/domains.test.js.map +1 -1
  11. package/esm/__tests__/edgeconfig.test.js +6 -6
  12. package/esm/__tests__/edgeconfig.test.js.map +1 -1
  13. package/esm/__tests__/integrations.test.js +1 -1
  14. package/esm/__tests__/logdrains.test.js +4 -4
  15. package/esm/__tests__/logdrains.test.js.map +1 -1
  16. package/esm/__tests__/projects.test.js +17 -0
  17. package/esm/__tests__/projects.test.js.map +1 -1
  18. package/esm/__tests__/rollingrelease.test.js +2 -7
  19. package/esm/__tests__/rollingrelease.test.js.map +1 -1
  20. package/esm/__tests__/security.test.js +1 -11
  21. package/esm/__tests__/security.test.js.map +1 -1
  22. package/esm/funcs/logDrainsCreateConfigurableLogDrain.d.ts +1 -1
  23. package/esm/funcs/logDrainsCreateConfigurableLogDrain.js +1 -1
  24. package/esm/funcs/logDrainsCreateLogDrain.d.ts +1 -1
  25. package/esm/funcs/logDrainsCreateLogDrain.js +1 -1
  26. package/esm/funcs/logDrainsDeleteConfigurableLogDrain.d.ts +1 -1
  27. package/esm/funcs/logDrainsDeleteConfigurableLogDrain.js +1 -1
  28. package/esm/funcs/logDrainsDeleteIntegrationLogDrain.d.ts +1 -1
  29. package/esm/funcs/logDrainsDeleteIntegrationLogDrain.js +1 -1
  30. package/esm/funcs/logDrainsGetAllLogDrains.d.ts +1 -1
  31. package/esm/funcs/logDrainsGetAllLogDrains.js +1 -1
  32. package/esm/funcs/logDrainsGetConfigurableLogDrain.d.ts +1 -1
  33. package/esm/funcs/logDrainsGetConfigurableLogDrain.js +1 -1
  34. package/esm/funcs/logDrainsGetIntegrationLogDrains.d.ts +1 -1
  35. package/esm/funcs/logDrainsGetIntegrationLogDrains.js +1 -1
  36. package/esm/funcs/projectsGetProjectClientCerts.d.ts +17 -0
  37. package/esm/funcs/projectsGetProjectClientCerts.d.ts.map +1 -0
  38. package/esm/funcs/projectsGetProjectClientCerts.js +88 -0
  39. package/esm/funcs/projectsGetProjectClientCerts.js.map +1 -0
  40. package/esm/funcs/teamsInviteUserToTeam.d.ts +1 -1
  41. package/esm/funcs/teamsInviteUserToTeam.js +1 -1
  42. package/esm/lib/config.d.ts +3 -3
  43. package/esm/lib/config.js +3 -3
  44. package/esm/mcp-server/mcp-server.js +1 -1
  45. package/esm/mcp-server/server.d.ts.map +1 -1
  46. package/esm/mcp-server/server.js +3 -1
  47. package/esm/mcp-server/server.js.map +1 -1
  48. package/esm/mcp-server/tools/logDrainsCreateConfigurableLogDrain.js +1 -1
  49. package/esm/mcp-server/tools/logDrainsCreateLogDrain.js +1 -1
  50. package/esm/mcp-server/tools/logDrainsDeleteConfigurableLogDrain.js +1 -1
  51. package/esm/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.d.ts.map +1 -1
  52. package/esm/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.js +1 -1
  53. package/esm/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.js.map +1 -1
  54. package/esm/mcp-server/tools/logDrainsGetAllLogDrains.js +1 -1
  55. package/esm/mcp-server/tools/logDrainsGetConfigurableLogDrain.js +1 -1
  56. package/esm/mcp-server/tools/logDrainsGetIntegrationLogDrains.js +1 -1
  57. package/esm/mcp-server/tools/projectsGetProjectClientCerts.d.ts +7 -0
  58. package/esm/mcp-server/tools/projectsGetProjectClientCerts.d.ts.map +1 -0
  59. package/esm/mcp-server/tools/projectsGetProjectClientCerts.js +28 -0
  60. package/esm/mcp-server/tools/projectsGetProjectClientCerts.js.map +1 -0
  61. package/esm/mcp-server/tools/teamsInviteUserToTeam.js +1 -1
  62. package/esm/mcp-server/tools/teamsInviteUserToTeam.js.map +1 -1
  63. package/esm/models/approverollingreleasestageop.d.ts +78 -0
  64. package/esm/models/approverollingreleasestageop.d.ts.map +1 -1
  65. package/esm/models/approverollingreleasestageop.js +18 -0
  66. package/esm/models/approverollingreleasestageop.js.map +1 -1
  67. package/esm/models/authuser.d.ts +67 -0
  68. package/esm/models/authuser.d.ts.map +1 -1
  69. package/esm/models/authuser.js +49 -0
  70. package/esm/models/authuser.js.map +1 -1
  71. package/esm/models/canceldeploymentop.d.ts +106 -1
  72. package/esm/models/canceldeploymentop.d.ts.map +1 -1
  73. package/esm/models/canceldeploymentop.js +9 -0
  74. package/esm/models/canceldeploymentop.js.map +1 -1
  75. package/esm/models/completerollingreleaseop.d.ts +78 -0
  76. package/esm/models/completerollingreleaseop.d.ts.map +1 -1
  77. package/esm/models/completerollingreleaseop.js +18 -0
  78. package/esm/models/completerollingreleaseop.js.map +1 -1
  79. package/esm/models/createdeploymentop.d.ts +106 -1
  80. package/esm/models/createdeploymentop.d.ts.map +1 -1
  81. package/esm/models/createdeploymentop.js +9 -0
  82. package/esm/models/createdeploymentop.js.map +1 -1
  83. package/esm/models/createintegrationstoredirectop.d.ts +285 -285
  84. package/esm/models/createintegrationstoredirectop.js +351 -351
  85. package/esm/models/createlogdrainop.d.ts +3 -0
  86. package/esm/models/createlogdrainop.d.ts.map +1 -1
  87. package/esm/models/createlogdrainop.js +1 -0
  88. package/esm/models/createlogdrainop.js.map +1 -1
  89. package/esm/models/createprojectop.d.ts +67 -15
  90. package/esm/models/createprojectop.d.ts.map +1 -1
  91. package/esm/models/createprojectop.js +47 -6
  92. package/esm/models/createprojectop.js.map +1 -1
  93. package/esm/models/getconfigurationproductsop.d.ts +375 -375
  94. package/esm/models/getconfigurationproductsop.js +465 -465
  95. package/esm/models/getdeploymentop.d.ts +212 -2
  96. package/esm/models/getdeploymentop.d.ts.map +1 -1
  97. package/esm/models/getdeploymentop.js +18 -0
  98. package/esm/models/getdeploymentop.js.map +1 -1
  99. package/esm/models/getintegrationlogdrainsop.d.ts +3 -0
  100. package/esm/models/getintegrationlogdrainsop.d.ts.map +1 -1
  101. package/esm/models/getintegrationlogdrainsop.js +1 -0
  102. package/esm/models/getintegrationlogdrainsop.js.map +1 -1
  103. package/esm/models/getprojectclientcertsop.d.ts +97 -0
  104. package/esm/models/getprojectclientcertsop.d.ts.map +1 -0
  105. package/esm/models/getprojectclientcertsop.js +87 -0
  106. package/esm/models/getprojectclientcertsop.js.map +1 -0
  107. package/esm/models/getprojectsop.d.ts +67 -15
  108. package/esm/models/getprojectsop.d.ts.map +1 -1
  109. package/esm/models/getprojectsop.js +47 -6
  110. package/esm/models/getprojectsop.js.map +1 -1
  111. package/esm/models/getrollingreleaseop.d.ts +78 -0
  112. package/esm/models/getrollingreleaseop.d.ts.map +1 -1
  113. package/esm/models/getrollingreleaseop.js +18 -0
  114. package/esm/models/getrollingreleaseop.js.map +1 -1
  115. package/esm/models/updateprojectdatacacheop.d.ts +67 -15
  116. package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
  117. package/esm/models/updateprojectdatacacheop.js +47 -6
  118. package/esm/models/updateprojectdatacacheop.js.map +1 -1
  119. package/esm/models/updateprojectop.d.ts +67 -15
  120. package/esm/models/updateprojectop.d.ts.map +1 -1
  121. package/esm/models/updateprojectop.js +47 -6
  122. package/esm/models/updateprojectop.js.map +1 -1
  123. package/esm/models/updatestaticipsop.d.ts +3 -3
  124. package/esm/models/updatestaticipsop.js +1 -1
  125. package/esm/models/updatestaticipsop.js.map +1 -1
  126. package/esm/models/userevent.d.ts +176 -30
  127. package/esm/models/userevent.d.ts.map +1 -1
  128. package/esm/models/userevent.js +136 -12
  129. package/esm/models/userevent.js.map +1 -1
  130. package/esm/sdk/logdrains.d.ts +7 -7
  131. package/esm/sdk/logdrains.js +7 -7
  132. package/esm/sdk/projects.d.ts +8 -0
  133. package/esm/sdk/projects.d.ts.map +1 -1
  134. package/esm/sdk/projects.js +10 -0
  135. package/esm/sdk/projects.js.map +1 -1
  136. package/esm/sdk/teams.d.ts +1 -1
  137. package/esm/sdk/teams.js +1 -1
  138. package/examples/package-lock.json +1 -1
  139. package/jsr.json +1 -1
  140. package/package.json +1 -1
  141. package/src/__tests__/accessgroups.test.ts +6 -2
  142. package/src/__tests__/domains.test.ts +5 -5
  143. package/src/__tests__/edgeconfig.test.ts +6 -6
  144. package/src/__tests__/integrations.test.ts +1 -1
  145. package/src/__tests__/logdrains.test.ts +4 -4
  146. package/src/__tests__/projects.test.ts +20 -0
  147. package/src/__tests__/rollingrelease.test.ts +2 -7
  148. package/src/__tests__/security.test.ts +1 -11
  149. package/src/funcs/logDrainsCreateConfigurableLogDrain.ts +1 -1
  150. package/src/funcs/logDrainsCreateLogDrain.ts +1 -1
  151. package/src/funcs/logDrainsDeleteConfigurableLogDrain.ts +1 -1
  152. package/src/funcs/logDrainsDeleteIntegrationLogDrain.ts +1 -1
  153. package/src/funcs/logDrainsGetAllLogDrains.ts +1 -1
  154. package/src/funcs/logDrainsGetConfigurableLogDrain.ts +1 -1
  155. package/src/funcs/logDrainsGetIntegrationLogDrains.ts +1 -1
  156. package/src/funcs/projectsGetProjectClientCerts.ts +177 -0
  157. package/src/funcs/teamsInviteUserToTeam.ts +1 -1
  158. package/src/lib/config.ts +3 -3
  159. package/src/mcp-server/mcp-server.ts +1 -1
  160. package/src/mcp-server/server.ts +3 -1
  161. package/src/mcp-server/tools/logDrainsCreateConfigurableLogDrain.ts +1 -1
  162. package/src/mcp-server/tools/logDrainsCreateLogDrain.ts +1 -1
  163. package/src/mcp-server/tools/logDrainsDeleteConfigurableLogDrain.ts +1 -1
  164. package/src/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.ts +2 -1
  165. package/src/mcp-server/tools/logDrainsGetAllLogDrains.ts +1 -1
  166. package/src/mcp-server/tools/logDrainsGetConfigurableLogDrain.ts +1 -1
  167. package/src/mcp-server/tools/logDrainsGetIntegrationLogDrains.ts +1 -1
  168. package/src/mcp-server/tools/projectsGetProjectClientCerts.ts +37 -0
  169. package/src/mcp-server/tools/teamsInviteUserToTeam.ts +1 -1
  170. package/src/models/approverollingreleasestageop.ts +78 -0
  171. package/src/models/authuser.ts +100 -0
  172. package/src/models/canceldeploymentop.ts +106 -1
  173. package/src/models/completerollingreleaseop.ts +78 -0
  174. package/src/models/createdeploymentop.ts +106 -1
  175. package/src/models/createintegrationstoredirectop.ts +604 -604
  176. package/src/models/createlogdrainop.ts +1 -0
  177. package/src/models/createprojectop.ts +126 -19
  178. package/src/models/getconfigurationproductsop.ts +802 -802
  179. package/src/models/getdeploymentop.ts +212 -2
  180. package/src/models/getintegrationlogdrainsop.ts +1 -0
  181. package/src/models/getprojectclientcertsop.ts +207 -0
  182. package/src/models/getprojectsop.ts +124 -19
  183. package/src/models/getrollingreleaseop.ts +78 -0
  184. package/src/models/updateprojectdatacacheop.ts +129 -19
  185. package/src/models/updateprojectop.ts +126 -19
  186. package/src/models/updatestaticipsop.ts +1 -1
  187. package/src/models/userevent.ts +329 -39
  188. package/src/sdk/logdrains.ts +7 -7
  189. package/src/sdk/projects.ts +22 -0
  190. package/src/sdk/teams.ts +1 -1
  191. package/vercel-spec.json +1092 -278
package/vercel-spec.json CHANGED
@@ -5396,6 +5396,9 @@
5396
5396
  "oneOf": [
5397
5397
  {
5398
5398
  "properties": {
5399
+ "isDefaultApp": {
5400
+ "type": "boolean"
5401
+ },
5399
5402
  "updatedAt": {
5400
5403
  "type": "number",
5401
5404
  "description": "Timestamp when the microfrontends settings were last updated."
@@ -5420,17 +5423,59 @@
5420
5423
  "type": "boolean",
5421
5424
  "description": "Whether microfrontends are enabled for this project."
5422
5425
  },
5423
- "isDefaultApp": {
5424
- "type": "boolean",
5425
- "description": "Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends."
5426
- },
5427
5426
  "defaultRoute": {
5428
5427
  "type": "string",
5429
5428
  "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
5429
+ }
5430
+ },
5431
+ "required": [
5432
+ "isDefaultApp",
5433
+ "updatedAt",
5434
+ "groupIds",
5435
+ "enabled"
5436
+ ],
5437
+ "type": "object"
5438
+ },
5439
+ {
5440
+ "properties": {
5441
+ "isDefaultApp": {
5442
+ "type": "boolean"
5430
5443
  },
5431
5444
  "routeObservabilityToThisProject": {
5432
5445
  "type": "boolean",
5433
5446
  "description": "Whether observability data should be routed to this microfrontend project or a root project."
5447
+ },
5448
+ "doNotRouteWithMicrofrontendsRouting": {
5449
+ "type": "boolean",
5450
+ "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend."
5451
+ },
5452
+ "updatedAt": {
5453
+ "type": "number",
5454
+ "description": "Timestamp when the microfrontends settings were last updated."
5455
+ },
5456
+ "groupIds": {
5457
+ "items": {
5458
+ "oneOf": [
5459
+ {
5460
+ "type": "string"
5461
+ },
5462
+ {
5463
+ "type": "string"
5464
+ }
5465
+ ]
5466
+ },
5467
+ "maxItems": 2,
5468
+ "minItems": 2,
5469
+ "type": "array",
5470
+ "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together."
5471
+ },
5472
+ "enabled": {
5473
+ "type": "boolean",
5474
+ "description": "Whether microfrontends are enabled for this project."
5475
+ },
5476
+ "defaultRoute": {
5477
+ "type": "string",
5478
+ "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
5434
5479
  }
5435
5480
  },
5436
5481
  "required": [
@@ -7561,6 +7606,10 @@
7561
7606
  "disableRepositoryDispatchEvents": {
7562
7607
  "type": "boolean",
7563
7608
  "description": "Whether the Vercel bot should not automatically create GitHub repository-dispatch events on deployment events. https://vercel.com/docs/git/vercel-for-github#repository-dispatch-events"
7609
+ },
7610
+ "requireVerifiedCommits": {
7611
+ "type": "boolean",
7612
+ "description": "Whether the project requires commits to be signed before deployments will be created."
7564
7613
  }
7565
7614
  },
7566
7615
  "required": [
@@ -9648,10 +9697,14 @@
9648
9697
  "items": {
9649
9698
  "type": "string"
9650
9699
  },
9651
- "type": "array"
9700
+ "type": "array",
9701
+ "description": "A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation",
9702
+ "example": []
9652
9703
  },
9653
9704
  "aliasAssigned": {
9654
- "type": "boolean"
9705
+ "type": "boolean",
9706
+ "description": "A boolean that will be true when the aliases from the alias property were assigned successfully",
9707
+ "example": true
9655
9708
  },
9656
9709
  "bootedAt": {
9657
9710
  "type": "number"
@@ -9669,19 +9722,25 @@
9669
9722
  "creator": {
9670
9723
  "properties": {
9671
9724
  "uid": {
9672
- "type": "string"
9725
+ "type": "string",
9726
+ "description": "The ID of the user that created the deployment",
9727
+ "example": "96SnxkFiMyVKsK3pnoHfx3Hz"
9673
9728
  },
9674
9729
  "username": {
9675
- "type": "string"
9730
+ "type": "string",
9731
+ "description": "The username of the user that created the deployment",
9732
+ "example": "john-doe"
9676
9733
  },
9677
9734
  "avatar": {
9678
- "type": "string"
9735
+ "type": "string",
9736
+ "description": "The avatar of the user that created the deployment"
9679
9737
  }
9680
9738
  },
9681
9739
  "required": [
9682
9740
  "uid"
9683
9741
  ],
9684
- "type": "object"
9742
+ "type": "object",
9743
+ "description": "Information about the deployment creator"
9685
9744
  },
9686
9745
  "initReadyAt": {
9687
9746
  "type": "number"
@@ -9743,7 +9802,9 @@
9743
9802
  "type": "array"
9744
9803
  },
9745
9804
  "public": {
9746
- "type": "boolean"
9805
+ "type": "boolean",
9806
+ "description": "A boolean representing if the deployment is public or not. By default this is `false`",
9807
+ "example": false
9747
9808
  },
9748
9809
  "ready": {
9749
9810
  "type": "number"
@@ -9779,16 +9840,24 @@
9779
9840
  "name",
9780
9841
  "slug"
9781
9842
  ],
9782
- "type": "object"
9843
+ "type": "object",
9844
+ "description": "The team that owns the deployment if any"
9783
9845
  },
9784
9846
  "userAliases": {
9785
9847
  "items": {
9786
9848
  "type": "string"
9787
9849
  },
9788
- "type": "array"
9850
+ "type": "array",
9851
+ "description": "An array of domains that were provided by the user when creating the Deployment.",
9852
+ "example": [
9853
+ "sub1.example.com",
9854
+ "sub2.example.com"
9855
+ ]
9789
9856
  },
9790
9857
  "previewCommentsEnabled": {
9791
- "type": "boolean"
9858
+ "type": "boolean",
9859
+ "description": "Whether or not preview comments are enabled for the deployment",
9860
+ "example": false
9792
9861
  },
9793
9862
  "ttyBuildLogs": {
9794
9863
  "type": "boolean"
@@ -9950,7 +10019,7 @@
9950
10019
  "updatedAt"
9951
10020
  ],
9952
10021
  "type": "object",
9953
- "description": "Internal representation of a custom environment with all required properties"
10022
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
9954
10023
  },
9955
10024
  {
9956
10025
  "properties": {
@@ -9961,7 +10030,8 @@
9961
10030
  "required": [
9962
10031
  "id"
9963
10032
  ],
9964
- "type": "object"
10033
+ "type": "object",
10034
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
9965
10035
  }
9966
10036
  ]
9967
10037
  },
@@ -9994,10 +10064,14 @@
9994
10064
  "type": "object"
9995
10065
  },
9996
10066
  "id": {
9997
- "type": "string"
10067
+ "type": "string",
10068
+ "description": "A string holding the unique ID of the deployment",
10069
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
9998
10070
  },
9999
10071
  "createdAt": {
10000
- "type": "number"
10072
+ "type": "number",
10073
+ "description": "A number containing the date when the deployment was created in milliseconds",
10074
+ "example": 1540257589405
10001
10075
  },
10002
10076
  "readyState": {
10003
10077
  "type": "string",
@@ -10008,10 +10082,14 @@
10008
10082
  "INITIALIZING",
10009
10083
  "READY",
10010
10084
  "CANCELED"
10011
- ]
10085
+ ],
10086
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
10087
+ "example": "READY"
10012
10088
  },
10013
10089
  "name": {
10014
- "type": "string"
10090
+ "type": "string",
10091
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
10092
+ "example": "my-project"
10015
10093
  },
10016
10094
  "type": {
10017
10095
  "type": "string",
@@ -10033,7 +10111,9 @@
10033
10111
  "code",
10034
10112
  "message"
10035
10113
  ],
10036
- "type": "object"
10114
+ "type": "object",
10115
+ "description": "An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`",
10116
+ "example": null
10037
10117
  },
10038
10118
  "aliasFinal": {
10039
10119
  "nullable": true,
@@ -10071,7 +10151,9 @@
10071
10151
  },
10072
10152
  "deletedAt": {
10073
10153
  "nullable": true,
10074
- "type": "number"
10154
+ "type": "number",
10155
+ "description": "A number containing the date when the deployment was deleted at milliseconds",
10156
+ "example": 1540257589405
10075
10157
  },
10076
10158
  "defaultRoute": {
10077
10159
  "type": "string",
@@ -10649,7 +10731,8 @@
10649
10731
  "id",
10650
10732
  "name"
10651
10733
  ],
10652
- "type": "object"
10734
+ "type": "object",
10735
+ "description": "The public project information associated with the deployment."
10653
10736
  },
10654
10737
  "readySubstate": {
10655
10738
  "type": "string",
@@ -10664,10 +10747,16 @@
10664
10747
  "items": {
10665
10748
  "type": "string"
10666
10749
  },
10667
- "type": "array"
10750
+ "type": "array",
10751
+ "description": "The regions the deployment exists in",
10752
+ "example": [
10753
+ "sfo1"
10754
+ ]
10668
10755
  },
10669
10756
  "softDeletedByRetention": {
10670
- "type": "boolean"
10757
+ "type": "boolean",
10758
+ "description": "flag to indicate if the deployment was deleted by retention policy",
10759
+ "example": "true"
10671
10760
  },
10672
10761
  "source": {
10673
10762
  "type": "string",
@@ -10680,7 +10769,9 @@
10680
10769
  "import/repo",
10681
10770
  "redeploy",
10682
10771
  "v0-web"
10683
- ]
10772
+ ],
10773
+ "description": "Where was the deployment created from",
10774
+ "example": "cli"
10684
10775
  },
10685
10776
  "target": {
10686
10777
  "nullable": true,
@@ -10688,19 +10779,27 @@
10688
10779
  "enum": [
10689
10780
  "staging",
10690
10781
  "production"
10691
- ]
10782
+ ],
10783
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
10784
+ "example": null
10692
10785
  },
10693
10786
  "undeletedAt": {
10694
- "type": "number"
10787
+ "type": "number",
10788
+ "description": "A number containing the date when the deployment was undeleted at milliseconds",
10789
+ "example": 1540257589405
10695
10790
  },
10696
10791
  "url": {
10697
- "type": "string"
10792
+ "type": "string",
10793
+ "description": "A string with the unique URL of the deployment",
10794
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
10698
10795
  },
10699
10796
  "version": {
10700
10797
  "type": "number",
10701
10798
  "enum": [
10702
10799
  2
10703
- ]
10800
+ ],
10801
+ "description": "The platform version that was used to create the deployment.",
10802
+ "example": 2
10704
10803
  },
10705
10804
  "oidcTokenClaims": {
10706
10805
  "properties": {
@@ -11889,10 +11988,14 @@
11889
11988
  "items": {
11890
11989
  "type": "string"
11891
11990
  },
11892
- "type": "array"
11991
+ "type": "array",
11992
+ "description": "A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation",
11993
+ "example": []
11893
11994
  },
11894
11995
  "aliasAssigned": {
11895
- "type": "boolean"
11996
+ "type": "boolean",
11997
+ "description": "A boolean that will be true when the aliases from the alias property were assigned successfully",
11998
+ "example": true
11896
11999
  },
11897
12000
  "bootedAt": {
11898
12001
  "type": "number"
@@ -11910,19 +12013,25 @@
11910
12013
  "creator": {
11911
12014
  "properties": {
11912
12015
  "uid": {
11913
- "type": "string"
12016
+ "type": "string",
12017
+ "description": "The ID of the user that created the deployment",
12018
+ "example": "96SnxkFiMyVKsK3pnoHfx3Hz"
11914
12019
  },
11915
12020
  "username": {
11916
- "type": "string"
12021
+ "type": "string",
12022
+ "description": "The username of the user that created the deployment",
12023
+ "example": "john-doe"
11917
12024
  },
11918
12025
  "avatar": {
11919
- "type": "string"
12026
+ "type": "string",
12027
+ "description": "The avatar of the user that created the deployment"
11920
12028
  }
11921
12029
  },
11922
12030
  "required": [
11923
12031
  "uid"
11924
12032
  ],
11925
- "type": "object"
12033
+ "type": "object",
12034
+ "description": "Information about the deployment creator"
11926
12035
  },
11927
12036
  "initReadyAt": {
11928
12037
  "type": "number"
@@ -11984,7 +12093,9 @@
11984
12093
  "type": "array"
11985
12094
  },
11986
12095
  "public": {
11987
- "type": "boolean"
12096
+ "type": "boolean",
12097
+ "description": "A boolean representing if the deployment is public or not. By default this is `false`",
12098
+ "example": false
11988
12099
  },
11989
12100
  "ready": {
11990
12101
  "type": "number"
@@ -12020,16 +12131,24 @@
12020
12131
  "name",
12021
12132
  "slug"
12022
12133
  ],
12023
- "type": "object"
12134
+ "type": "object",
12135
+ "description": "The team that owns the deployment if any"
12024
12136
  },
12025
12137
  "userAliases": {
12026
12138
  "items": {
12027
12139
  "type": "string"
12028
12140
  },
12029
- "type": "array"
12141
+ "type": "array",
12142
+ "description": "An array of domains that were provided by the user when creating the Deployment.",
12143
+ "example": [
12144
+ "sub1.example.com",
12145
+ "sub2.example.com"
12146
+ ]
12030
12147
  },
12031
12148
  "previewCommentsEnabled": {
12032
- "type": "boolean"
12149
+ "type": "boolean",
12150
+ "description": "Whether or not preview comments are enabled for the deployment",
12151
+ "example": false
12033
12152
  },
12034
12153
  "ttyBuildLogs": {
12035
12154
  "type": "boolean"
@@ -12191,7 +12310,7 @@
12191
12310
  "updatedAt"
12192
12311
  ],
12193
12312
  "type": "object",
12194
- "description": "Internal representation of a custom environment with all required properties"
12313
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
12195
12314
  },
12196
12315
  {
12197
12316
  "properties": {
@@ -12202,7 +12321,8 @@
12202
12321
  "required": [
12203
12322
  "id"
12204
12323
  ],
12205
- "type": "object"
12324
+ "type": "object",
12325
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
12206
12326
  }
12207
12327
  ]
12208
12328
  },
@@ -12235,10 +12355,14 @@
12235
12355
  "type": "object"
12236
12356
  },
12237
12357
  "id": {
12238
- "type": "string"
12358
+ "type": "string",
12359
+ "description": "A string holding the unique ID of the deployment",
12360
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
12239
12361
  },
12240
12362
  "createdAt": {
12241
- "type": "number"
12363
+ "type": "number",
12364
+ "description": "A number containing the date when the deployment was created in milliseconds",
12365
+ "example": 1540257589405
12242
12366
  },
12243
12367
  "readyState": {
12244
12368
  "type": "string",
@@ -12249,10 +12373,14 @@
12249
12373
  "INITIALIZING",
12250
12374
  "READY",
12251
12375
  "CANCELED"
12252
- ]
12376
+ ],
12377
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
12378
+ "example": "READY"
12253
12379
  },
12254
12380
  "name": {
12255
- "type": "string"
12381
+ "type": "string",
12382
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
12383
+ "example": "my-project"
12256
12384
  },
12257
12385
  "type": {
12258
12386
  "type": "string",
@@ -12274,7 +12402,9 @@
12274
12402
  "code",
12275
12403
  "message"
12276
12404
  ],
12277
- "type": "object"
12405
+ "type": "object",
12406
+ "description": "An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`",
12407
+ "example": null
12278
12408
  },
12279
12409
  "aliasFinal": {
12280
12410
  "nullable": true,
@@ -12312,7 +12442,9 @@
12312
12442
  },
12313
12443
  "deletedAt": {
12314
12444
  "nullable": true,
12315
- "type": "number"
12445
+ "type": "number",
12446
+ "description": "A number containing the date when the deployment was deleted at milliseconds",
12447
+ "example": 1540257589405
12316
12448
  },
12317
12449
  "defaultRoute": {
12318
12450
  "type": "string",
@@ -12890,7 +13022,8 @@
12890
13022
  "id",
12891
13023
  "name"
12892
13024
  ],
12893
- "type": "object"
13025
+ "type": "object",
13026
+ "description": "The public project information associated with the deployment."
12894
13027
  },
12895
13028
  "readySubstate": {
12896
13029
  "type": "string",
@@ -12905,10 +13038,16 @@
12905
13038
  "items": {
12906
13039
  "type": "string"
12907
13040
  },
12908
- "type": "array"
13041
+ "type": "array",
13042
+ "description": "The regions the deployment exists in",
13043
+ "example": [
13044
+ "sfo1"
13045
+ ]
12909
13046
  },
12910
13047
  "softDeletedByRetention": {
12911
- "type": "boolean"
13048
+ "type": "boolean",
13049
+ "description": "flag to indicate if the deployment was deleted by retention policy",
13050
+ "example": "true"
12912
13051
  },
12913
13052
  "source": {
12914
13053
  "type": "string",
@@ -12921,7 +13060,9 @@
12921
13060
  "import/repo",
12922
13061
  "redeploy",
12923
13062
  "v0-web"
12924
- ]
13063
+ ],
13064
+ "description": "Where was the deployment created from",
13065
+ "example": "cli"
12925
13066
  },
12926
13067
  "target": {
12927
13068
  "nullable": true,
@@ -12929,19 +13070,27 @@
12929
13070
  "enum": [
12930
13071
  "staging",
12931
13072
  "production"
12932
- ]
13073
+ ],
13074
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
13075
+ "example": null
12933
13076
  },
12934
13077
  "undeletedAt": {
12935
- "type": "number"
13078
+ "type": "number",
13079
+ "description": "A number containing the date when the deployment was undeleted at milliseconds",
13080
+ "example": 1540257589405
12936
13081
  },
12937
13082
  "url": {
12938
- "type": "string"
13083
+ "type": "string",
13084
+ "description": "A string with the unique URL of the deployment",
13085
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
12939
13086
  },
12940
13087
  "version": {
12941
13088
  "type": "number",
12942
13089
  "enum": [
12943
13090
  2
12944
- ]
13091
+ ],
13092
+ "description": "The platform version that was used to create the deployment.",
13093
+ "example": 2
12945
13094
  },
12946
13095
  "oidcTokenClaims": {
12947
13096
  "properties": {
@@ -13431,10 +13580,14 @@
13431
13580
  "items": {
13432
13581
  "type": "string"
13433
13582
  },
13434
- "type": "array"
13583
+ "type": "array",
13584
+ "description": "A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation",
13585
+ "example": []
13435
13586
  },
13436
13587
  "aliasAssigned": {
13437
- "type": "boolean"
13588
+ "type": "boolean",
13589
+ "description": "A boolean that will be true when the aliases from the alias property were assigned successfully",
13590
+ "example": true
13438
13591
  },
13439
13592
  "bootedAt": {
13440
13593
  "type": "number"
@@ -13452,19 +13605,25 @@
13452
13605
  "creator": {
13453
13606
  "properties": {
13454
13607
  "uid": {
13455
- "type": "string"
13608
+ "type": "string",
13609
+ "description": "The ID of the user that created the deployment",
13610
+ "example": "96SnxkFiMyVKsK3pnoHfx3Hz"
13456
13611
  },
13457
13612
  "username": {
13458
- "type": "string"
13613
+ "type": "string",
13614
+ "description": "The username of the user that created the deployment",
13615
+ "example": "john-doe"
13459
13616
  },
13460
13617
  "avatar": {
13461
- "type": "string"
13618
+ "type": "string",
13619
+ "description": "The avatar of the user that created the deployment"
13462
13620
  }
13463
13621
  },
13464
13622
  "required": [
13465
13623
  "uid"
13466
13624
  ],
13467
- "type": "object"
13625
+ "type": "object",
13626
+ "description": "Information about the deployment creator"
13468
13627
  },
13469
13628
  "initReadyAt": {
13470
13629
  "type": "number"
@@ -13526,7 +13685,9 @@
13526
13685
  "type": "array"
13527
13686
  },
13528
13687
  "public": {
13529
- "type": "boolean"
13688
+ "type": "boolean",
13689
+ "description": "A boolean representing if the deployment is public or not. By default this is `false`",
13690
+ "example": false
13530
13691
  },
13531
13692
  "ready": {
13532
13693
  "type": "number"
@@ -13562,16 +13723,24 @@
13562
13723
  "name",
13563
13724
  "slug"
13564
13725
  ],
13565
- "type": "object"
13726
+ "type": "object",
13727
+ "description": "The team that owns the deployment if any"
13566
13728
  },
13567
13729
  "userAliases": {
13568
13730
  "items": {
13569
13731
  "type": "string"
13570
13732
  },
13571
- "type": "array"
13733
+ "type": "array",
13734
+ "description": "An array of domains that were provided by the user when creating the Deployment.",
13735
+ "example": [
13736
+ "sub1.example.com",
13737
+ "sub2.example.com"
13738
+ ]
13572
13739
  },
13573
13740
  "previewCommentsEnabled": {
13574
- "type": "boolean"
13741
+ "type": "boolean",
13742
+ "description": "Whether or not preview comments are enabled for the deployment",
13743
+ "example": false
13575
13744
  },
13576
13745
  "ttyBuildLogs": {
13577
13746
  "type": "boolean"
@@ -13733,7 +13902,7 @@
13733
13902
  "updatedAt"
13734
13903
  ],
13735
13904
  "type": "object",
13736
- "description": "Internal representation of a custom environment with all required properties"
13905
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
13737
13906
  },
13738
13907
  {
13739
13908
  "properties": {
@@ -13744,7 +13913,8 @@
13744
13913
  "required": [
13745
13914
  "id"
13746
13915
  ],
13747
- "type": "object"
13916
+ "type": "object",
13917
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
13748
13918
  }
13749
13919
  ]
13750
13920
  },
@@ -13777,10 +13947,14 @@
13777
13947
  "type": "object"
13778
13948
  },
13779
13949
  "id": {
13780
- "type": "string"
13950
+ "type": "string",
13951
+ "description": "A string holding the unique ID of the deployment",
13952
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
13781
13953
  },
13782
13954
  "createdAt": {
13783
- "type": "number"
13955
+ "type": "number",
13956
+ "description": "A number containing the date when the deployment was created in milliseconds",
13957
+ "example": 1540257589405
13784
13958
  },
13785
13959
  "readyState": {
13786
13960
  "type": "string",
@@ -13791,10 +13965,14 @@
13791
13965
  "INITIALIZING",
13792
13966
  "READY",
13793
13967
  "CANCELED"
13794
- ]
13968
+ ],
13969
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
13970
+ "example": "READY"
13795
13971
  },
13796
13972
  "name": {
13797
- "type": "string"
13973
+ "type": "string",
13974
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
13975
+ "example": "my-project"
13798
13976
  },
13799
13977
  "type": {
13800
13978
  "type": "string",
@@ -13816,7 +13994,9 @@
13816
13994
  "code",
13817
13995
  "message"
13818
13996
  ],
13819
- "type": "object"
13997
+ "type": "object",
13998
+ "description": "An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`",
13999
+ "example": null
13820
14000
  },
13821
14001
  "aliasFinal": {
13822
14002
  "nullable": true,
@@ -13854,7 +14034,9 @@
13854
14034
  },
13855
14035
  "deletedAt": {
13856
14036
  "nullable": true,
13857
- "type": "number"
14037
+ "type": "number",
14038
+ "description": "A number containing the date when the deployment was deleted at milliseconds",
14039
+ "example": 1540257589405
13858
14040
  },
13859
14041
  "defaultRoute": {
13860
14042
  "type": "string",
@@ -14432,7 +14614,8 @@
14432
14614
  "id",
14433
14615
  "name"
14434
14616
  ],
14435
- "type": "object"
14617
+ "type": "object",
14618
+ "description": "The public project information associated with the deployment."
14436
14619
  },
14437
14620
  "readySubstate": {
14438
14621
  "type": "string",
@@ -14447,10 +14630,16 @@
14447
14630
  "items": {
14448
14631
  "type": "string"
14449
14632
  },
14450
- "type": "array"
14633
+ "type": "array",
14634
+ "description": "The regions the deployment exists in",
14635
+ "example": [
14636
+ "sfo1"
14637
+ ]
14451
14638
  },
14452
14639
  "softDeletedByRetention": {
14453
- "type": "boolean"
14640
+ "type": "boolean",
14641
+ "description": "flag to indicate if the deployment was deleted by retention policy",
14642
+ "example": "true"
14454
14643
  },
14455
14644
  "source": {
14456
14645
  "type": "string",
@@ -14463,7 +14652,9 @@
14463
14652
  "import/repo",
14464
14653
  "redeploy",
14465
14654
  "v0-web"
14466
- ]
14655
+ ],
14656
+ "description": "Where was the deployment created from",
14657
+ "example": "cli"
14467
14658
  },
14468
14659
  "target": {
14469
14660
  "nullable": true,
@@ -14471,19 +14662,27 @@
14471
14662
  "enum": [
14472
14663
  "staging",
14473
14664
  "production"
14474
- ]
14665
+ ],
14666
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
14667
+ "example": null
14475
14668
  },
14476
14669
  "undeletedAt": {
14477
- "type": "number"
14670
+ "type": "number",
14671
+ "description": "A number containing the date when the deployment was undeleted at milliseconds",
14672
+ "example": 1540257589405
14478
14673
  },
14479
14674
  "url": {
14480
- "type": "string"
14675
+ "type": "string",
14676
+ "description": "A string with the unique URL of the deployment",
14677
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
14481
14678
  },
14482
14679
  "version": {
14483
14680
  "type": "number",
14484
14681
  "enum": [
14485
14682
  2
14486
- ]
14683
+ ],
14684
+ "description": "The platform version that was used to create the deployment.",
14685
+ "example": 2
14487
14686
  },
14488
14687
  "oidcTokenClaims": {
14489
14688
  "properties": {
@@ -16661,10 +16860,14 @@
16661
16860
  "items": {
16662
16861
  "type": "string"
16663
16862
  },
16664
- "type": "array"
16863
+ "type": "array",
16864
+ "description": "A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation",
16865
+ "example": []
16665
16866
  },
16666
16867
  "aliasAssigned": {
16667
- "type": "boolean"
16868
+ "type": "boolean",
16869
+ "description": "A boolean that will be true when the aliases from the alias property were assigned successfully",
16870
+ "example": true
16668
16871
  },
16669
16872
  "bootedAt": {
16670
16873
  "type": "number"
@@ -16682,19 +16885,25 @@
16682
16885
  "creator": {
16683
16886
  "properties": {
16684
16887
  "uid": {
16685
- "type": "string"
16888
+ "type": "string",
16889
+ "description": "The ID of the user that created the deployment",
16890
+ "example": "96SnxkFiMyVKsK3pnoHfx3Hz"
16686
16891
  },
16687
16892
  "username": {
16688
- "type": "string"
16893
+ "type": "string",
16894
+ "description": "The username of the user that created the deployment",
16895
+ "example": "john-doe"
16689
16896
  },
16690
16897
  "avatar": {
16691
- "type": "string"
16898
+ "type": "string",
16899
+ "description": "The avatar of the user that created the deployment"
16692
16900
  }
16693
16901
  },
16694
16902
  "required": [
16695
16903
  "uid"
16696
16904
  ],
16697
- "type": "object"
16905
+ "type": "object",
16906
+ "description": "Information about the deployment creator"
16698
16907
  },
16699
16908
  "initReadyAt": {
16700
16909
  "type": "number"
@@ -16756,7 +16965,9 @@
16756
16965
  "type": "array"
16757
16966
  },
16758
16967
  "public": {
16759
- "type": "boolean"
16968
+ "type": "boolean",
16969
+ "description": "A boolean representing if the deployment is public or not. By default this is `false`",
16970
+ "example": false
16760
16971
  },
16761
16972
  "ready": {
16762
16973
  "type": "number"
@@ -16792,16 +17003,24 @@
16792
17003
  "name",
16793
17004
  "slug"
16794
17005
  ],
16795
- "type": "object"
17006
+ "type": "object",
17007
+ "description": "The team that owns the deployment if any"
16796
17008
  },
16797
17009
  "userAliases": {
16798
17010
  "items": {
16799
17011
  "type": "string"
16800
17012
  },
16801
- "type": "array"
17013
+ "type": "array",
17014
+ "description": "An array of domains that were provided by the user when creating the Deployment.",
17015
+ "example": [
17016
+ "sub1.example.com",
17017
+ "sub2.example.com"
17018
+ ]
16802
17019
  },
16803
17020
  "previewCommentsEnabled": {
16804
- "type": "boolean"
17021
+ "type": "boolean",
17022
+ "description": "Whether or not preview comments are enabled for the deployment",
17023
+ "example": false
16805
17024
  },
16806
17025
  "ttyBuildLogs": {
16807
17026
  "type": "boolean"
@@ -16963,7 +17182,7 @@
16963
17182
  "updatedAt"
16964
17183
  ],
16965
17184
  "type": "object",
16966
- "description": "Internal representation of a custom environment with all required properties"
17185
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
16967
17186
  },
16968
17187
  {
16969
17188
  "properties": {
@@ -16974,7 +17193,8 @@
16974
17193
  "required": [
16975
17194
  "id"
16976
17195
  ],
16977
- "type": "object"
17196
+ "type": "object",
17197
+ "description": "If the deployment was created using a Custom Environment, then this property contains information regarding the environment used."
16978
17198
  }
16979
17199
  ]
16980
17200
  },
@@ -16985,7 +17205,9 @@
16985
17205
  ]
16986
17206
  },
16987
17207
  "id": {
16988
- "type": "string"
17208
+ "type": "string",
17209
+ "description": "A string holding the unique ID of the deployment",
17210
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
16989
17211
  },
16990
17212
  "aliasError": {
16991
17213
  "nullable": true,
@@ -17001,7 +17223,9 @@
17001
17223
  "code",
17002
17224
  "message"
17003
17225
  ],
17004
- "type": "object"
17226
+ "type": "object",
17227
+ "description": "An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`",
17228
+ "example": null
17005
17229
  },
17006
17230
  "aliasFinal": {
17007
17231
  "nullable": true,
@@ -17060,11 +17284,15 @@
17060
17284
  ]
17061
17285
  },
17062
17286
  "createdAt": {
17063
- "type": "number"
17287
+ "type": "number",
17288
+ "description": "A number containing the date when the deployment was created in milliseconds",
17289
+ "example": 1540257589405
17064
17290
  },
17065
17291
  "deletedAt": {
17066
17292
  "nullable": true,
17067
- "type": "number"
17293
+ "type": "number",
17294
+ "description": "A number containing the date when the deployment was deleted at milliseconds",
17295
+ "example": 1540257589405
17068
17296
  },
17069
17297
  "defaultRoute": {
17070
17298
  "type": "string",
@@ -17603,7 +17831,9 @@
17603
17831
  ]
17604
17832
  },
17605
17833
  "name": {
17606
- "type": "string"
17834
+ "type": "string",
17835
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
17836
+ "example": "my-project"
17607
17837
  },
17608
17838
  "meta": {
17609
17839
  "additionalProperties": {
@@ -17645,7 +17875,8 @@
17645
17875
  "id",
17646
17876
  "name"
17647
17877
  ],
17648
- "type": "object"
17878
+ "type": "object",
17879
+ "description": "The public project information associated with the deployment."
17649
17880
  },
17650
17881
  "readyState": {
17651
17882
  "type": "string",
@@ -17656,7 +17887,9 @@
17656
17887
  "QUEUED",
17657
17888
  "READY",
17658
17889
  "CANCELED"
17659
- ]
17890
+ ],
17891
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
17892
+ "example": "READY"
17660
17893
  },
17661
17894
  "readySubstate": {
17662
17895
  "type": "string",
@@ -17671,10 +17904,16 @@
17671
17904
  "items": {
17672
17905
  "type": "string"
17673
17906
  },
17674
- "type": "array"
17907
+ "type": "array",
17908
+ "description": "The regions the deployment exists in",
17909
+ "example": [
17910
+ "sfo1"
17911
+ ]
17675
17912
  },
17676
17913
  "softDeletedByRetention": {
17677
- "type": "boolean"
17914
+ "type": "boolean",
17915
+ "description": "flag to indicate if the deployment was deleted by retention policy",
17916
+ "example": "true"
17678
17917
  },
17679
17918
  "source": {
17680
17919
  "type": "string",
@@ -17687,7 +17926,9 @@
17687
17926
  "import/repo",
17688
17927
  "redeploy",
17689
17928
  "v0-web"
17690
- ]
17929
+ ],
17930
+ "description": "Where was the deployment created from",
17931
+ "example": "cli"
17691
17932
  },
17692
17933
  "target": {
17693
17934
  "nullable": true,
@@ -17695,7 +17936,9 @@
17695
17936
  "enum": [
17696
17937
  "staging",
17697
17938
  "production"
17698
- ]
17939
+ ],
17940
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
17941
+ "example": null
17699
17942
  },
17700
17943
  "type": {
17701
17944
  "type": "string",
@@ -17704,16 +17947,22 @@
17704
17947
  ]
17705
17948
  },
17706
17949
  "undeletedAt": {
17707
- "type": "number"
17950
+ "type": "number",
17951
+ "description": "A number containing the date when the deployment was undeleted at milliseconds",
17952
+ "example": 1540257589405
17708
17953
  },
17709
17954
  "url": {
17710
- "type": "string"
17955
+ "type": "string",
17956
+ "description": "A string with the unique URL of the deployment",
17957
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
17711
17958
  },
17712
17959
  "version": {
17713
17960
  "type": "number",
17714
17961
  "enum": [
17715
17962
  2
17716
- ]
17963
+ ],
17964
+ "description": "The platform version that was used to create the deployment.",
17965
+ "example": 2
17717
17966
  },
17718
17967
  "oidcTokenClaims": {
17719
17968
  "properties": {
@@ -24689,7 +24938,7 @@
24689
24938
  "bearerToken": []
24690
24939
  }
24691
24940
  ],
24692
- "summary": "Retrieves a Configurable Log Drain",
24941
+ "summary": "Retrieves a Configurable Log Drain (deprecated)",
24693
24942
  "tags": [
24694
24943
  "logDrains"
24695
24944
  ],
@@ -24848,7 +25097,7 @@
24848
25097
  "bearerToken": []
24849
25098
  }
24850
25099
  ],
24851
- "summary": "Deletes a Configurable Log Drain",
25100
+ "summary": "Deletes a Configurable Log Drain (deprecated)",
24852
25101
  "tags": [
24853
25102
  "logDrains"
24854
25103
  ],
@@ -24908,7 +25157,7 @@
24908
25157
  "bearerToken": []
24909
25158
  }
24910
25159
  ],
24911
- "summary": "Retrieves a list of all the Log Drains",
25160
+ "summary": "Retrieves a list of all the Log Drains (deprecated)",
24912
25161
  "tags": [
24913
25162
  "logDrains"
24914
25163
  ],
@@ -26061,7 +26310,7 @@
26061
26310
  "bearerToken": []
26062
26311
  }
26063
26312
  ],
26064
- "summary": "Creates a Configurable Log Drain",
26313
+ "summary": "Creates a Configurable Log Drain (deprecated)",
26065
26314
  "tags": [
26066
26315
  "logDrains"
26067
26316
  ],
@@ -39407,34 +39656,34 @@
39407
39656
  "minLength": {
39408
39657
  "type": "object",
39409
39658
  "properties": {
39410
- "__@BRAND@648348": {
39659
+ "__@BRAND@647815": {
39411
39660
  "type": "object"
39412
39661
  }
39413
39662
  },
39414
39663
  "required": [
39415
- "__@BRAND@648348"
39664
+ "__@BRAND@647815"
39416
39665
  ]
39417
39666
  },
39418
39667
  "maxLength": {
39419
39668
  "type": "object",
39420
39669
  "properties": {
39421
- "__@BRAND@648348": {
39670
+ "__@BRAND@647815": {
39422
39671
  "type": "object"
39423
39672
  }
39424
39673
  },
39425
39674
  "required": [
39426
- "__@BRAND@648348"
39675
+ "__@BRAND@647815"
39427
39676
  ]
39428
39677
  },
39429
39678
  "pattern": {
39430
39679
  "type": "object",
39431
39680
  "properties": {
39432
- "__@BRAND@648348": {
39681
+ "__@BRAND@647815": {
39433
39682
  "type": "object"
39434
39683
  }
39435
39684
  },
39436
39685
  "required": [
39437
- "__@BRAND@648348"
39686
+ "__@BRAND@647815"
39438
39687
  ]
39439
39688
  },
39440
39689
  "default": {
@@ -40117,34 +40366,34 @@
40117
40366
  "minLength": {
40118
40367
  "type": "object",
40119
40368
  "properties": {
40120
- "__@BRAND@648348": {
40369
+ "__@BRAND@647815": {
40121
40370
  "type": "object"
40122
40371
  }
40123
40372
  },
40124
40373
  "required": [
40125
- "__@BRAND@648348"
40374
+ "__@BRAND@647815"
40126
40375
  ]
40127
40376
  },
40128
40377
  "maxLength": {
40129
40378
  "type": "object",
40130
40379
  "properties": {
40131
- "__@BRAND@648348": {
40380
+ "__@BRAND@647815": {
40132
40381
  "type": "object"
40133
40382
  }
40134
40383
  },
40135
40384
  "required": [
40136
- "__@BRAND@648348"
40385
+ "__@BRAND@647815"
40137
40386
  ]
40138
40387
  },
40139
40388
  "pattern": {
40140
40389
  "type": "object",
40141
40390
  "properties": {
40142
- "__@BRAND@648348": {
40391
+ "__@BRAND@647815": {
40143
40392
  "type": "object"
40144
40393
  }
40145
40394
  },
40146
40395
  "required": [
40147
- "__@BRAND@648348"
40396
+ "__@BRAND@647815"
40148
40397
  ]
40149
40398
  },
40150
40399
  "default": {
@@ -40302,34 +40551,34 @@
40302
40551
  "minLength": {
40303
40552
  "type": "object",
40304
40553
  "properties": {
40305
- "__@BRAND@648348": {
40554
+ "__@BRAND@647815": {
40306
40555
  "type": "object"
40307
40556
  }
40308
40557
  },
40309
40558
  "required": [
40310
- "__@BRAND@648348"
40559
+ "__@BRAND@647815"
40311
40560
  ]
40312
40561
  },
40313
40562
  "maxLength": {
40314
40563
  "type": "object",
40315
40564
  "properties": {
40316
- "__@BRAND@648348": {
40565
+ "__@BRAND@647815": {
40317
40566
  "type": "object"
40318
40567
  }
40319
40568
  },
40320
40569
  "required": [
40321
- "__@BRAND@648348"
40570
+ "__@BRAND@647815"
40322
40571
  ]
40323
40572
  },
40324
40573
  "pattern": {
40325
40574
  "type": "object",
40326
40575
  "properties": {
40327
- "__@BRAND@648348": {
40576
+ "__@BRAND@647815": {
40328
40577
  "type": "object"
40329
40578
  }
40330
40579
  },
40331
40580
  "required": [
40332
- "__@BRAND@648348"
40581
+ "__@BRAND@647815"
40333
40582
  ]
40334
40583
  },
40335
40584
  "default": {
@@ -40640,12 +40889,12 @@
40640
40889
  {
40641
40890
  "type": "object",
40642
40891
  "properties": {
40643
- "__@BRAND@648348": {
40892
+ "__@BRAND@647815": {
40644
40893
  "type": "object"
40645
40894
  }
40646
40895
  },
40647
40896
  "required": [
40648
- "__@BRAND@648348"
40897
+ "__@BRAND@647815"
40649
40898
  ]
40650
40899
  },
40651
40900
  {
@@ -40653,12 +40902,12 @@
40653
40902
  "value": {
40654
40903
  "type": "object",
40655
40904
  "properties": {
40656
- "__@BRAND@648348": {
40905
+ "__@BRAND@647815": {
40657
40906
  "type": "object"
40658
40907
  }
40659
40908
  },
40660
40909
  "required": [
40661
- "__@BRAND@648348"
40910
+ "__@BRAND@647815"
40662
40911
  ]
40663
40912
  },
40664
40913
  "disabled": {
@@ -40727,34 +40976,34 @@
40727
40976
  "minLength": {
40728
40977
  "type": "object",
40729
40978
  "properties": {
40730
- "__@BRAND@648348": {
40979
+ "__@BRAND@647815": {
40731
40980
  "type": "object"
40732
40981
  }
40733
40982
  },
40734
40983
  "required": [
40735
- "__@BRAND@648348"
40984
+ "__@BRAND@647815"
40736
40985
  ]
40737
40986
  },
40738
40987
  "maxLength": {
40739
40988
  "type": "object",
40740
40989
  "properties": {
40741
- "__@BRAND@648348": {
40990
+ "__@BRAND@647815": {
40742
40991
  "type": "object"
40743
40992
  }
40744
40993
  },
40745
40994
  "required": [
40746
- "__@BRAND@648348"
40995
+ "__@BRAND@647815"
40747
40996
  ]
40748
40997
  },
40749
40998
  "pattern": {
40750
40999
  "type": "object",
40751
41000
  "properties": {
40752
- "__@BRAND@648348": {
41001
+ "__@BRAND@647815": {
40753
41002
  "type": "object"
40754
41003
  }
40755
41004
  },
40756
41005
  "required": [
40757
- "__@BRAND@648348"
41006
+ "__@BRAND@647815"
40758
41007
  ]
40759
41008
  },
40760
41009
  "default": {
@@ -40912,34 +41161,34 @@
40912
41161
  "minLength": {
40913
41162
  "type": "object",
40914
41163
  "properties": {
40915
- "__@BRAND@648348": {
41164
+ "__@BRAND@647815": {
40916
41165
  "type": "object"
40917
41166
  }
40918
41167
  },
40919
41168
  "required": [
40920
- "__@BRAND@648348"
41169
+ "__@BRAND@647815"
40921
41170
  ]
40922
41171
  },
40923
41172
  "maxLength": {
40924
41173
  "type": "object",
40925
41174
  "properties": {
40926
- "__@BRAND@648348": {
41175
+ "__@BRAND@647815": {
40927
41176
  "type": "object"
40928
41177
  }
40929
41178
  },
40930
41179
  "required": [
40931
- "__@BRAND@648348"
41180
+ "__@BRAND@647815"
40932
41181
  ]
40933
41182
  },
40934
41183
  "pattern": {
40935
41184
  "type": "object",
40936
41185
  "properties": {
40937
- "__@BRAND@648348": {
41186
+ "__@BRAND@647815": {
40938
41187
  "type": "object"
40939
41188
  }
40940
41189
  },
40941
41190
  "required": [
40942
- "__@BRAND@648348"
41191
+ "__@BRAND@647815"
40943
41192
  ]
40944
41193
  },
40945
41194
  "default": {
@@ -41028,12 +41277,12 @@
41028
41277
  {
41029
41278
  "type": "object",
41030
41279
  "properties": {
41031
- "__@BRAND@648348": {
41280
+ "__@BRAND@647815": {
41032
41281
  "type": "object"
41033
41282
  }
41034
41283
  },
41035
41284
  "required": [
41036
- "__@BRAND@648348"
41285
+ "__@BRAND@647815"
41037
41286
  ]
41038
41287
  },
41039
41288
  {
@@ -41041,12 +41290,12 @@
41041
41290
  "value": {
41042
41291
  "type": "object",
41043
41292
  "properties": {
41044
- "__@BRAND@648348": {
41293
+ "__@BRAND@647815": {
41045
41294
  "type": "object"
41046
41295
  }
41047
41296
  },
41048
41297
  "required": [
41049
- "__@BRAND@648348"
41298
+ "__@BRAND@647815"
41050
41299
  ]
41051
41300
  },
41052
41301
  "disabled": {
@@ -41232,12 +41481,12 @@
41232
41481
  "items": {
41233
41482
  "type": "object",
41234
41483
  "properties": {
41235
- "__@BRAND@648348": {
41484
+ "__@BRAND@647815": {
41236
41485
  "type": "object"
41237
41486
  }
41238
41487
  },
41239
41488
  "required": [
41240
- "__@BRAND@648348"
41489
+ "__@BRAND@647815"
41241
41490
  ]
41242
41491
  },
41243
41492
  "type": "array"
@@ -41246,12 +41495,12 @@
41246
41495
  "items": {
41247
41496
  "type": "object",
41248
41497
  "properties": {
41249
- "__@BRAND@648348": {
41498
+ "__@BRAND@647815": {
41250
41499
  "type": "object"
41251
41500
  }
41252
41501
  },
41253
41502
  "required": [
41254
- "__@BRAND@648348"
41503
+ "__@BRAND@647815"
41255
41504
  ]
41256
41505
  },
41257
41506
  "type": "array"
@@ -41285,34 +41534,34 @@
41285
41534
  "minLength": {
41286
41535
  "type": "object",
41287
41536
  "properties": {
41288
- "__@BRAND@648348": {
41537
+ "__@BRAND@647815": {
41289
41538
  "type": "object"
41290
41539
  }
41291
41540
  },
41292
41541
  "required": [
41293
- "__@BRAND@648348"
41542
+ "__@BRAND@647815"
41294
41543
  ]
41295
41544
  },
41296
41545
  "maxLength": {
41297
41546
  "type": "object",
41298
41547
  "properties": {
41299
- "__@BRAND@648348": {
41548
+ "__@BRAND@647815": {
41300
41549
  "type": "object"
41301
41550
  }
41302
41551
  },
41303
41552
  "required": [
41304
- "__@BRAND@648348"
41553
+ "__@BRAND@647815"
41305
41554
  ]
41306
41555
  },
41307
41556
  "pattern": {
41308
41557
  "type": "object",
41309
41558
  "properties": {
41310
- "__@BRAND@648348": {
41559
+ "__@BRAND@647815": {
41311
41560
  "type": "object"
41312
41561
  }
41313
41562
  },
41314
41563
  "required": [
41315
- "__@BRAND@648348"
41564
+ "__@BRAND@647815"
41316
41565
  ]
41317
41566
  },
41318
41567
  "default": {
@@ -41446,12 +41695,12 @@
41446
41695
  "value": {
41447
41696
  "type": "object",
41448
41697
  "properties": {
41449
- "__@BRAND@648348": {
41698
+ "__@BRAND@647815": {
41450
41699
  "type": "object"
41451
41700
  }
41452
41701
  },
41453
41702
  "required": [
41454
- "__@BRAND@648348"
41703
+ "__@BRAND@647815"
41455
41704
  ]
41456
41705
  },
41457
41706
  "disabled": {
@@ -41740,7 +41989,7 @@
41740
41989
  "bearerToken": []
41741
41990
  }
41742
41991
  ],
41743
- "summary": "Retrieves a list of Integration log drains",
41992
+ "summary": "Retrieves a list of Integration log drains (deprecated)",
41744
41993
  "tags": [
41745
41994
  "logDrains"
41746
41995
  ],
@@ -41820,7 +42069,8 @@
41820
42069
  "lambda",
41821
42070
  "static",
41822
42071
  "external",
41823
- "firewall"
42072
+ "firewall",
42073
+ "redirect"
41824
42074
  ],
41825
42075
  "description": "The sources from which logs are currently being delivered to this log drain.",
41826
42076
  "example": [
@@ -41981,7 +42231,7 @@
41981
42231
  "bearerToken": []
41982
42232
  }
41983
42233
  ],
41984
- "summary": "Creates a new Integration Log Drain",
42234
+ "summary": "Creates a new Integration Log Drain (deprecated)",
41985
42235
  "tags": [
41986
42236
  "logDrains"
41987
42237
  ],
@@ -42060,7 +42310,8 @@
42060
42310
  "lambda",
42061
42311
  "static",
42062
42312
  "external",
42063
- "firewall"
42313
+ "firewall",
42314
+ "redirect"
42064
42315
  ],
42065
42316
  "description": "The sources from which logs are currently being delivered to this log drain.",
42066
42317
  "example": [
@@ -42310,7 +42561,7 @@
42310
42561
  "bearerToken": []
42311
42562
  }
42312
42563
  ],
42313
- "summary": "Deletes the Integration log drain with the provided `id`",
42564
+ "summary": "Deletes the Integration log drain with the provided `id` (deprecated)",
42314
42565
  "tags": [
42315
42566
  "logDrains"
42316
42567
  ],
@@ -45074,6 +45325,9 @@
45074
45325
  "oneOf": [
45075
45326
  {
45076
45327
  "properties": {
45328
+ "isDefaultApp": {
45329
+ "type": "boolean"
45330
+ },
45077
45331
  "updatedAt": {
45078
45332
  "type": "number",
45079
45333
  "description": "Timestamp when the microfrontends settings were last updated."
@@ -45098,17 +45352,59 @@
45098
45352
  "type": "boolean",
45099
45353
  "description": "Whether microfrontends are enabled for this project."
45100
45354
  },
45101
- "isDefaultApp": {
45102
- "type": "boolean",
45103
- "description": "Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends."
45104
- },
45105
45355
  "defaultRoute": {
45106
45356
  "type": "string",
45107
45357
  "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
45358
+ }
45359
+ },
45360
+ "required": [
45361
+ "isDefaultApp",
45362
+ "updatedAt",
45363
+ "groupIds",
45364
+ "enabled"
45365
+ ],
45366
+ "type": "object"
45367
+ },
45368
+ {
45369
+ "properties": {
45370
+ "isDefaultApp": {
45371
+ "type": "boolean"
45108
45372
  },
45109
45373
  "routeObservabilityToThisProject": {
45110
45374
  "type": "boolean",
45111
45375
  "description": "Whether observability data should be routed to this microfrontend project or a root project."
45376
+ },
45377
+ "doNotRouteWithMicrofrontendsRouting": {
45378
+ "type": "boolean",
45379
+ "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend."
45380
+ },
45381
+ "updatedAt": {
45382
+ "type": "number",
45383
+ "description": "Timestamp when the microfrontends settings were last updated."
45384
+ },
45385
+ "groupIds": {
45386
+ "items": {
45387
+ "oneOf": [
45388
+ {
45389
+ "type": "string"
45390
+ },
45391
+ {
45392
+ "type": "string"
45393
+ }
45394
+ ]
45395
+ },
45396
+ "maxItems": 2,
45397
+ "minItems": 2,
45398
+ "type": "array",
45399
+ "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together."
45400
+ },
45401
+ "enabled": {
45402
+ "type": "boolean",
45403
+ "description": "Whether microfrontends are enabled for this project."
45404
+ },
45405
+ "defaultRoute": {
45406
+ "type": "string",
45407
+ "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
45112
45408
  }
45113
45409
  },
45114
45410
  "required": [
@@ -47239,6 +47535,10 @@
47239
47535
  "disableRepositoryDispatchEvents": {
47240
47536
  "type": "boolean",
47241
47537
  "description": "Whether the Vercel bot should not automatically create GitHub repository-dispatch events on deployment events. https://vercel.com/docs/git/vercel-for-github#repository-dispatch-events"
47538
+ },
47539
+ "requireVerifiedCommits": {
47540
+ "type": "boolean",
47541
+ "description": "Whether the project requires commits to be signed before deployments will be created."
47242
47542
  }
47243
47543
  },
47244
47544
  "required": [
@@ -49907,6 +50207,9 @@
49907
50207
  "oneOf": [
49908
50208
  {
49909
50209
  "properties": {
50210
+ "isDefaultApp": {
50211
+ "type": "boolean"
50212
+ },
49910
50213
  "updatedAt": {
49911
50214
  "type": "number",
49912
50215
  "description": "Timestamp when the microfrontends settings were last updated."
@@ -49931,17 +50234,59 @@
49931
50234
  "type": "boolean",
49932
50235
  "description": "Whether microfrontends are enabled for this project."
49933
50236
  },
49934
- "isDefaultApp": {
49935
- "type": "boolean",
49936
- "description": "Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends."
49937
- },
49938
50237
  "defaultRoute": {
49939
50238
  "type": "string",
49940
50239
  "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
50240
+ }
50241
+ },
50242
+ "required": [
50243
+ "isDefaultApp",
50244
+ "updatedAt",
50245
+ "groupIds",
50246
+ "enabled"
50247
+ ],
50248
+ "type": "object"
50249
+ },
50250
+ {
50251
+ "properties": {
50252
+ "isDefaultApp": {
50253
+ "type": "boolean"
49941
50254
  },
49942
50255
  "routeObservabilityToThisProject": {
49943
50256
  "type": "boolean",
49944
50257
  "description": "Whether observability data should be routed to this microfrontend project or a root project."
50258
+ },
50259
+ "doNotRouteWithMicrofrontendsRouting": {
50260
+ "type": "boolean",
50261
+ "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend."
50262
+ },
50263
+ "updatedAt": {
50264
+ "type": "number",
50265
+ "description": "Timestamp when the microfrontends settings were last updated."
50266
+ },
50267
+ "groupIds": {
50268
+ "items": {
50269
+ "oneOf": [
50270
+ {
50271
+ "type": "string"
50272
+ },
50273
+ {
50274
+ "type": "string"
50275
+ }
50276
+ ]
50277
+ },
50278
+ "maxItems": 2,
50279
+ "minItems": 2,
50280
+ "type": "array",
50281
+ "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together."
50282
+ },
50283
+ "enabled": {
50284
+ "type": "boolean",
50285
+ "description": "Whether microfrontends are enabled for this project."
50286
+ },
50287
+ "defaultRoute": {
50288
+ "type": "string",
50289
+ "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
49945
50290
  }
49946
50291
  },
49947
50292
  "required": [
@@ -52072,6 +52417,10 @@
52072
52417
  "disableRepositoryDispatchEvents": {
52073
52418
  "type": "boolean",
52074
52419
  "description": "Whether the Vercel bot should not automatically create GitHub repository-dispatch events on deployment events. https://vercel.com/docs/git/vercel-for-github#repository-dispatch-events"
52420
+ },
52421
+ "requireVerifiedCommits": {
52422
+ "type": "boolean",
52423
+ "description": "Whether the project requires commits to be signed before deployments will be created."
52075
52424
  }
52076
52425
  },
52077
52426
  "required": [
@@ -54945,6 +55294,9 @@
54945
55294
  "oneOf": [
54946
55295
  {
54947
55296
  "properties": {
55297
+ "isDefaultApp": {
55298
+ "type": "boolean"
55299
+ },
54948
55300
  "updatedAt": {
54949
55301
  "type": "number",
54950
55302
  "description": "Timestamp when the microfrontends settings were last updated."
@@ -54969,17 +55321,59 @@
54969
55321
  "type": "boolean",
54970
55322
  "description": "Whether microfrontends are enabled for this project."
54971
55323
  },
54972
- "isDefaultApp": {
54973
- "type": "boolean",
54974
- "description": "Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends."
54975
- },
54976
55324
  "defaultRoute": {
54977
55325
  "type": "string",
54978
55326
  "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
55327
+ }
55328
+ },
55329
+ "required": [
55330
+ "isDefaultApp",
55331
+ "updatedAt",
55332
+ "groupIds",
55333
+ "enabled"
55334
+ ],
55335
+ "type": "object"
55336
+ },
55337
+ {
55338
+ "properties": {
55339
+ "isDefaultApp": {
55340
+ "type": "boolean"
54979
55341
  },
54980
55342
  "routeObservabilityToThisProject": {
54981
55343
  "type": "boolean",
54982
55344
  "description": "Whether observability data should be routed to this microfrontend project or a root project."
55345
+ },
55346
+ "doNotRouteWithMicrofrontendsRouting": {
55347
+ "type": "boolean",
55348
+ "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend."
55349
+ },
55350
+ "updatedAt": {
55351
+ "type": "number",
55352
+ "description": "Timestamp when the microfrontends settings were last updated."
55353
+ },
55354
+ "groupIds": {
55355
+ "items": {
55356
+ "oneOf": [
55357
+ {
55358
+ "type": "string"
55359
+ },
55360
+ {
55361
+ "type": "string"
55362
+ }
55363
+ ]
55364
+ },
55365
+ "maxItems": 2,
55366
+ "minItems": 2,
55367
+ "type": "array",
55368
+ "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together."
55369
+ },
55370
+ "enabled": {
55371
+ "type": "boolean",
55372
+ "description": "Whether microfrontends are enabled for this project."
55373
+ },
55374
+ "defaultRoute": {
55375
+ "type": "string",
55376
+ "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
54983
55377
  }
54984
55378
  },
54985
55379
  "required": [
@@ -57110,6 +57504,10 @@
57110
57504
  "disableRepositoryDispatchEvents": {
57111
57505
  "type": "boolean",
57112
57506
  "description": "Whether the Vercel bot should not automatically create GitHub repository-dispatch events on deployment events. https://vercel.com/docs/git/vercel-for-github#repository-dispatch-events"
57507
+ },
57508
+ "requireVerifiedCommits": {
57509
+ "type": "boolean",
57510
+ "description": "Whether the project requires commits to be signed before deployments will be created."
57113
57511
  }
57114
57512
  },
57115
57513
  "required": [
@@ -59604,6 +60002,9 @@
59604
60002
  "oneOf": [
59605
60003
  {
59606
60004
  "properties": {
60005
+ "isDefaultApp": {
60006
+ "type": "boolean"
60007
+ },
59607
60008
  "updatedAt": {
59608
60009
  "type": "number",
59609
60010
  "description": "Timestamp when the microfrontends settings were last updated."
@@ -59628,17 +60029,59 @@
59628
60029
  "type": "boolean",
59629
60030
  "description": "Whether microfrontends are enabled for this project."
59630
60031
  },
59631
- "isDefaultApp": {
59632
- "type": "boolean",
59633
- "description": "Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends."
59634
- },
59635
60032
  "defaultRoute": {
59636
60033
  "type": "string",
59637
60034
  "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
60035
+ }
60036
+ },
60037
+ "required": [
60038
+ "isDefaultApp",
60039
+ "updatedAt",
60040
+ "groupIds",
60041
+ "enabled"
60042
+ ],
60043
+ "type": "object"
60044
+ },
60045
+ {
60046
+ "properties": {
60047
+ "isDefaultApp": {
60048
+ "type": "boolean"
59638
60049
  },
59639
60050
  "routeObservabilityToThisProject": {
59640
60051
  "type": "boolean",
59641
60052
  "description": "Whether observability data should be routed to this microfrontend project or a root project."
60053
+ },
60054
+ "doNotRouteWithMicrofrontendsRouting": {
60055
+ "type": "boolean",
60056
+ "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend."
60057
+ },
60058
+ "updatedAt": {
60059
+ "type": "number",
60060
+ "description": "Timestamp when the microfrontends settings were last updated."
60061
+ },
60062
+ "groupIds": {
60063
+ "items": {
60064
+ "oneOf": [
60065
+ {
60066
+ "type": "string"
60067
+ },
60068
+ {
60069
+ "type": "string"
60070
+ }
60071
+ ]
60072
+ },
60073
+ "maxItems": 2,
60074
+ "minItems": 2,
60075
+ "type": "array",
60076
+ "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together."
60077
+ },
60078
+ "enabled": {
60079
+ "type": "boolean",
60080
+ "description": "Whether microfrontends are enabled for this project."
60081
+ },
60082
+ "defaultRoute": {
60083
+ "type": "string",
60084
+ "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
59642
60085
  }
59643
60086
  },
59644
60087
  "required": [
@@ -61769,6 +62212,10 @@
61769
62212
  "disableRepositoryDispatchEvents": {
61770
62213
  "type": "boolean",
61771
62214
  "description": "Whether the Vercel bot should not automatically create GitHub repository-dispatch events on deployment events. https://vercel.com/docs/git/vercel-for-github#repository-dispatch-events"
62215
+ },
62216
+ "requireVerifiedCommits": {
62217
+ "type": "boolean",
62218
+ "description": "Whether the project requires commits to be signed before deployments will be created."
61772
62219
  }
61773
62220
  },
61774
62221
  "required": [
@@ -63187,8 +63634,8 @@
63187
63634
  {
63188
63635
  "type": "string",
63189
63636
  "enum": [
63190
- "production",
63191
- "preview"
63637
+ "preview",
63638
+ "production"
63192
63639
  ]
63193
63640
  }
63194
63641
  ]
@@ -71992,6 +72439,97 @@
71992
72439
  }
71993
72440
  }
71994
72441
  }
72442
+ },
72443
+ "get": {
72444
+ "description": "Retrieve client certificates configured for a project's mTLS egress authentication.",
72445
+ "operationId": "getProjectClientCerts",
72446
+ "security": [
72447
+ {
72448
+ "bearerToken": []
72449
+ }
72450
+ ],
72451
+ "summary": "Get client certificates for a project",
72452
+ "tags": [
72453
+ "projects"
72454
+ ],
72455
+ "responses": {
72456
+ "200": {
72457
+ "description": "Client certificates retrieved successfully",
72458
+ "content": {
72459
+ "application/json": {
72460
+ "schema": {
72461
+ "properties": {
72462
+ "clientCerts": {
72463
+ "items": {
72464
+ "properties": {
72465
+ "origin": {
72466
+ "type": "string"
72467
+ },
72468
+ "id": {
72469
+ "type": "string"
72470
+ }
72471
+ },
72472
+ "required": [
72473
+ "origin",
72474
+ "id"
72475
+ ],
72476
+ "type": "object"
72477
+ },
72478
+ "type": "array"
72479
+ }
72480
+ },
72481
+ "required": [
72482
+ "clientCerts"
72483
+ ],
72484
+ "type": "object"
72485
+ }
72486
+ }
72487
+ }
72488
+ },
72489
+ "400": {
72490
+ "description": "One of the provided values in the request query is invalid."
72491
+ },
72492
+ "401": {
72493
+ "description": "The request is not authorized."
72494
+ },
72495
+ "403": {
72496
+ "description": "You do not have permission to access this resource."
72497
+ },
72498
+ "404": {
72499
+ "description": ""
72500
+ }
72501
+ },
72502
+ "parameters": [
72503
+ {
72504
+ "name": "idOrName",
72505
+ "description": "The unique project identifier or the project name",
72506
+ "in": "path",
72507
+ "required": true,
72508
+ "schema": {
72509
+ "description": "The unique project identifier or the project name",
72510
+ "type": "string",
72511
+ "example": "prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA"
72512
+ }
72513
+ },
72514
+ {
72515
+ "description": "The Team identifier to perform the request on behalf of.",
72516
+ "in": "query",
72517
+ "name": "teamId",
72518
+ "schema": {
72519
+ "type": "string",
72520
+ "example": "team_1a2b3c4d5e6f7g8h9i0j1k2l"
72521
+ }
72522
+ },
72523
+ {
72524
+ "description": "The Team slug to perform the request on behalf of.",
72525
+ "in": "query",
72526
+ "name": "slug",
72527
+ "schema": {
72528
+ "type": "string",
72529
+ "example": "my-team-url-slug"
72530
+ }
72531
+ }
72532
+ ]
71995
72533
  }
71996
72534
  },
71997
72535
  "/v1/projects/{idOrName}/rolling-release/billing": {
@@ -72534,13 +73072,19 @@
72534
73072
  "nullable": true,
72535
73073
  "properties": {
72536
73074
  "id": {
72537
- "type": "string"
73075
+ "type": "string",
73076
+ "description": "A string holding the unique ID of the deployment",
73077
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
72538
73078
  },
72539
73079
  "name": {
72540
- "type": "string"
73080
+ "type": "string",
73081
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
73082
+ "example": "my-project"
72541
73083
  },
72542
73084
  "url": {
72543
- "type": "string"
73085
+ "type": "string",
73086
+ "description": "A string with the unique URL of the deployment",
73087
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
72544
73088
  },
72545
73089
  "target": {
72546
73090
  "nullable": true,
@@ -72548,7 +73092,9 @@
72548
73092
  "enum": [
72549
73093
  "staging",
72550
73094
  "production"
72551
- ]
73095
+ ],
73096
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
73097
+ "example": null
72552
73098
  },
72553
73099
  "source": {
72554
73100
  "type": "string",
@@ -72561,10 +73107,14 @@
72561
73107
  "import/repo",
72562
73108
  "redeploy",
72563
73109
  "v0-web"
72564
- ]
73110
+ ],
73111
+ "description": "Where was the deployment created from",
73112
+ "example": "cli"
72565
73113
  },
72566
73114
  "createdAt": {
72567
- "type": "number"
73115
+ "type": "number",
73116
+ "description": "A number containing the date when the deployment was created in milliseconds",
73117
+ "example": 1540257589405
72568
73118
  },
72569
73119
  "readyState": {
72570
73120
  "type": "string",
@@ -72575,7 +73125,9 @@
72575
73125
  "QUEUED",
72576
73126
  "READY",
72577
73127
  "CANCELED"
72578
- ]
73128
+ ],
73129
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
73130
+ "example": "READY"
72579
73131
  },
72580
73132
  "readyStateAt": {
72581
73133
  "type": "number"
@@ -72605,13 +73157,19 @@
72605
73157
  "nullable": true,
72606
73158
  "properties": {
72607
73159
  "id": {
72608
- "type": "string"
73160
+ "type": "string",
73161
+ "description": "A string holding the unique ID of the deployment",
73162
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
72609
73163
  },
72610
73164
  "name": {
72611
- "type": "string"
73165
+ "type": "string",
73166
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
73167
+ "example": "my-project"
72612
73168
  },
72613
73169
  "url": {
72614
- "type": "string"
73170
+ "type": "string",
73171
+ "description": "A string with the unique URL of the deployment",
73172
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
72615
73173
  },
72616
73174
  "target": {
72617
73175
  "nullable": true,
@@ -72619,7 +73177,9 @@
72619
73177
  "enum": [
72620
73178
  "staging",
72621
73179
  "production"
72622
- ]
73180
+ ],
73181
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
73182
+ "example": null
72623
73183
  },
72624
73184
  "source": {
72625
73185
  "type": "string",
@@ -72632,10 +73192,14 @@
72632
73192
  "import/repo",
72633
73193
  "redeploy",
72634
73194
  "v0-web"
72635
- ]
73195
+ ],
73196
+ "description": "Where was the deployment created from",
73197
+ "example": "cli"
72636
73198
  },
72637
73199
  "createdAt": {
72638
- "type": "number"
73200
+ "type": "number",
73201
+ "description": "A number containing the date when the deployment was created in milliseconds",
73202
+ "example": 1540257589405
72639
73203
  },
72640
73204
  "readyState": {
72641
73205
  "type": "string",
@@ -72646,7 +73210,9 @@
72646
73210
  "QUEUED",
72647
73211
  "READY",
72648
73212
  "CANCELED"
72649
- ]
73213
+ ],
73214
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
73215
+ "example": "READY"
72650
73216
  },
72651
73217
  "readyStateAt": {
72652
73218
  "type": "number"
@@ -73029,13 +73595,19 @@
73029
73595
  "nullable": true,
73030
73596
  "properties": {
73031
73597
  "id": {
73032
- "type": "string"
73598
+ "type": "string",
73599
+ "description": "A string holding the unique ID of the deployment",
73600
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
73033
73601
  },
73034
73602
  "name": {
73035
- "type": "string"
73603
+ "type": "string",
73604
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
73605
+ "example": "my-project"
73036
73606
  },
73037
73607
  "url": {
73038
- "type": "string"
73608
+ "type": "string",
73609
+ "description": "A string with the unique URL of the deployment",
73610
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
73039
73611
  },
73040
73612
  "target": {
73041
73613
  "nullable": true,
@@ -73043,7 +73615,9 @@
73043
73615
  "enum": [
73044
73616
  "staging",
73045
73617
  "production"
73046
- ]
73618
+ ],
73619
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
73620
+ "example": null
73047
73621
  },
73048
73622
  "source": {
73049
73623
  "type": "string",
@@ -73056,10 +73630,14 @@
73056
73630
  "import/repo",
73057
73631
  "redeploy",
73058
73632
  "v0-web"
73059
- ]
73633
+ ],
73634
+ "description": "Where was the deployment created from",
73635
+ "example": "cli"
73060
73636
  },
73061
73637
  "createdAt": {
73062
- "type": "number"
73638
+ "type": "number",
73639
+ "description": "A number containing the date when the deployment was created in milliseconds",
73640
+ "example": 1540257589405
73063
73641
  },
73064
73642
  "readyState": {
73065
73643
  "type": "string",
@@ -73070,7 +73648,9 @@
73070
73648
  "QUEUED",
73071
73649
  "READY",
73072
73650
  "CANCELED"
73073
- ]
73651
+ ],
73652
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
73653
+ "example": "READY"
73074
73654
  },
73075
73655
  "readyStateAt": {
73076
73656
  "type": "number"
@@ -73100,13 +73680,19 @@
73100
73680
  "nullable": true,
73101
73681
  "properties": {
73102
73682
  "id": {
73103
- "type": "string"
73683
+ "type": "string",
73684
+ "description": "A string holding the unique ID of the deployment",
73685
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
73104
73686
  },
73105
73687
  "name": {
73106
- "type": "string"
73688
+ "type": "string",
73689
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
73690
+ "example": "my-project"
73107
73691
  },
73108
73692
  "url": {
73109
- "type": "string"
73693
+ "type": "string",
73694
+ "description": "A string with the unique URL of the deployment",
73695
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
73110
73696
  },
73111
73697
  "target": {
73112
73698
  "nullable": true,
@@ -73114,7 +73700,9 @@
73114
73700
  "enum": [
73115
73701
  "staging",
73116
73702
  "production"
73117
- ]
73703
+ ],
73704
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
73705
+ "example": null
73118
73706
  },
73119
73707
  "source": {
73120
73708
  "type": "string",
@@ -73127,10 +73715,14 @@
73127
73715
  "import/repo",
73128
73716
  "redeploy",
73129
73717
  "v0-web"
73130
- ]
73718
+ ],
73719
+ "description": "Where was the deployment created from",
73720
+ "example": "cli"
73131
73721
  },
73132
73722
  "createdAt": {
73133
- "type": "number"
73723
+ "type": "number",
73724
+ "description": "A number containing the date when the deployment was created in milliseconds",
73725
+ "example": 1540257589405
73134
73726
  },
73135
73727
  "readyState": {
73136
73728
  "type": "string",
@@ -73141,7 +73733,9 @@
73141
73733
  "QUEUED",
73142
73734
  "READY",
73143
73735
  "CANCELED"
73144
- ]
73736
+ ],
73737
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
73738
+ "example": "READY"
73145
73739
  },
73146
73740
  "readyStateAt": {
73147
73741
  "type": "number"
@@ -73535,13 +74129,19 @@
73535
74129
  "nullable": true,
73536
74130
  "properties": {
73537
74131
  "id": {
73538
- "type": "string"
74132
+ "type": "string",
74133
+ "description": "A string holding the unique ID of the deployment",
74134
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
73539
74135
  },
73540
74136
  "name": {
73541
- "type": "string"
74137
+ "type": "string",
74138
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
74139
+ "example": "my-project"
73542
74140
  },
73543
74141
  "url": {
73544
- "type": "string"
74142
+ "type": "string",
74143
+ "description": "A string with the unique URL of the deployment",
74144
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
73545
74145
  },
73546
74146
  "target": {
73547
74147
  "nullable": true,
@@ -73549,7 +74149,9 @@
73549
74149
  "enum": [
73550
74150
  "staging",
73551
74151
  "production"
73552
- ]
74152
+ ],
74153
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
74154
+ "example": null
73553
74155
  },
73554
74156
  "source": {
73555
74157
  "type": "string",
@@ -73562,10 +74164,14 @@
73562
74164
  "import/repo",
73563
74165
  "redeploy",
73564
74166
  "v0-web"
73565
- ]
74167
+ ],
74168
+ "description": "Where was the deployment created from",
74169
+ "example": "cli"
73566
74170
  },
73567
74171
  "createdAt": {
73568
- "type": "number"
74172
+ "type": "number",
74173
+ "description": "A number containing the date when the deployment was created in milliseconds",
74174
+ "example": 1540257589405
73569
74175
  },
73570
74176
  "readyState": {
73571
74177
  "type": "string",
@@ -73576,7 +74182,9 @@
73576
74182
  "QUEUED",
73577
74183
  "READY",
73578
74184
  "CANCELED"
73579
- ]
74185
+ ],
74186
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
74187
+ "example": "READY"
73580
74188
  },
73581
74189
  "readyStateAt": {
73582
74190
  "type": "number"
@@ -73606,13 +74214,19 @@
73606
74214
  "nullable": true,
73607
74215
  "properties": {
73608
74216
  "id": {
73609
- "type": "string"
74217
+ "type": "string",
74218
+ "description": "A string holding the unique ID of the deployment",
74219
+ "example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
73610
74220
  },
73611
74221
  "name": {
73612
- "type": "string"
74222
+ "type": "string",
74223
+ "description": "The name of the project associated with the deployment at the time that the deployment was created",
74224
+ "example": "my-project"
73613
74225
  },
73614
74226
  "url": {
73615
- "type": "string"
74227
+ "type": "string",
74228
+ "description": "A string with the unique URL of the deployment",
74229
+ "example": "my-instant-deployment-3ij3cxz9qr.now.sh"
73616
74230
  },
73617
74231
  "target": {
73618
74232
  "nullable": true,
@@ -73620,7 +74234,9 @@
73620
74234
  "enum": [
73621
74235
  "staging",
73622
74236
  "production"
73623
- ]
74237
+ ],
74238
+ "description": "If defined, either `staging` if a staging alias in the format `\u003cproject\u003e.\u003cteam\u003e.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the \"preview\" deployment.",
74239
+ "example": null
73624
74240
  },
73625
74241
  "source": {
73626
74242
  "type": "string",
@@ -73633,10 +74249,14 @@
73633
74249
  "import/repo",
73634
74250
  "redeploy",
73635
74251
  "v0-web"
73636
- ]
74252
+ ],
74253
+ "description": "Where was the deployment created from",
74254
+ "example": "cli"
73637
74255
  },
73638
74256
  "createdAt": {
73639
- "type": "number"
74257
+ "type": "number",
74258
+ "description": "A number containing the date when the deployment was created in milliseconds",
74259
+ "example": 1540257589405
73640
74260
  },
73641
74261
  "readyState": {
73642
74262
  "type": "string",
@@ -73647,7 +74267,9 @@
73647
74267
  "QUEUED",
73648
74268
  "READY",
73649
74269
  "CANCELED"
73650
- ]
74270
+ ],
74271
+ "description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
74272
+ "example": "READY"
73651
74273
  },
73652
74274
  "readyStateAt": {
73653
74275
  "type": "number"
@@ -79041,34 +79663,34 @@
79041
79663
  "maxLength": {
79042
79664
  "type": "object",
79043
79665
  "properties": {
79044
- "__@BRAND@8684": {
79666
+ "__@BRAND@8675": {
79045
79667
  "type": "object"
79046
79668
  }
79047
79669
  },
79048
79670
  "required": [
79049
- "__@BRAND@8684"
79671
+ "__@BRAND@8675"
79050
79672
  ]
79051
79673
  },
79052
79674
  "minLength": {
79053
79675
  "type": "object",
79054
79676
  "properties": {
79055
- "__@BRAND@8684": {
79677
+ "__@BRAND@8675": {
79056
79678
  "type": "object"
79057
79679
  }
79058
79680
  },
79059
79681
  "required": [
79060
- "__@BRAND@8684"
79682
+ "__@BRAND@8675"
79061
79683
  ]
79062
79684
  },
79063
79685
  "pattern": {
79064
79686
  "type": "object",
79065
79687
  "properties": {
79066
- "__@BRAND@8684": {
79688
+ "__@BRAND@8675": {
79067
79689
  "type": "object"
79068
79690
  }
79069
79691
  },
79070
79692
  "required": [
79071
- "__@BRAND@8684"
79693
+ "__@BRAND@8675"
79072
79694
  ]
79073
79695
  },
79074
79696
  "description": {
@@ -79751,34 +80373,34 @@
79751
80373
  "maxLength": {
79752
80374
  "type": "object",
79753
80375
  "properties": {
79754
- "__@BRAND@8684": {
80376
+ "__@BRAND@8675": {
79755
80377
  "type": "object"
79756
80378
  }
79757
80379
  },
79758
80380
  "required": [
79759
- "__@BRAND@8684"
80381
+ "__@BRAND@8675"
79760
80382
  ]
79761
80383
  },
79762
80384
  "minLength": {
79763
80385
  "type": "object",
79764
80386
  "properties": {
79765
- "__@BRAND@8684": {
80387
+ "__@BRAND@8675": {
79766
80388
  "type": "object"
79767
80389
  }
79768
80390
  },
79769
80391
  "required": [
79770
- "__@BRAND@8684"
80392
+ "__@BRAND@8675"
79771
80393
  ]
79772
80394
  },
79773
80395
  "pattern": {
79774
80396
  "type": "object",
79775
80397
  "properties": {
79776
- "__@BRAND@8684": {
80398
+ "__@BRAND@8675": {
79777
80399
  "type": "object"
79778
80400
  }
79779
80401
  },
79780
80402
  "required": [
79781
- "__@BRAND@8684"
80403
+ "__@BRAND@8675"
79782
80404
  ]
79783
80405
  },
79784
80406
  "description": {
@@ -79927,34 +80549,34 @@
79927
80549
  "minLength": {
79928
80550
  "type": "object",
79929
80551
  "properties": {
79930
- "__@BRAND@8684": {
80552
+ "__@BRAND@8675": {
79931
80553
  "type": "object"
79932
80554
  }
79933
80555
  },
79934
80556
  "required": [
79935
- "__@BRAND@8684"
80557
+ "__@BRAND@8675"
79936
80558
  ]
79937
80559
  },
79938
80560
  "maxLength": {
79939
80561
  "type": "object",
79940
80562
  "properties": {
79941
- "__@BRAND@8684": {
80563
+ "__@BRAND@8675": {
79942
80564
  "type": "object"
79943
80565
  }
79944
80566
  },
79945
80567
  "required": [
79946
- "__@BRAND@8684"
80568
+ "__@BRAND@8675"
79947
80569
  ]
79948
80570
  },
79949
80571
  "pattern": {
79950
80572
  "type": "object",
79951
80573
  "properties": {
79952
- "__@BRAND@8684": {
80574
+ "__@BRAND@8675": {
79953
80575
  "type": "object"
79954
80576
  }
79955
80577
  },
79956
80578
  "required": [
79957
- "__@BRAND@8684"
80579
+ "__@BRAND@8675"
79958
80580
  ]
79959
80581
  },
79960
80582
  "default": {
@@ -80271,12 +80893,12 @@
80271
80893
  {
80272
80894
  "type": "object",
80273
80895
  "properties": {
80274
- "__@BRAND@8684": {
80896
+ "__@BRAND@8675": {
80275
80897
  "type": "object"
80276
80898
  }
80277
80899
  },
80278
80900
  "required": [
80279
- "__@BRAND@8684"
80901
+ "__@BRAND@8675"
80280
80902
  ]
80281
80903
  },
80282
80904
  {
@@ -80284,12 +80906,12 @@
80284
80906
  "value": {
80285
80907
  "type": "object",
80286
80908
  "properties": {
80287
- "__@BRAND@8684": {
80909
+ "__@BRAND@8675": {
80288
80910
  "type": "object"
80289
80911
  }
80290
80912
  },
80291
80913
  "required": [
80292
- "__@BRAND@8684"
80914
+ "__@BRAND@8675"
80293
80915
  ]
80294
80916
  },
80295
80917
  "disabled": {
@@ -80361,34 +80983,34 @@
80361
80983
  "maxLength": {
80362
80984
  "type": "object",
80363
80985
  "properties": {
80364
- "__@BRAND@8684": {
80986
+ "__@BRAND@8675": {
80365
80987
  "type": "object"
80366
80988
  }
80367
80989
  },
80368
80990
  "required": [
80369
- "__@BRAND@8684"
80991
+ "__@BRAND@8675"
80370
80992
  ]
80371
80993
  },
80372
80994
  "minLength": {
80373
80995
  "type": "object",
80374
80996
  "properties": {
80375
- "__@BRAND@8684": {
80997
+ "__@BRAND@8675": {
80376
80998
  "type": "object"
80377
80999
  }
80378
81000
  },
80379
81001
  "required": [
80380
- "__@BRAND@8684"
81002
+ "__@BRAND@8675"
80381
81003
  ]
80382
81004
  },
80383
81005
  "pattern": {
80384
81006
  "type": "object",
80385
81007
  "properties": {
80386
- "__@BRAND@8684": {
81008
+ "__@BRAND@8675": {
80387
81009
  "type": "object"
80388
81010
  }
80389
81011
  },
80390
81012
  "required": [
80391
- "__@BRAND@8684"
81013
+ "__@BRAND@8675"
80392
81014
  ]
80393
81015
  },
80394
81016
  "description": {
@@ -80538,34 +81160,34 @@
80538
81160
  "maxLength": {
80539
81161
  "type": "object",
80540
81162
  "properties": {
80541
- "__@BRAND@8684": {
81163
+ "__@BRAND@8675": {
80542
81164
  "type": "object"
80543
81165
  }
80544
81166
  },
80545
81167
  "required": [
80546
- "__@BRAND@8684"
81168
+ "__@BRAND@8675"
80547
81169
  ]
80548
81170
  },
80549
81171
  "minLength": {
80550
81172
  "type": "object",
80551
81173
  "properties": {
80552
- "__@BRAND@8684": {
81174
+ "__@BRAND@8675": {
80553
81175
  "type": "object"
80554
81176
  }
80555
81177
  },
80556
81178
  "required": [
80557
- "__@BRAND@8684"
81179
+ "__@BRAND@8675"
80558
81180
  ]
80559
81181
  },
80560
81182
  "pattern": {
80561
81183
  "type": "object",
80562
81184
  "properties": {
80563
- "__@BRAND@8684": {
81185
+ "__@BRAND@8675": {
80564
81186
  "type": "object"
80565
81187
  }
80566
81188
  },
80567
81189
  "required": [
80568
- "__@BRAND@8684"
81190
+ "__@BRAND@8675"
80569
81191
  ]
80570
81192
  },
80571
81193
  "description": {
@@ -80696,12 +81318,12 @@
80696
81318
  "value": {
80697
81319
  "type": "object",
80698
81320
  "properties": {
80699
- "__@BRAND@8684": {
81321
+ "__@BRAND@8675": {
80700
81322
  "type": "object"
80701
81323
  }
80702
81324
  },
80703
81325
  "required": [
80704
- "__@BRAND@8684"
81326
+ "__@BRAND@8675"
80705
81327
  ]
80706
81328
  },
80707
81329
  "disabled": {
@@ -80957,12 +81579,12 @@
80957
81579
  "value": {
80958
81580
  "type": "object",
80959
81581
  "properties": {
80960
- "__@BRAND@8684": {
81582
+ "__@BRAND@8675": {
80961
81583
  "type": "object"
80962
81584
  }
80963
81585
  },
80964
81586
  "required": [
80965
- "__@BRAND@8684"
81587
+ "__@BRAND@8675"
80966
81588
  ]
80967
81589
  },
80968
81590
  "disabled": {
@@ -81832,7 +82454,7 @@
81832
82454
  },
81833
82455
  "/v1/teams/{teamId}/members": {
81834
82456
  "post": {
81835
- "description": "Invite a user to join the team specified in the URL. The authenticated user needs to be an `OWNER` in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority.",
82457
+ "description": "Invite a user to join the team specified in the URL. The authenticated user needs to be an `OWNER` in order to successfully invoke this endpoint. The user to be invited must be specified by email.",
81836
82458
  "operationId": "inviteUserToTeam",
81837
82459
  "security": [
81838
82460
  {
@@ -89337,7 +89959,26 @@
89337
89959
  ]
89338
89960
  },
89339
89961
  "required_when": {
89340
- "type": "string"
89962
+ "anyOf": [
89963
+ {
89964
+ "type": "string"
89965
+ },
89966
+ {
89967
+ "type": "object",
89968
+ "required": [
89969
+ "value_in"
89970
+ ],
89971
+ "properties": {
89972
+ "value_in": {
89973
+ "type": "array",
89974
+ "items": {
89975
+ "type": "string"
89976
+ }
89977
+ }
89978
+ },
89979
+ "additionalProperties": false
89980
+ }
89981
+ ]
89341
89982
  },
89342
89983
  "type": {
89343
89984
  "type": "string",
@@ -89417,7 +90058,26 @@
89417
90058
  ]
89418
90059
  },
89419
90060
  "required_when": {
89420
- "type": "string"
90061
+ "anyOf": [
90062
+ {
90063
+ "type": "string"
90064
+ },
90065
+ {
90066
+ "type": "object",
90067
+ "required": [
90068
+ "value_in"
90069
+ ],
90070
+ "properties": {
90071
+ "value_in": {
90072
+ "type": "array",
90073
+ "items": {
90074
+ "type": "string"
90075
+ }
90076
+ }
90077
+ },
90078
+ "additionalProperties": false
90079
+ }
90080
+ ]
89421
90081
  },
89422
90082
  "type": {
89423
90083
  "type": "string",
@@ -89496,7 +90156,26 @@
89496
90156
  ]
89497
90157
  },
89498
90158
  "required_when": {
89499
- "type": "string"
90159
+ "anyOf": [
90160
+ {
90161
+ "type": "string"
90162
+ },
90163
+ {
90164
+ "type": "object",
90165
+ "required": [
90166
+ "value_in"
90167
+ ],
90168
+ "properties": {
90169
+ "value_in": {
90170
+ "type": "array",
90171
+ "items": {
90172
+ "type": "string"
90173
+ }
90174
+ }
90175
+ },
90176
+ "additionalProperties": false
90177
+ }
90178
+ ]
89500
90179
  },
89501
90180
  "type": {
89502
90181
  "type": "string",
@@ -89551,7 +90230,26 @@
89551
90230
  ]
89552
90231
  },
89553
90232
  "required_when": {
89554
- "type": "string"
90233
+ "anyOf": [
90234
+ {
90235
+ "type": "string"
90236
+ },
90237
+ {
90238
+ "type": "object",
90239
+ "required": [
90240
+ "value_in"
90241
+ ],
90242
+ "properties": {
90243
+ "value_in": {
90244
+ "type": "array",
90245
+ "items": {
90246
+ "type": "string"
90247
+ }
90248
+ }
90249
+ },
90250
+ "additionalProperties": false
90251
+ }
90252
+ ]
89555
90253
  },
89556
90254
  "type": {
89557
90255
  "type": "string",
@@ -92456,6 +93154,18 @@
92456
93154
  },
92457
93155
  "type": "object"
92458
93156
  },
93157
+ "buildQueue": {
93158
+ "properties": {
93159
+ "configuration": {
93160
+ "type": "string",
93161
+ "enum": [
93162
+ "SKIP_NAMESPACE_QUEUE",
93163
+ "WAIT_FOR_NAMESPACE_QUEUE"
93164
+ ]
93165
+ }
93166
+ },
93167
+ "type": "object"
93168
+ },
92459
93169
  "awsAccountType": {
92460
93170
  "type": "string"
92461
93171
  },
@@ -97329,6 +98039,9 @@
97329
98039
  "oneOf": [
97330
98040
  {
97331
98041
  "properties": {
98042
+ "isDefaultApp": {
98043
+ "type": "boolean"
98044
+ },
97332
98045
  "updatedAt": {
97333
98046
  "type": "number",
97334
98047
  "description": "Timestamp when the microfrontends settings were last updated."
@@ -97353,17 +98066,59 @@
97353
98066
  "type": "boolean",
97354
98067
  "description": "Whether microfrontends are enabled for this project."
97355
98068
  },
97356
- "isDefaultApp": {
97357
- "type": "boolean",
97358
- "description": "Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends."
97359
- },
97360
98069
  "defaultRoute": {
97361
98070
  "type": "string",
97362
98071
  "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
98072
+ }
98073
+ },
98074
+ "required": [
98075
+ "isDefaultApp",
98076
+ "updatedAt",
98077
+ "groupIds",
98078
+ "enabled"
98079
+ ],
98080
+ "type": "object"
98081
+ },
98082
+ {
98083
+ "properties": {
98084
+ "isDefaultApp": {
98085
+ "type": "boolean"
97363
98086
  },
97364
98087
  "routeObservabilityToThisProject": {
97365
98088
  "type": "boolean",
97366
98089
  "description": "Whether observability data should be routed to this microfrontend project or a root project."
98090
+ },
98091
+ "doNotRouteWithMicrofrontendsRouting": {
98092
+ "type": "boolean",
98093
+ "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend."
98094
+ },
98095
+ "updatedAt": {
98096
+ "type": "number",
98097
+ "description": "Timestamp when the microfrontends settings were last updated."
98098
+ },
98099
+ "groupIds": {
98100
+ "items": {
98101
+ "oneOf": [
98102
+ {
98103
+ "type": "string"
98104
+ },
98105
+ {
98106
+ "type": "string"
98107
+ }
98108
+ ]
98109
+ },
98110
+ "maxItems": 2,
98111
+ "minItems": 2,
98112
+ "type": "array",
98113
+ "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together."
98114
+ },
98115
+ "enabled": {
98116
+ "type": "boolean",
98117
+ "description": "Whether microfrontends are enabled for this project."
98118
+ },
98119
+ "defaultRoute": {
98120
+ "type": "string",
98121
+ "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
97367
98122
  }
97368
98123
  },
97369
98124
  "required": [
@@ -97414,6 +98169,9 @@
97414
98169
  "oneOf": [
97415
98170
  {
97416
98171
  "properties": {
98172
+ "isDefaultApp": {
98173
+ "type": "boolean"
98174
+ },
97417
98175
  "updatedAt": {
97418
98176
  "type": "number",
97419
98177
  "description": "Timestamp when the microfrontends settings were last updated."
@@ -97438,17 +98196,59 @@
97438
98196
  "type": "boolean",
97439
98197
  "description": "Whether microfrontends are enabled for this project."
97440
98198
  },
97441
- "isDefaultApp": {
97442
- "type": "boolean",
97443
- "description": "Whether this project is the default application for the microfrontends group. The default application is the one that is used as the top level shell for the microfrontends group and hosts the other microfrontends."
97444
- },
97445
98199
  "defaultRoute": {
97446
98200
  "type": "string",
97447
98201
  "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
98202
+ }
98203
+ },
98204
+ "required": [
98205
+ "isDefaultApp",
98206
+ "updatedAt",
98207
+ "groupIds",
98208
+ "enabled"
98209
+ ],
98210
+ "type": "object"
98211
+ },
98212
+ {
98213
+ "properties": {
98214
+ "isDefaultApp": {
98215
+ "type": "boolean"
97448
98216
  },
97449
98217
  "routeObservabilityToThisProject": {
97450
98218
  "type": "boolean",
97451
98219
  "description": "Whether observability data should be routed to this microfrontend project or a root project."
98220
+ },
98221
+ "doNotRouteWithMicrofrontendsRouting": {
98222
+ "type": "boolean",
98223
+ "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend."
98224
+ },
98225
+ "updatedAt": {
98226
+ "type": "number",
98227
+ "description": "Timestamp when the microfrontends settings were last updated."
98228
+ },
98229
+ "groupIds": {
98230
+ "items": {
98231
+ "oneOf": [
98232
+ {
98233
+ "type": "string"
98234
+ },
98235
+ {
98236
+ "type": "string"
98237
+ }
98238
+ ]
98239
+ },
98240
+ "maxItems": 2,
98241
+ "minItems": 2,
98242
+ "type": "array",
98243
+ "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together."
98244
+ },
98245
+ "enabled": {
98246
+ "type": "boolean",
98247
+ "description": "Whether microfrontends are enabled for this project."
98248
+ },
98249
+ "defaultRoute": {
98250
+ "type": "string",
98251
+ "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`"
97452
98252
  }
97453
98253
  },
97454
98254
  "required": [
@@ -99148,6 +99948,20 @@
99148
99948
  "type": "object",
99149
99949
  "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
99150
99950
  },
99951
+ "buildQueue": {
99952
+ "properties": {
99953
+ "configuration": {
99954
+ "type": "string",
99955
+ "enum": [
99956
+ "SKIP_NAMESPACE_QUEUE",
99957
+ "WAIT_FOR_NAMESPACE_QUEUE"
99958
+ ],
99959
+ "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
99960
+ }
99961
+ },
99962
+ "type": "object",
99963
+ "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
99964
+ },
99151
99965
  "awsAccountType": {
99152
99966
  "type": "string",
99153
99967
  "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."