@vercel/sdk 1.6.6 → 1.6.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -31
- package/bin/mcp-server.js +2608 -910
- package/bin/mcp-server.js.map +31 -28
- package/docs/sdks/projects/README.md +1 -1
- package/docs/sdks/vercel/README.md +77 -0
- package/esm/__tests__/environment.test.js +28 -4
- package/esm/__tests__/environment.test.js.map +1 -1
- package/esm/__tests__/projects.test.js +15 -13
- package/esm/__tests__/projects.test.js.map +1 -1
- package/esm/__tests__/vercel.test.d.ts +2 -0
- package/esm/__tests__/vercel.test.d.ts.map +1 -0
- package/esm/__tests__/vercel.test.js +21 -0
- package/esm/__tests__/vercel.test.js.map +1 -0
- package/esm/funcs/marketplaceUpdateResourceSecretsById.js +2 -2
- package/esm/funcs/marketplaceUpdateResourceSecretsById.js.map +1 -1
- package/esm/funcs/patchAliasesIdProtectionBypass.d.ts +18 -0
- package/esm/funcs/patchAliasesIdProtectionBypass.d.ts.map +1 -0
- package/esm/funcs/patchAliasesIdProtectionBypass.js +81 -0
- package/esm/funcs/patchAliasesIdProtectionBypass.js.map +1 -0
- package/esm/funcs/projectsMoveProjectDomain.d.ts +1 -1
- package/esm/funcs/projectsMoveProjectDomain.js +1 -1
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/sdks.d.ts +3 -1
- package/esm/lib/sdks.d.ts.map +1 -1
- package/esm/lib/sdks.js +6 -11
- package/esm/lib/sdks.js.map +1 -1
- package/esm/mcp-server/mcp-server.js +1 -1
- package/esm/mcp-server/server.d.ts.map +1 -1
- package/esm/mcp-server/server.js +3 -1
- package/esm/mcp-server/server.js.map +1 -1
- package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.d.ts +7 -0
- package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.d.ts.map +1 -0
- package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.js +26 -0
- package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.js.map +1 -0
- package/esm/mcp-server/tools/projectsMoveProjectDomain.js +1 -1
- package/esm/models/authuser.d.ts +0 -5
- package/esm/models/authuser.d.ts.map +1 -1
- package/esm/models/authuser.js +0 -2
- package/esm/models/authuser.js.map +1 -1
- package/esm/models/canceldeploymentop.d.ts +268 -26
- package/esm/models/canceldeploymentop.d.ts.map +1 -1
- package/esm/models/canceldeploymentop.js +194 -24
- package/esm/models/canceldeploymentop.js.map +1 -1
- package/esm/models/createcustomenvironmentop.d.ts +244 -2
- package/esm/models/createcustomenvironmentop.d.ts.map +1 -1
- package/esm/models/createcustomenvironmentop.js +174 -2
- package/esm/models/createcustomenvironmentop.js.map +1 -1
- package/esm/models/createdeploymentop.d.ts +357 -58
- package/esm/models/createdeploymentop.d.ts.map +1 -1
- package/esm/models/createdeploymentop.js +290 -60
- package/esm/models/createdeploymentop.js.map +1 -1
- package/esm/models/createprojectop.d.ts +333 -71
- package/esm/models/createprojectop.d.ts.map +1 -1
- package/esm/models/createprojectop.js +255 -75
- package/esm/models/createprojectop.js.map +1 -1
- package/esm/models/createrecordop.d.ts +43 -43
- package/esm/models/createrecordop.d.ts.map +1 -1
- package/esm/models/createrecordop.js +51 -51
- package/esm/models/createrecordop.js.map +1 -1
- package/esm/models/getaliasop.d.ts +8 -8
- package/esm/models/getaliasop.d.ts.map +1 -1
- package/esm/models/getaliasop.js +12 -13
- package/esm/models/getaliasop.js.map +1 -1
- package/esm/models/getcustomenvironmentop.d.ts +242 -2
- package/esm/models/getcustomenvironmentop.d.ts.map +1 -1
- package/esm/models/getcustomenvironmentop.js +175 -2
- package/esm/models/getcustomenvironmentop.js.map +1 -1
- package/esm/models/getdeploymentop.d.ts +502 -18
- package/esm/models/getdeploymentop.d.ts.map +1 -1
- package/esm/models/getdeploymentop.js +354 -14
- package/esm/models/getdeploymentop.js.map +1 -1
- package/esm/models/getprojectdomainsop.d.ts +30 -30
- package/esm/models/getprojectdomainsop.d.ts.map +1 -1
- package/esm/models/getprojectdomainsop.js +32 -32
- package/esm/models/getprojectdomainsop.js.map +1 -1
- package/esm/models/getprojectsop.d.ts +347 -95
- package/esm/models/getprojectsop.d.ts.map +1 -1
- package/esm/models/getprojectsop.js +287 -112
- package/esm/models/getprojectsop.js.map +1 -1
- package/esm/models/getv9projectsidornamecustomenvironmentsop.d.ts +242 -2
- package/esm/models/getv9projectsidornamecustomenvironmentsop.d.ts.map +1 -1
- package/esm/models/getv9projectsidornamecustomenvironmentsop.js +172 -2
- package/esm/models/getv9projectsidornamecustomenvironmentsop.js.map +1 -1
- package/esm/models/listaliasesop.d.ts +8 -8
- package/esm/models/listaliasesop.d.ts.map +1 -1
- package/esm/models/listaliasesop.js +12 -12
- package/esm/models/listaliasesop.js.map +1 -1
- package/esm/models/patchaliasesidprotectionbypassop.d.ts +409 -0
- package/esm/models/patchaliasesidprotectionbypassop.d.ts.map +1 -0
- package/esm/models/patchaliasesidprotectionbypassop.js +386 -0
- package/esm/models/patchaliasesidprotectionbypassop.js.map +1 -0
- package/esm/models/removecustomenvironmentop.d.ts +245 -2
- package/esm/models/removecustomenvironmentop.d.ts.map +1 -1
- package/esm/models/removecustomenvironmentop.js +173 -2
- package/esm/models/removecustomenvironmentop.js.map +1 -1
- package/esm/models/updatecustomenvironmentop.d.ts +244 -2
- package/esm/models/updatecustomenvironmentop.d.ts.map +1 -1
- package/esm/models/updatecustomenvironmentop.js +174 -2
- package/esm/models/updatecustomenvironmentop.js.map +1 -1
- package/esm/models/updateprojectdatacacheop.d.ts +363 -111
- package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
- package/esm/models/updateprojectdatacacheop.js +311 -135
- package/esm/models/updateprojectdatacacheop.js.map +1 -1
- package/esm/models/updateprojectop.d.ts +347 -95
- package/esm/models/updateprojectop.d.ts.map +1 -1
- package/esm/models/updateprojectop.js +287 -111
- package/esm/models/updateprojectop.js.map +1 -1
- package/esm/models/userevent.d.ts +124 -6
- package/esm/models/userevent.d.ts.map +1 -1
- package/esm/models/userevent.js +114 -6
- package/esm/models/userevent.js.map +1 -1
- package/esm/sdk/projects.d.ts +1 -1
- package/esm/sdk/projects.js +1 -1
- package/esm/sdk/sdk.d.ts +8 -1
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +8 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/__tests__/environment.test.ts +28 -4
- package/src/__tests__/projects.test.ts +15 -13
- package/src/__tests__/vercel.test.ts +26 -0
- package/src/funcs/marketplaceUpdateResourceSecretsById.ts +2 -2
- package/src/funcs/patchAliasesIdProtectionBypass.ts +185 -0
- package/src/funcs/projectsMoveProjectDomain.ts +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/sdks.ts +11 -11
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +3 -1
- package/src/mcp-server/tools/patchAliasesIdProtectionBypass.ts +37 -0
- package/src/mcp-server/tools/projectsMoveProjectDomain.ts +1 -1
- package/src/models/authuser.ts +0 -7
- package/src/models/canceldeploymentop.ts +503 -43
- package/src/models/createcustomenvironmentop.ts +426 -4
- package/src/models/createdeploymentop.ts +640 -117
- package/src/models/createprojectop.ts +664 -200
- package/src/models/createrecordop.ts +96 -84
- package/src/models/getaliasop.ts +16 -14
- package/src/models/getcustomenvironmentop.ts +412 -4
- package/src/models/getdeploymentop.ts +962 -49
- package/src/models/getprojectdomainsop.ts +84 -84
- package/src/models/getprojectsop.ts +637 -189
- package/src/models/getv9projectsidornamecustomenvironmentsop.ts +473 -4
- package/src/models/listaliasesop.ts +19 -16
- package/src/models/patchaliasesidprotectionbypassop.ts +786 -0
- package/src/models/removecustomenvironmentop.ts +425 -4
- package/src/models/updatecustomenvironmentop.ts +437 -4
- package/src/models/updateprojectdatacacheop.ts +738 -271
- package/src/models/updateprojectop.ts +697 -247
- package/src/models/userevent.ts +205 -12
- package/src/sdk/projects.ts +1 -1
- package/src/sdk/sdk.ts +18 -1
- package/vercel-spec.json +2667 -162
package/vercel-spec.json
CHANGED
|
@@ -4812,7 +4812,161 @@
|
|
|
4812
4812
|
},
|
|
4813
4813
|
"customEnvironments": {
|
|
4814
4814
|
"items": {
|
|
4815
|
-
"
|
|
4815
|
+
"properties": {
|
|
4816
|
+
"id": {
|
|
4817
|
+
"type": "string",
|
|
4818
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
4819
|
+
},
|
|
4820
|
+
"slug": {
|
|
4821
|
+
"type": "string",
|
|
4822
|
+
"description": "URL-friendly name of the environment"
|
|
4823
|
+
},
|
|
4824
|
+
"type": {
|
|
4825
|
+
"type": "string",
|
|
4826
|
+
"enum": [
|
|
4827
|
+
"production",
|
|
4828
|
+
"preview",
|
|
4829
|
+
"development"
|
|
4830
|
+
],
|
|
4831
|
+
"description": "The type of environment (production, preview, or development)"
|
|
4832
|
+
},
|
|
4833
|
+
"description": {
|
|
4834
|
+
"type": "string",
|
|
4835
|
+
"description": "Optional description of the environment's purpose"
|
|
4836
|
+
},
|
|
4837
|
+
"branchMatcher": {
|
|
4838
|
+
"properties": {
|
|
4839
|
+
"type": {
|
|
4840
|
+
"type": "string",
|
|
4841
|
+
"enum": [
|
|
4842
|
+
"endsWith",
|
|
4843
|
+
"startsWith",
|
|
4844
|
+
"equals"
|
|
4845
|
+
],
|
|
4846
|
+
"description": "The type of matching to perform"
|
|
4847
|
+
},
|
|
4848
|
+
"pattern": {
|
|
4849
|
+
"type": "string",
|
|
4850
|
+
"description": "The pattern to match against branch names"
|
|
4851
|
+
}
|
|
4852
|
+
},
|
|
4853
|
+
"required": [
|
|
4854
|
+
"type",
|
|
4855
|
+
"pattern"
|
|
4856
|
+
],
|
|
4857
|
+
"type": "object",
|
|
4858
|
+
"description": "Configuration for matching git branches to this environment"
|
|
4859
|
+
},
|
|
4860
|
+
"domains": {
|
|
4861
|
+
"items": {
|
|
4862
|
+
"properties": {
|
|
4863
|
+
"name": {
|
|
4864
|
+
"type": "string"
|
|
4865
|
+
},
|
|
4866
|
+
"apexName": {
|
|
4867
|
+
"type": "string"
|
|
4868
|
+
},
|
|
4869
|
+
"projectId": {
|
|
4870
|
+
"type": "string"
|
|
4871
|
+
},
|
|
4872
|
+
"redirect": {
|
|
4873
|
+
"nullable": true,
|
|
4874
|
+
"type": "string"
|
|
4875
|
+
},
|
|
4876
|
+
"redirectStatusCode": {
|
|
4877
|
+
"nullable": true,
|
|
4878
|
+
"type": "number",
|
|
4879
|
+
"enum": [
|
|
4880
|
+
307,
|
|
4881
|
+
301,
|
|
4882
|
+
302,
|
|
4883
|
+
308
|
|
4884
|
+
]
|
|
4885
|
+
},
|
|
4886
|
+
"gitBranch": {
|
|
4887
|
+
"nullable": true,
|
|
4888
|
+
"type": "string"
|
|
4889
|
+
},
|
|
4890
|
+
"customEnvironmentId": {
|
|
4891
|
+
"nullable": true,
|
|
4892
|
+
"type": "string"
|
|
4893
|
+
},
|
|
4894
|
+
"updatedAt": {
|
|
4895
|
+
"type": "number"
|
|
4896
|
+
},
|
|
4897
|
+
"createdAt": {
|
|
4898
|
+
"type": "number"
|
|
4899
|
+
},
|
|
4900
|
+
"verified": {
|
|
4901
|
+
"type": "boolean",
|
|
4902
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
4903
|
+
},
|
|
4904
|
+
"verification": {
|
|
4905
|
+
"items": {
|
|
4906
|
+
"properties": {
|
|
4907
|
+
"type": {
|
|
4908
|
+
"type": "string"
|
|
4909
|
+
},
|
|
4910
|
+
"domain": {
|
|
4911
|
+
"type": "string"
|
|
4912
|
+
},
|
|
4913
|
+
"value": {
|
|
4914
|
+
"type": "string"
|
|
4915
|
+
},
|
|
4916
|
+
"reason": {
|
|
4917
|
+
"type": "string"
|
|
4918
|
+
}
|
|
4919
|
+
},
|
|
4920
|
+
"required": [
|
|
4921
|
+
"type",
|
|
4922
|
+
"domain",
|
|
4923
|
+
"value",
|
|
4924
|
+
"reason"
|
|
4925
|
+
],
|
|
4926
|
+
"type": "object",
|
|
4927
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
4928
|
+
},
|
|
4929
|
+
"type": "array",
|
|
4930
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
4931
|
+
}
|
|
4932
|
+
},
|
|
4933
|
+
"required": [
|
|
4934
|
+
"name",
|
|
4935
|
+
"apexName",
|
|
4936
|
+
"projectId",
|
|
4937
|
+
"verified"
|
|
4938
|
+
],
|
|
4939
|
+
"type": "object",
|
|
4940
|
+
"description": "List of domains associated with this environment"
|
|
4941
|
+
},
|
|
4942
|
+
"type": "array",
|
|
4943
|
+
"description": "List of domains associated with this environment"
|
|
4944
|
+
},
|
|
4945
|
+
"currentDeploymentAliases": {
|
|
4946
|
+
"items": {
|
|
4947
|
+
"type": "string"
|
|
4948
|
+
},
|
|
4949
|
+
"type": "array",
|
|
4950
|
+
"description": "List of aliases for the current deployment"
|
|
4951
|
+
},
|
|
4952
|
+
"createdAt": {
|
|
4953
|
+
"type": "number",
|
|
4954
|
+
"description": "Timestamp when the environment was created"
|
|
4955
|
+
},
|
|
4956
|
+
"updatedAt": {
|
|
4957
|
+
"type": "number",
|
|
4958
|
+
"description": "Timestamp when the environment was last updated"
|
|
4959
|
+
}
|
|
4960
|
+
},
|
|
4961
|
+
"required": [
|
|
4962
|
+
"id",
|
|
4963
|
+
"slug",
|
|
4964
|
+
"type",
|
|
4965
|
+
"createdAt",
|
|
4966
|
+
"updatedAt"
|
|
4967
|
+
],
|
|
4968
|
+
"type": "object",
|
|
4969
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
4816
4970
|
},
|
|
4817
4971
|
"type": "array"
|
|
4818
4972
|
},
|
|
@@ -5688,6 +5842,10 @@
|
|
|
5688
5842
|
"requireApproval": {
|
|
5689
5843
|
"type": "boolean",
|
|
5690
5844
|
"description": "Whether or not this stage requires approval to proceed."
|
|
5845
|
+
},
|
|
5846
|
+
"duration": {
|
|
5847
|
+
"type": "number",
|
|
5848
|
+
"description": "duration is the total time to serve a stage, at the given targetPercentage."
|
|
5691
5849
|
}
|
|
5692
5850
|
},
|
|
5693
5851
|
"required": [
|
|
@@ -5777,8 +5935,8 @@
|
|
|
5777
5935
|
"deploymentType": {
|
|
5778
5936
|
"type": "string",
|
|
5779
5937
|
"enum": [
|
|
5780
|
-
"all",
|
|
5781
5938
|
"preview",
|
|
5939
|
+
"all",
|
|
5782
5940
|
"prod_deployment_urls_and_all_previews"
|
|
5783
5941
|
]
|
|
5784
5942
|
}
|
|
@@ -7300,6 +7458,10 @@
|
|
|
7300
7458
|
"toDeploymentId": {
|
|
7301
7459
|
"type": "string"
|
|
7302
7460
|
},
|
|
7461
|
+
"fromRollingReleaseId": {
|
|
7462
|
+
"type": "string",
|
|
7463
|
+
"description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
|
|
7464
|
+
},
|
|
7303
7465
|
"jobStatus": {
|
|
7304
7466
|
"type": "string",
|
|
7305
7467
|
"enum": [
|
|
@@ -7366,10 +7528,10 @@
|
|
|
7366
7528
|
"deploymentType": {
|
|
7367
7529
|
"type": "string",
|
|
7368
7530
|
"enum": [
|
|
7369
|
-
"
|
|
7531
|
+
"production",
|
|
7370
7532
|
"preview",
|
|
7371
|
-
"
|
|
7372
|
-
"
|
|
7533
|
+
"all",
|
|
7534
|
+
"prod_deployment_urls_and_all_previews"
|
|
7373
7535
|
]
|
|
7374
7536
|
},
|
|
7375
7537
|
"addresses": {
|
|
@@ -7409,10 +7571,10 @@
|
|
|
7409
7571
|
"deploymentType": {
|
|
7410
7572
|
"type": "string",
|
|
7411
7573
|
"enum": [
|
|
7412
|
-
"
|
|
7574
|
+
"production",
|
|
7413
7575
|
"preview",
|
|
7414
|
-
"
|
|
7415
|
-
"
|
|
7576
|
+
"all",
|
|
7577
|
+
"prod_deployment_urls_and_all_previews"
|
|
7416
7578
|
]
|
|
7417
7579
|
}
|
|
7418
7580
|
},
|
|
@@ -8802,7 +8964,161 @@
|
|
|
8802
8964
|
"customEnvironment": {
|
|
8803
8965
|
"oneOf": [
|
|
8804
8966
|
{
|
|
8805
|
-
"
|
|
8967
|
+
"properties": {
|
|
8968
|
+
"id": {
|
|
8969
|
+
"type": "string",
|
|
8970
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
8971
|
+
},
|
|
8972
|
+
"slug": {
|
|
8973
|
+
"type": "string",
|
|
8974
|
+
"description": "URL-friendly name of the environment"
|
|
8975
|
+
},
|
|
8976
|
+
"type": {
|
|
8977
|
+
"type": "string",
|
|
8978
|
+
"enum": [
|
|
8979
|
+
"production",
|
|
8980
|
+
"preview",
|
|
8981
|
+
"development"
|
|
8982
|
+
],
|
|
8983
|
+
"description": "The type of environment (production, preview, or development)"
|
|
8984
|
+
},
|
|
8985
|
+
"description": {
|
|
8986
|
+
"type": "string",
|
|
8987
|
+
"description": "Optional description of the environment's purpose"
|
|
8988
|
+
},
|
|
8989
|
+
"branchMatcher": {
|
|
8990
|
+
"properties": {
|
|
8991
|
+
"type": {
|
|
8992
|
+
"type": "string",
|
|
8993
|
+
"enum": [
|
|
8994
|
+
"startsWith",
|
|
8995
|
+
"equals",
|
|
8996
|
+
"endsWith"
|
|
8997
|
+
],
|
|
8998
|
+
"description": "The type of matching to perform"
|
|
8999
|
+
},
|
|
9000
|
+
"pattern": {
|
|
9001
|
+
"type": "string",
|
|
9002
|
+
"description": "The pattern to match against branch names"
|
|
9003
|
+
}
|
|
9004
|
+
},
|
|
9005
|
+
"required": [
|
|
9006
|
+
"type",
|
|
9007
|
+
"pattern"
|
|
9008
|
+
],
|
|
9009
|
+
"type": "object",
|
|
9010
|
+
"description": "Configuration for matching git branches to this environment"
|
|
9011
|
+
},
|
|
9012
|
+
"domains": {
|
|
9013
|
+
"items": {
|
|
9014
|
+
"properties": {
|
|
9015
|
+
"name": {
|
|
9016
|
+
"type": "string"
|
|
9017
|
+
},
|
|
9018
|
+
"apexName": {
|
|
9019
|
+
"type": "string"
|
|
9020
|
+
},
|
|
9021
|
+
"projectId": {
|
|
9022
|
+
"type": "string"
|
|
9023
|
+
},
|
|
9024
|
+
"redirect": {
|
|
9025
|
+
"nullable": true,
|
|
9026
|
+
"type": "string"
|
|
9027
|
+
},
|
|
9028
|
+
"redirectStatusCode": {
|
|
9029
|
+
"nullable": true,
|
|
9030
|
+
"type": "number",
|
|
9031
|
+
"enum": [
|
|
9032
|
+
307,
|
|
9033
|
+
301,
|
|
9034
|
+
302,
|
|
9035
|
+
308
|
|
9036
|
+
]
|
|
9037
|
+
},
|
|
9038
|
+
"gitBranch": {
|
|
9039
|
+
"nullable": true,
|
|
9040
|
+
"type": "string"
|
|
9041
|
+
},
|
|
9042
|
+
"customEnvironmentId": {
|
|
9043
|
+
"nullable": true,
|
|
9044
|
+
"type": "string"
|
|
9045
|
+
},
|
|
9046
|
+
"updatedAt": {
|
|
9047
|
+
"type": "number"
|
|
9048
|
+
},
|
|
9049
|
+
"createdAt": {
|
|
9050
|
+
"type": "number"
|
|
9051
|
+
},
|
|
9052
|
+
"verified": {
|
|
9053
|
+
"type": "boolean",
|
|
9054
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
9055
|
+
},
|
|
9056
|
+
"verification": {
|
|
9057
|
+
"items": {
|
|
9058
|
+
"properties": {
|
|
9059
|
+
"type": {
|
|
9060
|
+
"type": "string"
|
|
9061
|
+
},
|
|
9062
|
+
"domain": {
|
|
9063
|
+
"type": "string"
|
|
9064
|
+
},
|
|
9065
|
+
"value": {
|
|
9066
|
+
"type": "string"
|
|
9067
|
+
},
|
|
9068
|
+
"reason": {
|
|
9069
|
+
"type": "string"
|
|
9070
|
+
}
|
|
9071
|
+
},
|
|
9072
|
+
"required": [
|
|
9073
|
+
"type",
|
|
9074
|
+
"domain",
|
|
9075
|
+
"value",
|
|
9076
|
+
"reason"
|
|
9077
|
+
],
|
|
9078
|
+
"type": "object",
|
|
9079
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
9080
|
+
},
|
|
9081
|
+
"type": "array",
|
|
9082
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
9083
|
+
}
|
|
9084
|
+
},
|
|
9085
|
+
"required": [
|
|
9086
|
+
"name",
|
|
9087
|
+
"apexName",
|
|
9088
|
+
"projectId",
|
|
9089
|
+
"verified"
|
|
9090
|
+
],
|
|
9091
|
+
"type": "object",
|
|
9092
|
+
"description": "List of domains associated with this environment"
|
|
9093
|
+
},
|
|
9094
|
+
"type": "array",
|
|
9095
|
+
"description": "List of domains associated with this environment"
|
|
9096
|
+
},
|
|
9097
|
+
"currentDeploymentAliases": {
|
|
9098
|
+
"items": {
|
|
9099
|
+
"type": "string"
|
|
9100
|
+
},
|
|
9101
|
+
"type": "array",
|
|
9102
|
+
"description": "List of aliases for the current deployment"
|
|
9103
|
+
},
|
|
9104
|
+
"createdAt": {
|
|
9105
|
+
"type": "number",
|
|
9106
|
+
"description": "Timestamp when the environment was created"
|
|
9107
|
+
},
|
|
9108
|
+
"updatedAt": {
|
|
9109
|
+
"type": "number",
|
|
9110
|
+
"description": "Timestamp when the environment was last updated"
|
|
9111
|
+
}
|
|
9112
|
+
},
|
|
9113
|
+
"required": [
|
|
9114
|
+
"id",
|
|
9115
|
+
"slug",
|
|
9116
|
+
"type",
|
|
9117
|
+
"createdAt",
|
|
9118
|
+
"updatedAt"
|
|
9119
|
+
],
|
|
9120
|
+
"type": "object",
|
|
9121
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
8806
9122
|
},
|
|
8807
9123
|
{
|
|
8808
9124
|
"properties": {
|
|
@@ -9259,7 +9575,7 @@
|
|
|
9259
9575
|
"type": {
|
|
9260
9576
|
"type": "string",
|
|
9261
9577
|
"enum": [
|
|
9262
|
-
"github"
|
|
9578
|
+
"github-custom-host"
|
|
9263
9579
|
]
|
|
9264
9580
|
},
|
|
9265
9581
|
"host": {
|
|
@@ -10312,7 +10628,161 @@
|
|
|
10312
10628
|
"customEnvironment": {
|
|
10313
10629
|
"oneOf": [
|
|
10314
10630
|
{
|
|
10315
|
-
"
|
|
10631
|
+
"properties": {
|
|
10632
|
+
"id": {
|
|
10633
|
+
"type": "string",
|
|
10634
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
10635
|
+
},
|
|
10636
|
+
"slug": {
|
|
10637
|
+
"type": "string",
|
|
10638
|
+
"description": "URL-friendly name of the environment"
|
|
10639
|
+
},
|
|
10640
|
+
"type": {
|
|
10641
|
+
"type": "string",
|
|
10642
|
+
"enum": [
|
|
10643
|
+
"production",
|
|
10644
|
+
"preview",
|
|
10645
|
+
"development"
|
|
10646
|
+
],
|
|
10647
|
+
"description": "The type of environment (production, preview, or development)"
|
|
10648
|
+
},
|
|
10649
|
+
"description": {
|
|
10650
|
+
"type": "string",
|
|
10651
|
+
"description": "Optional description of the environment's purpose"
|
|
10652
|
+
},
|
|
10653
|
+
"branchMatcher": {
|
|
10654
|
+
"properties": {
|
|
10655
|
+
"type": {
|
|
10656
|
+
"type": "string",
|
|
10657
|
+
"enum": [
|
|
10658
|
+
"startsWith",
|
|
10659
|
+
"equals",
|
|
10660
|
+
"endsWith"
|
|
10661
|
+
],
|
|
10662
|
+
"description": "The type of matching to perform"
|
|
10663
|
+
},
|
|
10664
|
+
"pattern": {
|
|
10665
|
+
"type": "string",
|
|
10666
|
+
"description": "The pattern to match against branch names"
|
|
10667
|
+
}
|
|
10668
|
+
},
|
|
10669
|
+
"required": [
|
|
10670
|
+
"type",
|
|
10671
|
+
"pattern"
|
|
10672
|
+
],
|
|
10673
|
+
"type": "object",
|
|
10674
|
+
"description": "Configuration for matching git branches to this environment"
|
|
10675
|
+
},
|
|
10676
|
+
"domains": {
|
|
10677
|
+
"items": {
|
|
10678
|
+
"properties": {
|
|
10679
|
+
"name": {
|
|
10680
|
+
"type": "string"
|
|
10681
|
+
},
|
|
10682
|
+
"apexName": {
|
|
10683
|
+
"type": "string"
|
|
10684
|
+
},
|
|
10685
|
+
"projectId": {
|
|
10686
|
+
"type": "string"
|
|
10687
|
+
},
|
|
10688
|
+
"redirect": {
|
|
10689
|
+
"nullable": true,
|
|
10690
|
+
"type": "string"
|
|
10691
|
+
},
|
|
10692
|
+
"redirectStatusCode": {
|
|
10693
|
+
"nullable": true,
|
|
10694
|
+
"type": "number",
|
|
10695
|
+
"enum": [
|
|
10696
|
+
307,
|
|
10697
|
+
301,
|
|
10698
|
+
302,
|
|
10699
|
+
308
|
|
10700
|
+
]
|
|
10701
|
+
},
|
|
10702
|
+
"gitBranch": {
|
|
10703
|
+
"nullable": true,
|
|
10704
|
+
"type": "string"
|
|
10705
|
+
},
|
|
10706
|
+
"customEnvironmentId": {
|
|
10707
|
+
"nullable": true,
|
|
10708
|
+
"type": "string"
|
|
10709
|
+
},
|
|
10710
|
+
"updatedAt": {
|
|
10711
|
+
"type": "number"
|
|
10712
|
+
},
|
|
10713
|
+
"createdAt": {
|
|
10714
|
+
"type": "number"
|
|
10715
|
+
},
|
|
10716
|
+
"verified": {
|
|
10717
|
+
"type": "boolean",
|
|
10718
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
10719
|
+
},
|
|
10720
|
+
"verification": {
|
|
10721
|
+
"items": {
|
|
10722
|
+
"properties": {
|
|
10723
|
+
"type": {
|
|
10724
|
+
"type": "string"
|
|
10725
|
+
},
|
|
10726
|
+
"domain": {
|
|
10727
|
+
"type": "string"
|
|
10728
|
+
},
|
|
10729
|
+
"value": {
|
|
10730
|
+
"type": "string"
|
|
10731
|
+
},
|
|
10732
|
+
"reason": {
|
|
10733
|
+
"type": "string"
|
|
10734
|
+
}
|
|
10735
|
+
},
|
|
10736
|
+
"required": [
|
|
10737
|
+
"type",
|
|
10738
|
+
"domain",
|
|
10739
|
+
"value",
|
|
10740
|
+
"reason"
|
|
10741
|
+
],
|
|
10742
|
+
"type": "object",
|
|
10743
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
10744
|
+
},
|
|
10745
|
+
"type": "array",
|
|
10746
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
10747
|
+
}
|
|
10748
|
+
},
|
|
10749
|
+
"required": [
|
|
10750
|
+
"name",
|
|
10751
|
+
"apexName",
|
|
10752
|
+
"projectId",
|
|
10753
|
+
"verified"
|
|
10754
|
+
],
|
|
10755
|
+
"type": "object",
|
|
10756
|
+
"description": "List of domains associated with this environment"
|
|
10757
|
+
},
|
|
10758
|
+
"type": "array",
|
|
10759
|
+
"description": "List of domains associated with this environment"
|
|
10760
|
+
},
|
|
10761
|
+
"currentDeploymentAliases": {
|
|
10762
|
+
"items": {
|
|
10763
|
+
"type": "string"
|
|
10764
|
+
},
|
|
10765
|
+
"type": "array",
|
|
10766
|
+
"description": "List of aliases for the current deployment"
|
|
10767
|
+
},
|
|
10768
|
+
"createdAt": {
|
|
10769
|
+
"type": "number",
|
|
10770
|
+
"description": "Timestamp when the environment was created"
|
|
10771
|
+
},
|
|
10772
|
+
"updatedAt": {
|
|
10773
|
+
"type": "number",
|
|
10774
|
+
"description": "Timestamp when the environment was last updated"
|
|
10775
|
+
}
|
|
10776
|
+
},
|
|
10777
|
+
"required": [
|
|
10778
|
+
"id",
|
|
10779
|
+
"slug",
|
|
10780
|
+
"type",
|
|
10781
|
+
"createdAt",
|
|
10782
|
+
"updatedAt"
|
|
10783
|
+
],
|
|
10784
|
+
"type": "object",
|
|
10785
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
10316
10786
|
},
|
|
10317
10787
|
{
|
|
10318
10788
|
"properties": {
|
|
@@ -10769,7 +11239,7 @@
|
|
|
10769
11239
|
"type": {
|
|
10770
11240
|
"type": "string",
|
|
10771
11241
|
"enum": [
|
|
10772
|
-
"github"
|
|
11242
|
+
"github-custom-host"
|
|
10773
11243
|
]
|
|
10774
11244
|
},
|
|
10775
11245
|
"host": {
|
|
@@ -11583,7 +12053,161 @@
|
|
|
11583
12053
|
"customEnvironment": {
|
|
11584
12054
|
"oneOf": [
|
|
11585
12055
|
{
|
|
11586
|
-
"
|
|
12056
|
+
"properties": {
|
|
12057
|
+
"id": {
|
|
12058
|
+
"type": "string",
|
|
12059
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
12060
|
+
},
|
|
12061
|
+
"slug": {
|
|
12062
|
+
"type": "string",
|
|
12063
|
+
"description": "URL-friendly name of the environment"
|
|
12064
|
+
},
|
|
12065
|
+
"type": {
|
|
12066
|
+
"type": "string",
|
|
12067
|
+
"enum": [
|
|
12068
|
+
"production",
|
|
12069
|
+
"preview",
|
|
12070
|
+
"development"
|
|
12071
|
+
],
|
|
12072
|
+
"description": "The type of environment (production, preview, or development)"
|
|
12073
|
+
},
|
|
12074
|
+
"description": {
|
|
12075
|
+
"type": "string",
|
|
12076
|
+
"description": "Optional description of the environment's purpose"
|
|
12077
|
+
},
|
|
12078
|
+
"branchMatcher": {
|
|
12079
|
+
"properties": {
|
|
12080
|
+
"type": {
|
|
12081
|
+
"type": "string",
|
|
12082
|
+
"enum": [
|
|
12083
|
+
"startsWith",
|
|
12084
|
+
"equals",
|
|
12085
|
+
"endsWith"
|
|
12086
|
+
],
|
|
12087
|
+
"description": "The type of matching to perform"
|
|
12088
|
+
},
|
|
12089
|
+
"pattern": {
|
|
12090
|
+
"type": "string",
|
|
12091
|
+
"description": "The pattern to match against branch names"
|
|
12092
|
+
}
|
|
12093
|
+
},
|
|
12094
|
+
"required": [
|
|
12095
|
+
"type",
|
|
12096
|
+
"pattern"
|
|
12097
|
+
],
|
|
12098
|
+
"type": "object",
|
|
12099
|
+
"description": "Configuration for matching git branches to this environment"
|
|
12100
|
+
},
|
|
12101
|
+
"domains": {
|
|
12102
|
+
"items": {
|
|
12103
|
+
"properties": {
|
|
12104
|
+
"name": {
|
|
12105
|
+
"type": "string"
|
|
12106
|
+
},
|
|
12107
|
+
"apexName": {
|
|
12108
|
+
"type": "string"
|
|
12109
|
+
},
|
|
12110
|
+
"projectId": {
|
|
12111
|
+
"type": "string"
|
|
12112
|
+
},
|
|
12113
|
+
"redirect": {
|
|
12114
|
+
"nullable": true,
|
|
12115
|
+
"type": "string"
|
|
12116
|
+
},
|
|
12117
|
+
"redirectStatusCode": {
|
|
12118
|
+
"nullable": true,
|
|
12119
|
+
"type": "number",
|
|
12120
|
+
"enum": [
|
|
12121
|
+
307,
|
|
12122
|
+
301,
|
|
12123
|
+
302,
|
|
12124
|
+
308
|
|
12125
|
+
]
|
|
12126
|
+
},
|
|
12127
|
+
"gitBranch": {
|
|
12128
|
+
"nullable": true,
|
|
12129
|
+
"type": "string"
|
|
12130
|
+
},
|
|
12131
|
+
"customEnvironmentId": {
|
|
12132
|
+
"nullable": true,
|
|
12133
|
+
"type": "string"
|
|
12134
|
+
},
|
|
12135
|
+
"updatedAt": {
|
|
12136
|
+
"type": "number"
|
|
12137
|
+
},
|
|
12138
|
+
"createdAt": {
|
|
12139
|
+
"type": "number"
|
|
12140
|
+
},
|
|
12141
|
+
"verified": {
|
|
12142
|
+
"type": "boolean",
|
|
12143
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
12144
|
+
},
|
|
12145
|
+
"verification": {
|
|
12146
|
+
"items": {
|
|
12147
|
+
"properties": {
|
|
12148
|
+
"type": {
|
|
12149
|
+
"type": "string"
|
|
12150
|
+
},
|
|
12151
|
+
"domain": {
|
|
12152
|
+
"type": "string"
|
|
12153
|
+
},
|
|
12154
|
+
"value": {
|
|
12155
|
+
"type": "string"
|
|
12156
|
+
},
|
|
12157
|
+
"reason": {
|
|
12158
|
+
"type": "string"
|
|
12159
|
+
}
|
|
12160
|
+
},
|
|
12161
|
+
"required": [
|
|
12162
|
+
"type",
|
|
12163
|
+
"domain",
|
|
12164
|
+
"value",
|
|
12165
|
+
"reason"
|
|
12166
|
+
],
|
|
12167
|
+
"type": "object",
|
|
12168
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
12169
|
+
},
|
|
12170
|
+
"type": "array",
|
|
12171
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
12172
|
+
}
|
|
12173
|
+
},
|
|
12174
|
+
"required": [
|
|
12175
|
+
"name",
|
|
12176
|
+
"apexName",
|
|
12177
|
+
"projectId",
|
|
12178
|
+
"verified"
|
|
12179
|
+
],
|
|
12180
|
+
"type": "object",
|
|
12181
|
+
"description": "List of domains associated with this environment"
|
|
12182
|
+
},
|
|
12183
|
+
"type": "array",
|
|
12184
|
+
"description": "List of domains associated with this environment"
|
|
12185
|
+
},
|
|
12186
|
+
"currentDeploymentAliases": {
|
|
12187
|
+
"items": {
|
|
12188
|
+
"type": "string"
|
|
12189
|
+
},
|
|
12190
|
+
"type": "array",
|
|
12191
|
+
"description": "List of aliases for the current deployment"
|
|
12192
|
+
},
|
|
12193
|
+
"createdAt": {
|
|
12194
|
+
"type": "number",
|
|
12195
|
+
"description": "Timestamp when the environment was created"
|
|
12196
|
+
},
|
|
12197
|
+
"updatedAt": {
|
|
12198
|
+
"type": "number",
|
|
12199
|
+
"description": "Timestamp when the environment was last updated"
|
|
12200
|
+
}
|
|
12201
|
+
},
|
|
12202
|
+
"required": [
|
|
12203
|
+
"id",
|
|
12204
|
+
"slug",
|
|
12205
|
+
"type",
|
|
12206
|
+
"createdAt",
|
|
12207
|
+
"updatedAt"
|
|
12208
|
+
],
|
|
12209
|
+
"type": "object",
|
|
12210
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
11587
12211
|
},
|
|
11588
12212
|
{
|
|
11589
12213
|
"properties": {
|
|
@@ -11940,7 +12564,7 @@
|
|
|
11940
12564
|
"type": {
|
|
11941
12565
|
"type": "string",
|
|
11942
12566
|
"enum": [
|
|
11943
|
-
"github"
|
|
12567
|
+
"github-custom-host"
|
|
11944
12568
|
]
|
|
11945
12569
|
},
|
|
11946
12570
|
"host": {
|
|
@@ -13210,6 +13834,44 @@
|
|
|
13210
13834
|
],
|
|
13211
13835
|
"type": "object"
|
|
13212
13836
|
},
|
|
13837
|
+
{
|
|
13838
|
+
"properties": {
|
|
13839
|
+
"org": {
|
|
13840
|
+
"type": "string",
|
|
13841
|
+
"example": "vercel"
|
|
13842
|
+
},
|
|
13843
|
+
"ref": {
|
|
13844
|
+
"type": "string",
|
|
13845
|
+
"example": "main"
|
|
13846
|
+
},
|
|
13847
|
+
"repo": {
|
|
13848
|
+
"type": "string",
|
|
13849
|
+
"example": "next.js"
|
|
13850
|
+
},
|
|
13851
|
+
"sha": {
|
|
13852
|
+
"type": "string",
|
|
13853
|
+
"example": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0"
|
|
13854
|
+
},
|
|
13855
|
+
"host": {
|
|
13856
|
+
"type": "string"
|
|
13857
|
+
},
|
|
13858
|
+
"type": {
|
|
13859
|
+
"enum": [
|
|
13860
|
+
"github-custom-host"
|
|
13861
|
+
],
|
|
13862
|
+
"type": "string"
|
|
13863
|
+
}
|
|
13864
|
+
},
|
|
13865
|
+
"required": [
|
|
13866
|
+
"type",
|
|
13867
|
+
"ref",
|
|
13868
|
+
"org",
|
|
13869
|
+
"repo",
|
|
13870
|
+
"host"
|
|
13871
|
+
],
|
|
13872
|
+
"type": "object",
|
|
13873
|
+
"private": true
|
|
13874
|
+
},
|
|
13213
13875
|
{
|
|
13214
13876
|
"properties": {
|
|
13215
13877
|
"projectId": {
|
|
@@ -13989,7 +14651,161 @@
|
|
|
13989
14651
|
"customEnvironment": {
|
|
13990
14652
|
"oneOf": [
|
|
13991
14653
|
{
|
|
13992
|
-
"
|
|
14654
|
+
"properties": {
|
|
14655
|
+
"id": {
|
|
14656
|
+
"type": "string",
|
|
14657
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
14658
|
+
},
|
|
14659
|
+
"slug": {
|
|
14660
|
+
"type": "string",
|
|
14661
|
+
"description": "URL-friendly name of the environment"
|
|
14662
|
+
},
|
|
14663
|
+
"type": {
|
|
14664
|
+
"type": "string",
|
|
14665
|
+
"enum": [
|
|
14666
|
+
"production",
|
|
14667
|
+
"preview",
|
|
14668
|
+
"development"
|
|
14669
|
+
],
|
|
14670
|
+
"description": "The type of environment (production, preview, or development)"
|
|
14671
|
+
},
|
|
14672
|
+
"description": {
|
|
14673
|
+
"type": "string",
|
|
14674
|
+
"description": "Optional description of the environment's purpose"
|
|
14675
|
+
},
|
|
14676
|
+
"branchMatcher": {
|
|
14677
|
+
"properties": {
|
|
14678
|
+
"type": {
|
|
14679
|
+
"type": "string",
|
|
14680
|
+
"enum": [
|
|
14681
|
+
"startsWith",
|
|
14682
|
+
"equals",
|
|
14683
|
+
"endsWith"
|
|
14684
|
+
],
|
|
14685
|
+
"description": "The type of matching to perform"
|
|
14686
|
+
},
|
|
14687
|
+
"pattern": {
|
|
14688
|
+
"type": "string",
|
|
14689
|
+
"description": "The pattern to match against branch names"
|
|
14690
|
+
}
|
|
14691
|
+
},
|
|
14692
|
+
"required": [
|
|
14693
|
+
"type",
|
|
14694
|
+
"pattern"
|
|
14695
|
+
],
|
|
14696
|
+
"type": "object",
|
|
14697
|
+
"description": "Configuration for matching git branches to this environment"
|
|
14698
|
+
},
|
|
14699
|
+
"domains": {
|
|
14700
|
+
"items": {
|
|
14701
|
+
"properties": {
|
|
14702
|
+
"name": {
|
|
14703
|
+
"type": "string"
|
|
14704
|
+
},
|
|
14705
|
+
"apexName": {
|
|
14706
|
+
"type": "string"
|
|
14707
|
+
},
|
|
14708
|
+
"projectId": {
|
|
14709
|
+
"type": "string"
|
|
14710
|
+
},
|
|
14711
|
+
"redirect": {
|
|
14712
|
+
"nullable": true,
|
|
14713
|
+
"type": "string"
|
|
14714
|
+
},
|
|
14715
|
+
"redirectStatusCode": {
|
|
14716
|
+
"nullable": true,
|
|
14717
|
+
"type": "number",
|
|
14718
|
+
"enum": [
|
|
14719
|
+
307,
|
|
14720
|
+
301,
|
|
14721
|
+
302,
|
|
14722
|
+
308
|
|
14723
|
+
]
|
|
14724
|
+
},
|
|
14725
|
+
"gitBranch": {
|
|
14726
|
+
"nullable": true,
|
|
14727
|
+
"type": "string"
|
|
14728
|
+
},
|
|
14729
|
+
"customEnvironmentId": {
|
|
14730
|
+
"nullable": true,
|
|
14731
|
+
"type": "string"
|
|
14732
|
+
},
|
|
14733
|
+
"updatedAt": {
|
|
14734
|
+
"type": "number"
|
|
14735
|
+
},
|
|
14736
|
+
"createdAt": {
|
|
14737
|
+
"type": "number"
|
|
14738
|
+
},
|
|
14739
|
+
"verified": {
|
|
14740
|
+
"type": "boolean",
|
|
14741
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
14742
|
+
},
|
|
14743
|
+
"verification": {
|
|
14744
|
+
"items": {
|
|
14745
|
+
"properties": {
|
|
14746
|
+
"type": {
|
|
14747
|
+
"type": "string"
|
|
14748
|
+
},
|
|
14749
|
+
"domain": {
|
|
14750
|
+
"type": "string"
|
|
14751
|
+
},
|
|
14752
|
+
"value": {
|
|
14753
|
+
"type": "string"
|
|
14754
|
+
},
|
|
14755
|
+
"reason": {
|
|
14756
|
+
"type": "string"
|
|
14757
|
+
}
|
|
14758
|
+
},
|
|
14759
|
+
"required": [
|
|
14760
|
+
"type",
|
|
14761
|
+
"domain",
|
|
14762
|
+
"value",
|
|
14763
|
+
"reason"
|
|
14764
|
+
],
|
|
14765
|
+
"type": "object",
|
|
14766
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
14767
|
+
},
|
|
14768
|
+
"type": "array",
|
|
14769
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
14770
|
+
}
|
|
14771
|
+
},
|
|
14772
|
+
"required": [
|
|
14773
|
+
"name",
|
|
14774
|
+
"apexName",
|
|
14775
|
+
"projectId",
|
|
14776
|
+
"verified"
|
|
14777
|
+
],
|
|
14778
|
+
"type": "object",
|
|
14779
|
+
"description": "List of domains associated with this environment"
|
|
14780
|
+
},
|
|
14781
|
+
"type": "array",
|
|
14782
|
+
"description": "List of domains associated with this environment"
|
|
14783
|
+
},
|
|
14784
|
+
"currentDeploymentAliases": {
|
|
14785
|
+
"items": {
|
|
14786
|
+
"type": "string"
|
|
14787
|
+
},
|
|
14788
|
+
"type": "array",
|
|
14789
|
+
"description": "List of aliases for the current deployment"
|
|
14790
|
+
},
|
|
14791
|
+
"createdAt": {
|
|
14792
|
+
"type": "number",
|
|
14793
|
+
"description": "Timestamp when the environment was created"
|
|
14794
|
+
},
|
|
14795
|
+
"updatedAt": {
|
|
14796
|
+
"type": "number",
|
|
14797
|
+
"description": "Timestamp when the environment was last updated"
|
|
14798
|
+
}
|
|
14799
|
+
},
|
|
14800
|
+
"required": [
|
|
14801
|
+
"id",
|
|
14802
|
+
"slug",
|
|
14803
|
+
"type",
|
|
14804
|
+
"createdAt",
|
|
14805
|
+
"updatedAt"
|
|
14806
|
+
],
|
|
14807
|
+
"type": "object",
|
|
14808
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
13993
14809
|
},
|
|
13994
14810
|
{
|
|
13995
14811
|
"properties": {
|
|
@@ -14426,7 +15242,7 @@
|
|
|
14426
15242
|
"type": {
|
|
14427
15243
|
"type": "string",
|
|
14428
15244
|
"enum": [
|
|
14429
|
-
"github"
|
|
15245
|
+
"github-custom-host"
|
|
14430
15246
|
]
|
|
14431
15247
|
},
|
|
14432
15248
|
"host": {
|
|
@@ -22726,6 +23542,9 @@
|
|
|
22726
23542
|
}
|
|
22727
23543
|
}
|
|
22728
23544
|
}
|
|
23545
|
+
},
|
|
23546
|
+
"422": {
|
|
23547
|
+
"description": ""
|
|
22729
23548
|
}
|
|
22730
23549
|
},
|
|
22731
23550
|
"parameters": [
|
|
@@ -26495,7 +27314,161 @@
|
|
|
26495
27314
|
},
|
|
26496
27315
|
"customEnvironments": {
|
|
26497
27316
|
"items": {
|
|
26498
|
-
"
|
|
27317
|
+
"properties": {
|
|
27318
|
+
"id": {
|
|
27319
|
+
"type": "string",
|
|
27320
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
27321
|
+
},
|
|
27322
|
+
"slug": {
|
|
27323
|
+
"type": "string",
|
|
27324
|
+
"description": "URL-friendly name of the environment"
|
|
27325
|
+
},
|
|
27326
|
+
"type": {
|
|
27327
|
+
"type": "string",
|
|
27328
|
+
"enum": [
|
|
27329
|
+
"production",
|
|
27330
|
+
"preview",
|
|
27331
|
+
"development"
|
|
27332
|
+
],
|
|
27333
|
+
"description": "The type of environment (production, preview, or development)"
|
|
27334
|
+
},
|
|
27335
|
+
"description": {
|
|
27336
|
+
"type": "string",
|
|
27337
|
+
"description": "Optional description of the environment's purpose"
|
|
27338
|
+
},
|
|
27339
|
+
"branchMatcher": {
|
|
27340
|
+
"properties": {
|
|
27341
|
+
"type": {
|
|
27342
|
+
"type": "string",
|
|
27343
|
+
"enum": [
|
|
27344
|
+
"endsWith",
|
|
27345
|
+
"startsWith",
|
|
27346
|
+
"equals"
|
|
27347
|
+
],
|
|
27348
|
+
"description": "The type of matching to perform"
|
|
27349
|
+
},
|
|
27350
|
+
"pattern": {
|
|
27351
|
+
"type": "string",
|
|
27352
|
+
"description": "The pattern to match against branch names"
|
|
27353
|
+
}
|
|
27354
|
+
},
|
|
27355
|
+
"required": [
|
|
27356
|
+
"type",
|
|
27357
|
+
"pattern"
|
|
27358
|
+
],
|
|
27359
|
+
"type": "object",
|
|
27360
|
+
"description": "Configuration for matching git branches to this environment"
|
|
27361
|
+
},
|
|
27362
|
+
"domains": {
|
|
27363
|
+
"items": {
|
|
27364
|
+
"properties": {
|
|
27365
|
+
"name": {
|
|
27366
|
+
"type": "string"
|
|
27367
|
+
},
|
|
27368
|
+
"apexName": {
|
|
27369
|
+
"type": "string"
|
|
27370
|
+
},
|
|
27371
|
+
"projectId": {
|
|
27372
|
+
"type": "string"
|
|
27373
|
+
},
|
|
27374
|
+
"redirect": {
|
|
27375
|
+
"nullable": true,
|
|
27376
|
+
"type": "string"
|
|
27377
|
+
},
|
|
27378
|
+
"redirectStatusCode": {
|
|
27379
|
+
"nullable": true,
|
|
27380
|
+
"type": "number",
|
|
27381
|
+
"enum": [
|
|
27382
|
+
307,
|
|
27383
|
+
301,
|
|
27384
|
+
302,
|
|
27385
|
+
308
|
|
27386
|
+
]
|
|
27387
|
+
},
|
|
27388
|
+
"gitBranch": {
|
|
27389
|
+
"nullable": true,
|
|
27390
|
+
"type": "string"
|
|
27391
|
+
},
|
|
27392
|
+
"customEnvironmentId": {
|
|
27393
|
+
"nullable": true,
|
|
27394
|
+
"type": "string"
|
|
27395
|
+
},
|
|
27396
|
+
"updatedAt": {
|
|
27397
|
+
"type": "number"
|
|
27398
|
+
},
|
|
27399
|
+
"createdAt": {
|
|
27400
|
+
"type": "number"
|
|
27401
|
+
},
|
|
27402
|
+
"verified": {
|
|
27403
|
+
"type": "boolean",
|
|
27404
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
27405
|
+
},
|
|
27406
|
+
"verification": {
|
|
27407
|
+
"items": {
|
|
27408
|
+
"properties": {
|
|
27409
|
+
"type": {
|
|
27410
|
+
"type": "string"
|
|
27411
|
+
},
|
|
27412
|
+
"domain": {
|
|
27413
|
+
"type": "string"
|
|
27414
|
+
},
|
|
27415
|
+
"value": {
|
|
27416
|
+
"type": "string"
|
|
27417
|
+
},
|
|
27418
|
+
"reason": {
|
|
27419
|
+
"type": "string"
|
|
27420
|
+
}
|
|
27421
|
+
},
|
|
27422
|
+
"required": [
|
|
27423
|
+
"type",
|
|
27424
|
+
"domain",
|
|
27425
|
+
"value",
|
|
27426
|
+
"reason"
|
|
27427
|
+
],
|
|
27428
|
+
"type": "object",
|
|
27429
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
27430
|
+
},
|
|
27431
|
+
"type": "array",
|
|
27432
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
27433
|
+
}
|
|
27434
|
+
},
|
|
27435
|
+
"required": [
|
|
27436
|
+
"name",
|
|
27437
|
+
"apexName",
|
|
27438
|
+
"projectId",
|
|
27439
|
+
"verified"
|
|
27440
|
+
],
|
|
27441
|
+
"type": "object",
|
|
27442
|
+
"description": "List of domains associated with this environment"
|
|
27443
|
+
},
|
|
27444
|
+
"type": "array",
|
|
27445
|
+
"description": "List of domains associated with this environment"
|
|
27446
|
+
},
|
|
27447
|
+
"currentDeploymentAliases": {
|
|
27448
|
+
"items": {
|
|
27449
|
+
"type": "string"
|
|
27450
|
+
},
|
|
27451
|
+
"type": "array",
|
|
27452
|
+
"description": "List of aliases for the current deployment"
|
|
27453
|
+
},
|
|
27454
|
+
"createdAt": {
|
|
27455
|
+
"type": "number",
|
|
27456
|
+
"description": "Timestamp when the environment was created"
|
|
27457
|
+
},
|
|
27458
|
+
"updatedAt": {
|
|
27459
|
+
"type": "number",
|
|
27460
|
+
"description": "Timestamp when the environment was last updated"
|
|
27461
|
+
}
|
|
27462
|
+
},
|
|
27463
|
+
"required": [
|
|
27464
|
+
"id",
|
|
27465
|
+
"slug",
|
|
27466
|
+
"type",
|
|
27467
|
+
"createdAt",
|
|
27468
|
+
"updatedAt"
|
|
27469
|
+
],
|
|
27470
|
+
"type": "object",
|
|
27471
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
26499
27472
|
},
|
|
26500
27473
|
"type": "array"
|
|
26501
27474
|
},
|
|
@@ -27371,6 +28344,10 @@
|
|
|
27371
28344
|
"requireApproval": {
|
|
27372
28345
|
"type": "boolean",
|
|
27373
28346
|
"description": "Whether or not this stage requires approval to proceed."
|
|
28347
|
+
},
|
|
28348
|
+
"duration": {
|
|
28349
|
+
"type": "number",
|
|
28350
|
+
"description": "duration is the total time to serve a stage, at the given targetPercentage."
|
|
27374
28351
|
}
|
|
27375
28352
|
},
|
|
27376
28353
|
"required": [
|
|
@@ -27460,8 +28437,8 @@
|
|
|
27460
28437
|
"deploymentType": {
|
|
27461
28438
|
"type": "string",
|
|
27462
28439
|
"enum": [
|
|
27463
|
-
"all",
|
|
27464
28440
|
"preview",
|
|
28441
|
+
"all",
|
|
27465
28442
|
"prod_deployment_urls_and_all_previews"
|
|
27466
28443
|
]
|
|
27467
28444
|
}
|
|
@@ -28983,6 +29960,10 @@
|
|
|
28983
29960
|
"toDeploymentId": {
|
|
28984
29961
|
"type": "string"
|
|
28985
29962
|
},
|
|
29963
|
+
"fromRollingReleaseId": {
|
|
29964
|
+
"type": "string",
|
|
29965
|
+
"description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
|
|
29966
|
+
},
|
|
28986
29967
|
"jobStatus": {
|
|
28987
29968
|
"type": "string",
|
|
28988
29969
|
"enum": [
|
|
@@ -29049,10 +30030,10 @@
|
|
|
29049
30030
|
"deploymentType": {
|
|
29050
30031
|
"type": "string",
|
|
29051
30032
|
"enum": [
|
|
29052
|
-
"
|
|
30033
|
+
"production",
|
|
29053
30034
|
"preview",
|
|
29054
|
-
"
|
|
29055
|
-
"
|
|
30035
|
+
"all",
|
|
30036
|
+
"prod_deployment_urls_and_all_previews"
|
|
29056
30037
|
]
|
|
29057
30038
|
},
|
|
29058
30039
|
"addresses": {
|
|
@@ -29092,10 +30073,10 @@
|
|
|
29092
30073
|
"deploymentType": {
|
|
29093
30074
|
"type": "string",
|
|
29094
30075
|
"enum": [
|
|
29095
|
-
"
|
|
30076
|
+
"production",
|
|
29096
30077
|
"preview",
|
|
29097
|
-
"
|
|
29098
|
-
"
|
|
30078
|
+
"all",
|
|
30079
|
+
"prod_deployment_urls_and_all_previews"
|
|
29099
30080
|
]
|
|
29100
30081
|
}
|
|
29101
30082
|
},
|
|
@@ -30363,7 +31344,161 @@
|
|
|
30363
31344
|
},
|
|
30364
31345
|
"customEnvironments": {
|
|
30365
31346
|
"items": {
|
|
30366
|
-
"
|
|
31347
|
+
"properties": {
|
|
31348
|
+
"id": {
|
|
31349
|
+
"type": "string",
|
|
31350
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
31351
|
+
},
|
|
31352
|
+
"slug": {
|
|
31353
|
+
"type": "string",
|
|
31354
|
+
"description": "URL-friendly name of the environment"
|
|
31355
|
+
},
|
|
31356
|
+
"type": {
|
|
31357
|
+
"type": "string",
|
|
31358
|
+
"enum": [
|
|
31359
|
+
"production",
|
|
31360
|
+
"preview",
|
|
31361
|
+
"development"
|
|
31362
|
+
],
|
|
31363
|
+
"description": "The type of environment (production, preview, or development)"
|
|
31364
|
+
},
|
|
31365
|
+
"description": {
|
|
31366
|
+
"type": "string",
|
|
31367
|
+
"description": "Optional description of the environment's purpose"
|
|
31368
|
+
},
|
|
31369
|
+
"branchMatcher": {
|
|
31370
|
+
"properties": {
|
|
31371
|
+
"type": {
|
|
31372
|
+
"type": "string",
|
|
31373
|
+
"enum": [
|
|
31374
|
+
"endsWith",
|
|
31375
|
+
"startsWith",
|
|
31376
|
+
"equals"
|
|
31377
|
+
],
|
|
31378
|
+
"description": "The type of matching to perform"
|
|
31379
|
+
},
|
|
31380
|
+
"pattern": {
|
|
31381
|
+
"type": "string",
|
|
31382
|
+
"description": "The pattern to match against branch names"
|
|
31383
|
+
}
|
|
31384
|
+
},
|
|
31385
|
+
"required": [
|
|
31386
|
+
"type",
|
|
31387
|
+
"pattern"
|
|
31388
|
+
],
|
|
31389
|
+
"type": "object",
|
|
31390
|
+
"description": "Configuration for matching git branches to this environment"
|
|
31391
|
+
},
|
|
31392
|
+
"domains": {
|
|
31393
|
+
"items": {
|
|
31394
|
+
"properties": {
|
|
31395
|
+
"name": {
|
|
31396
|
+
"type": "string"
|
|
31397
|
+
},
|
|
31398
|
+
"apexName": {
|
|
31399
|
+
"type": "string"
|
|
31400
|
+
},
|
|
31401
|
+
"projectId": {
|
|
31402
|
+
"type": "string"
|
|
31403
|
+
},
|
|
31404
|
+
"redirect": {
|
|
31405
|
+
"nullable": true,
|
|
31406
|
+
"type": "string"
|
|
31407
|
+
},
|
|
31408
|
+
"redirectStatusCode": {
|
|
31409
|
+
"nullable": true,
|
|
31410
|
+
"type": "number",
|
|
31411
|
+
"enum": [
|
|
31412
|
+
307,
|
|
31413
|
+
301,
|
|
31414
|
+
302,
|
|
31415
|
+
308
|
|
31416
|
+
]
|
|
31417
|
+
},
|
|
31418
|
+
"gitBranch": {
|
|
31419
|
+
"nullable": true,
|
|
31420
|
+
"type": "string"
|
|
31421
|
+
},
|
|
31422
|
+
"customEnvironmentId": {
|
|
31423
|
+
"nullable": true,
|
|
31424
|
+
"type": "string"
|
|
31425
|
+
},
|
|
31426
|
+
"updatedAt": {
|
|
31427
|
+
"type": "number"
|
|
31428
|
+
},
|
|
31429
|
+
"createdAt": {
|
|
31430
|
+
"type": "number"
|
|
31431
|
+
},
|
|
31432
|
+
"verified": {
|
|
31433
|
+
"type": "boolean",
|
|
31434
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
31435
|
+
},
|
|
31436
|
+
"verification": {
|
|
31437
|
+
"items": {
|
|
31438
|
+
"properties": {
|
|
31439
|
+
"type": {
|
|
31440
|
+
"type": "string"
|
|
31441
|
+
},
|
|
31442
|
+
"domain": {
|
|
31443
|
+
"type": "string"
|
|
31444
|
+
},
|
|
31445
|
+
"value": {
|
|
31446
|
+
"type": "string"
|
|
31447
|
+
},
|
|
31448
|
+
"reason": {
|
|
31449
|
+
"type": "string"
|
|
31450
|
+
}
|
|
31451
|
+
},
|
|
31452
|
+
"required": [
|
|
31453
|
+
"type",
|
|
31454
|
+
"domain",
|
|
31455
|
+
"value",
|
|
31456
|
+
"reason"
|
|
31457
|
+
],
|
|
31458
|
+
"type": "object",
|
|
31459
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
31460
|
+
},
|
|
31461
|
+
"type": "array",
|
|
31462
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
31463
|
+
}
|
|
31464
|
+
},
|
|
31465
|
+
"required": [
|
|
31466
|
+
"name",
|
|
31467
|
+
"apexName",
|
|
31468
|
+
"projectId",
|
|
31469
|
+
"verified"
|
|
31470
|
+
],
|
|
31471
|
+
"type": "object",
|
|
31472
|
+
"description": "List of domains associated with this environment"
|
|
31473
|
+
},
|
|
31474
|
+
"type": "array",
|
|
31475
|
+
"description": "List of domains associated with this environment"
|
|
31476
|
+
},
|
|
31477
|
+
"currentDeploymentAliases": {
|
|
31478
|
+
"items": {
|
|
31479
|
+
"type": "string"
|
|
31480
|
+
},
|
|
31481
|
+
"type": "array",
|
|
31482
|
+
"description": "List of aliases for the current deployment"
|
|
31483
|
+
},
|
|
31484
|
+
"createdAt": {
|
|
31485
|
+
"type": "number",
|
|
31486
|
+
"description": "Timestamp when the environment was created"
|
|
31487
|
+
},
|
|
31488
|
+
"updatedAt": {
|
|
31489
|
+
"type": "number",
|
|
31490
|
+
"description": "Timestamp when the environment was last updated"
|
|
31491
|
+
}
|
|
31492
|
+
},
|
|
31493
|
+
"required": [
|
|
31494
|
+
"id",
|
|
31495
|
+
"slug",
|
|
31496
|
+
"type",
|
|
31497
|
+
"createdAt",
|
|
31498
|
+
"updatedAt"
|
|
31499
|
+
],
|
|
31500
|
+
"type": "object",
|
|
31501
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
30367
31502
|
},
|
|
30368
31503
|
"type": "array"
|
|
30369
31504
|
},
|
|
@@ -31239,6 +32374,10 @@
|
|
|
31239
32374
|
"requireApproval": {
|
|
31240
32375
|
"type": "boolean",
|
|
31241
32376
|
"description": "Whether or not this stage requires approval to proceed."
|
|
32377
|
+
},
|
|
32378
|
+
"duration": {
|
|
32379
|
+
"type": "number",
|
|
32380
|
+
"description": "duration is the total time to serve a stage, at the given targetPercentage."
|
|
31242
32381
|
}
|
|
31243
32382
|
},
|
|
31244
32383
|
"required": [
|
|
@@ -31328,8 +32467,8 @@
|
|
|
31328
32467
|
"deploymentType": {
|
|
31329
32468
|
"type": "string",
|
|
31330
32469
|
"enum": [
|
|
31331
|
-
"all",
|
|
31332
32470
|
"preview",
|
|
32471
|
+
"all",
|
|
31333
32472
|
"prod_deployment_urls_and_all_previews"
|
|
31334
32473
|
]
|
|
31335
32474
|
}
|
|
@@ -32851,6 +33990,10 @@
|
|
|
32851
33990
|
"toDeploymentId": {
|
|
32852
33991
|
"type": "string"
|
|
32853
33992
|
},
|
|
33993
|
+
"fromRollingReleaseId": {
|
|
33994
|
+
"type": "string",
|
|
33995
|
+
"description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
|
|
33996
|
+
},
|
|
32854
33997
|
"jobStatus": {
|
|
32855
33998
|
"type": "string",
|
|
32856
33999
|
"enum": [
|
|
@@ -32917,10 +34060,10 @@
|
|
|
32917
34060
|
"deploymentType": {
|
|
32918
34061
|
"type": "string",
|
|
32919
34062
|
"enum": [
|
|
32920
|
-
"
|
|
34063
|
+
"production",
|
|
32921
34064
|
"preview",
|
|
32922
|
-
"
|
|
32923
|
-
"
|
|
34065
|
+
"all",
|
|
34066
|
+
"prod_deployment_urls_and_all_previews"
|
|
32924
34067
|
]
|
|
32925
34068
|
},
|
|
32926
34069
|
"addresses": {
|
|
@@ -32960,10 +34103,10 @@
|
|
|
32960
34103
|
"deploymentType": {
|
|
32961
34104
|
"type": "string",
|
|
32962
34105
|
"enum": [
|
|
32963
|
-
"
|
|
34106
|
+
"production",
|
|
32964
34107
|
"preview",
|
|
32965
|
-
"
|
|
32966
|
-
"
|
|
34108
|
+
"all",
|
|
34109
|
+
"prod_deployment_urls_and_all_previews"
|
|
32967
34110
|
]
|
|
32968
34111
|
}
|
|
32969
34112
|
},
|
|
@@ -33488,6 +34631,16 @@
|
|
|
33488
34631
|
"schema": {
|
|
33489
34632
|
"additionalProperties": false,
|
|
33490
34633
|
"properties": {
|
|
34634
|
+
"enablePreviewFeedback": {
|
|
34635
|
+
"description": "Opt-in to preview toolbar on the project level",
|
|
34636
|
+
"type": "boolean",
|
|
34637
|
+
"nullable": true
|
|
34638
|
+
},
|
|
34639
|
+
"enableProductionFeedback": {
|
|
34640
|
+
"description": "Opt-in to production toolbar on the project level",
|
|
34641
|
+
"type": "boolean",
|
|
34642
|
+
"nullable": true
|
|
34643
|
+
},
|
|
33491
34644
|
"buildCommand": {
|
|
33492
34645
|
"description": "The build command for this project. When `null` is used this value will be automatically detected",
|
|
33493
34646
|
"maxLength": 256,
|
|
@@ -34358,7 +35511,161 @@
|
|
|
34358
35511
|
},
|
|
34359
35512
|
"customEnvironments": {
|
|
34360
35513
|
"items": {
|
|
34361
|
-
"
|
|
35514
|
+
"properties": {
|
|
35515
|
+
"id": {
|
|
35516
|
+
"type": "string",
|
|
35517
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
35518
|
+
},
|
|
35519
|
+
"slug": {
|
|
35520
|
+
"type": "string",
|
|
35521
|
+
"description": "URL-friendly name of the environment"
|
|
35522
|
+
},
|
|
35523
|
+
"type": {
|
|
35524
|
+
"type": "string",
|
|
35525
|
+
"enum": [
|
|
35526
|
+
"production",
|
|
35527
|
+
"preview",
|
|
35528
|
+
"development"
|
|
35529
|
+
],
|
|
35530
|
+
"description": "The type of environment (production, preview, or development)"
|
|
35531
|
+
},
|
|
35532
|
+
"description": {
|
|
35533
|
+
"type": "string",
|
|
35534
|
+
"description": "Optional description of the environment's purpose"
|
|
35535
|
+
},
|
|
35536
|
+
"branchMatcher": {
|
|
35537
|
+
"properties": {
|
|
35538
|
+
"type": {
|
|
35539
|
+
"type": "string",
|
|
35540
|
+
"enum": [
|
|
35541
|
+
"endsWith",
|
|
35542
|
+
"startsWith",
|
|
35543
|
+
"equals"
|
|
35544
|
+
],
|
|
35545
|
+
"description": "The type of matching to perform"
|
|
35546
|
+
},
|
|
35547
|
+
"pattern": {
|
|
35548
|
+
"type": "string",
|
|
35549
|
+
"description": "The pattern to match against branch names"
|
|
35550
|
+
}
|
|
35551
|
+
},
|
|
35552
|
+
"required": [
|
|
35553
|
+
"type",
|
|
35554
|
+
"pattern"
|
|
35555
|
+
],
|
|
35556
|
+
"type": "object",
|
|
35557
|
+
"description": "Configuration for matching git branches to this environment"
|
|
35558
|
+
},
|
|
35559
|
+
"domains": {
|
|
35560
|
+
"items": {
|
|
35561
|
+
"properties": {
|
|
35562
|
+
"name": {
|
|
35563
|
+
"type": "string"
|
|
35564
|
+
},
|
|
35565
|
+
"apexName": {
|
|
35566
|
+
"type": "string"
|
|
35567
|
+
},
|
|
35568
|
+
"projectId": {
|
|
35569
|
+
"type": "string"
|
|
35570
|
+
},
|
|
35571
|
+
"redirect": {
|
|
35572
|
+
"nullable": true,
|
|
35573
|
+
"type": "string"
|
|
35574
|
+
},
|
|
35575
|
+
"redirectStatusCode": {
|
|
35576
|
+
"nullable": true,
|
|
35577
|
+
"type": "number",
|
|
35578
|
+
"enum": [
|
|
35579
|
+
307,
|
|
35580
|
+
301,
|
|
35581
|
+
302,
|
|
35582
|
+
308
|
|
35583
|
+
]
|
|
35584
|
+
},
|
|
35585
|
+
"gitBranch": {
|
|
35586
|
+
"nullable": true,
|
|
35587
|
+
"type": "string"
|
|
35588
|
+
},
|
|
35589
|
+
"customEnvironmentId": {
|
|
35590
|
+
"nullable": true,
|
|
35591
|
+
"type": "string"
|
|
35592
|
+
},
|
|
35593
|
+
"updatedAt": {
|
|
35594
|
+
"type": "number"
|
|
35595
|
+
},
|
|
35596
|
+
"createdAt": {
|
|
35597
|
+
"type": "number"
|
|
35598
|
+
},
|
|
35599
|
+
"verified": {
|
|
35600
|
+
"type": "boolean",
|
|
35601
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
35602
|
+
},
|
|
35603
|
+
"verification": {
|
|
35604
|
+
"items": {
|
|
35605
|
+
"properties": {
|
|
35606
|
+
"type": {
|
|
35607
|
+
"type": "string"
|
|
35608
|
+
},
|
|
35609
|
+
"domain": {
|
|
35610
|
+
"type": "string"
|
|
35611
|
+
},
|
|
35612
|
+
"value": {
|
|
35613
|
+
"type": "string"
|
|
35614
|
+
},
|
|
35615
|
+
"reason": {
|
|
35616
|
+
"type": "string"
|
|
35617
|
+
}
|
|
35618
|
+
},
|
|
35619
|
+
"required": [
|
|
35620
|
+
"type",
|
|
35621
|
+
"domain",
|
|
35622
|
+
"value",
|
|
35623
|
+
"reason"
|
|
35624
|
+
],
|
|
35625
|
+
"type": "object",
|
|
35626
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
35627
|
+
},
|
|
35628
|
+
"type": "array",
|
|
35629
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
35630
|
+
}
|
|
35631
|
+
},
|
|
35632
|
+
"required": [
|
|
35633
|
+
"name",
|
|
35634
|
+
"apexName",
|
|
35635
|
+
"projectId",
|
|
35636
|
+
"verified"
|
|
35637
|
+
],
|
|
35638
|
+
"type": "object",
|
|
35639
|
+
"description": "List of domains associated with this environment"
|
|
35640
|
+
},
|
|
35641
|
+
"type": "array",
|
|
35642
|
+
"description": "List of domains associated with this environment"
|
|
35643
|
+
},
|
|
35644
|
+
"currentDeploymentAliases": {
|
|
35645
|
+
"items": {
|
|
35646
|
+
"type": "string"
|
|
35647
|
+
},
|
|
35648
|
+
"type": "array",
|
|
35649
|
+
"description": "List of aliases for the current deployment"
|
|
35650
|
+
},
|
|
35651
|
+
"createdAt": {
|
|
35652
|
+
"type": "number",
|
|
35653
|
+
"description": "Timestamp when the environment was created"
|
|
35654
|
+
},
|
|
35655
|
+
"updatedAt": {
|
|
35656
|
+
"type": "number",
|
|
35657
|
+
"description": "Timestamp when the environment was last updated"
|
|
35658
|
+
}
|
|
35659
|
+
},
|
|
35660
|
+
"required": [
|
|
35661
|
+
"id",
|
|
35662
|
+
"slug",
|
|
35663
|
+
"type",
|
|
35664
|
+
"createdAt",
|
|
35665
|
+
"updatedAt"
|
|
35666
|
+
],
|
|
35667
|
+
"type": "object",
|
|
35668
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
34362
35669
|
},
|
|
34363
35670
|
"type": "array"
|
|
34364
35671
|
},
|
|
@@ -35234,6 +36541,10 @@
|
|
|
35234
36541
|
"requireApproval": {
|
|
35235
36542
|
"type": "boolean",
|
|
35236
36543
|
"description": "Whether or not this stage requires approval to proceed."
|
|
36544
|
+
},
|
|
36545
|
+
"duration": {
|
|
36546
|
+
"type": "number",
|
|
36547
|
+
"description": "duration is the total time to serve a stage, at the given targetPercentage."
|
|
35237
36548
|
}
|
|
35238
36549
|
},
|
|
35239
36550
|
"required": [
|
|
@@ -35323,8 +36634,8 @@
|
|
|
35323
36634
|
"deploymentType": {
|
|
35324
36635
|
"type": "string",
|
|
35325
36636
|
"enum": [
|
|
35326
|
-
"all",
|
|
35327
36637
|
"preview",
|
|
36638
|
+
"all",
|
|
35328
36639
|
"prod_deployment_urls_and_all_previews"
|
|
35329
36640
|
]
|
|
35330
36641
|
}
|
|
@@ -36846,6 +38157,10 @@
|
|
|
36846
38157
|
"toDeploymentId": {
|
|
36847
38158
|
"type": "string"
|
|
36848
38159
|
},
|
|
38160
|
+
"fromRollingReleaseId": {
|
|
38161
|
+
"type": "string",
|
|
38162
|
+
"description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
|
|
38163
|
+
},
|
|
36849
38164
|
"jobStatus": {
|
|
36850
38165
|
"type": "string",
|
|
36851
38166
|
"enum": [
|
|
@@ -36912,10 +38227,10 @@
|
|
|
36912
38227
|
"deploymentType": {
|
|
36913
38228
|
"type": "string",
|
|
36914
38229
|
"enum": [
|
|
36915
|
-
"
|
|
38230
|
+
"production",
|
|
36916
38231
|
"preview",
|
|
36917
|
-
"
|
|
36918
|
-
"
|
|
38232
|
+
"all",
|
|
38233
|
+
"prod_deployment_urls_and_all_previews"
|
|
36919
38234
|
]
|
|
36920
38235
|
},
|
|
36921
38236
|
"addresses": {
|
|
@@ -36955,10 +38270,10 @@
|
|
|
36955
38270
|
"deploymentType": {
|
|
36956
38271
|
"type": "string",
|
|
36957
38272
|
"enum": [
|
|
36958
|
-
"
|
|
38273
|
+
"production",
|
|
36959
38274
|
"preview",
|
|
36960
|
-
"
|
|
36961
|
-
"
|
|
38275
|
+
"all",
|
|
38276
|
+
"prod_deployment_urls_and_all_previews"
|
|
36962
38277
|
]
|
|
36963
38278
|
}
|
|
36964
38279
|
},
|
|
@@ -38116,7 +39431,161 @@
|
|
|
38116
39431
|
},
|
|
38117
39432
|
"customEnvironments": {
|
|
38118
39433
|
"items": {
|
|
38119
|
-
"
|
|
39434
|
+
"properties": {
|
|
39435
|
+
"id": {
|
|
39436
|
+
"type": "string",
|
|
39437
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
39438
|
+
},
|
|
39439
|
+
"slug": {
|
|
39440
|
+
"type": "string",
|
|
39441
|
+
"description": "URL-friendly name of the environment"
|
|
39442
|
+
},
|
|
39443
|
+
"type": {
|
|
39444
|
+
"type": "string",
|
|
39445
|
+
"enum": [
|
|
39446
|
+
"production",
|
|
39447
|
+
"preview",
|
|
39448
|
+
"development"
|
|
39449
|
+
],
|
|
39450
|
+
"description": "The type of environment (production, preview, or development)"
|
|
39451
|
+
},
|
|
39452
|
+
"description": {
|
|
39453
|
+
"type": "string",
|
|
39454
|
+
"description": "Optional description of the environment's purpose"
|
|
39455
|
+
},
|
|
39456
|
+
"branchMatcher": {
|
|
39457
|
+
"properties": {
|
|
39458
|
+
"type": {
|
|
39459
|
+
"type": "string",
|
|
39460
|
+
"enum": [
|
|
39461
|
+
"endsWith",
|
|
39462
|
+
"startsWith",
|
|
39463
|
+
"equals"
|
|
39464
|
+
],
|
|
39465
|
+
"description": "The type of matching to perform"
|
|
39466
|
+
},
|
|
39467
|
+
"pattern": {
|
|
39468
|
+
"type": "string",
|
|
39469
|
+
"description": "The pattern to match against branch names"
|
|
39470
|
+
}
|
|
39471
|
+
},
|
|
39472
|
+
"required": [
|
|
39473
|
+
"type",
|
|
39474
|
+
"pattern"
|
|
39475
|
+
],
|
|
39476
|
+
"type": "object",
|
|
39477
|
+
"description": "Configuration for matching git branches to this environment"
|
|
39478
|
+
},
|
|
39479
|
+
"domains": {
|
|
39480
|
+
"items": {
|
|
39481
|
+
"properties": {
|
|
39482
|
+
"name": {
|
|
39483
|
+
"type": "string"
|
|
39484
|
+
},
|
|
39485
|
+
"apexName": {
|
|
39486
|
+
"type": "string"
|
|
39487
|
+
},
|
|
39488
|
+
"projectId": {
|
|
39489
|
+
"type": "string"
|
|
39490
|
+
},
|
|
39491
|
+
"redirect": {
|
|
39492
|
+
"nullable": true,
|
|
39493
|
+
"type": "string"
|
|
39494
|
+
},
|
|
39495
|
+
"redirectStatusCode": {
|
|
39496
|
+
"nullable": true,
|
|
39497
|
+
"type": "number",
|
|
39498
|
+
"enum": [
|
|
39499
|
+
307,
|
|
39500
|
+
301,
|
|
39501
|
+
302,
|
|
39502
|
+
308
|
|
39503
|
+
]
|
|
39504
|
+
},
|
|
39505
|
+
"gitBranch": {
|
|
39506
|
+
"nullable": true,
|
|
39507
|
+
"type": "string"
|
|
39508
|
+
},
|
|
39509
|
+
"customEnvironmentId": {
|
|
39510
|
+
"nullable": true,
|
|
39511
|
+
"type": "string"
|
|
39512
|
+
},
|
|
39513
|
+
"updatedAt": {
|
|
39514
|
+
"type": "number"
|
|
39515
|
+
},
|
|
39516
|
+
"createdAt": {
|
|
39517
|
+
"type": "number"
|
|
39518
|
+
},
|
|
39519
|
+
"verified": {
|
|
39520
|
+
"type": "boolean",
|
|
39521
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
39522
|
+
},
|
|
39523
|
+
"verification": {
|
|
39524
|
+
"items": {
|
|
39525
|
+
"properties": {
|
|
39526
|
+
"type": {
|
|
39527
|
+
"type": "string"
|
|
39528
|
+
},
|
|
39529
|
+
"domain": {
|
|
39530
|
+
"type": "string"
|
|
39531
|
+
},
|
|
39532
|
+
"value": {
|
|
39533
|
+
"type": "string"
|
|
39534
|
+
},
|
|
39535
|
+
"reason": {
|
|
39536
|
+
"type": "string"
|
|
39537
|
+
}
|
|
39538
|
+
},
|
|
39539
|
+
"required": [
|
|
39540
|
+
"type",
|
|
39541
|
+
"domain",
|
|
39542
|
+
"value",
|
|
39543
|
+
"reason"
|
|
39544
|
+
],
|
|
39545
|
+
"type": "object",
|
|
39546
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
39547
|
+
},
|
|
39548
|
+
"type": "array",
|
|
39549
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
39550
|
+
}
|
|
39551
|
+
},
|
|
39552
|
+
"required": [
|
|
39553
|
+
"name",
|
|
39554
|
+
"apexName",
|
|
39555
|
+
"projectId",
|
|
39556
|
+
"verified"
|
|
39557
|
+
],
|
|
39558
|
+
"type": "object",
|
|
39559
|
+
"description": "List of domains associated with this environment"
|
|
39560
|
+
},
|
|
39561
|
+
"type": "array",
|
|
39562
|
+
"description": "List of domains associated with this environment"
|
|
39563
|
+
},
|
|
39564
|
+
"currentDeploymentAliases": {
|
|
39565
|
+
"items": {
|
|
39566
|
+
"type": "string"
|
|
39567
|
+
},
|
|
39568
|
+
"type": "array",
|
|
39569
|
+
"description": "List of aliases for the current deployment"
|
|
39570
|
+
},
|
|
39571
|
+
"createdAt": {
|
|
39572
|
+
"type": "number",
|
|
39573
|
+
"description": "Timestamp when the environment was created"
|
|
39574
|
+
},
|
|
39575
|
+
"updatedAt": {
|
|
39576
|
+
"type": "number",
|
|
39577
|
+
"description": "Timestamp when the environment was last updated"
|
|
39578
|
+
}
|
|
39579
|
+
},
|
|
39580
|
+
"required": [
|
|
39581
|
+
"id",
|
|
39582
|
+
"slug",
|
|
39583
|
+
"type",
|
|
39584
|
+
"createdAt",
|
|
39585
|
+
"updatedAt"
|
|
39586
|
+
],
|
|
39587
|
+
"type": "object",
|
|
39588
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
38120
39589
|
},
|
|
38121
39590
|
"type": "array"
|
|
38122
39591
|
},
|
|
@@ -38992,6 +40461,10 @@
|
|
|
38992
40461
|
"requireApproval": {
|
|
38993
40462
|
"type": "boolean",
|
|
38994
40463
|
"description": "Whether or not this stage requires approval to proceed."
|
|
40464
|
+
},
|
|
40465
|
+
"duration": {
|
|
40466
|
+
"type": "number",
|
|
40467
|
+
"description": "duration is the total time to serve a stage, at the given targetPercentage."
|
|
38995
40468
|
}
|
|
38996
40469
|
},
|
|
38997
40470
|
"required": [
|
|
@@ -39081,8 +40554,8 @@
|
|
|
39081
40554
|
"deploymentType": {
|
|
39082
40555
|
"type": "string",
|
|
39083
40556
|
"enum": [
|
|
39084
|
-
"all",
|
|
39085
40557
|
"preview",
|
|
40558
|
+
"all",
|
|
39086
40559
|
"prod_deployment_urls_and_all_previews"
|
|
39087
40560
|
]
|
|
39088
40561
|
}
|
|
@@ -40604,6 +42077,10 @@
|
|
|
40604
42077
|
"toDeploymentId": {
|
|
40605
42078
|
"type": "string"
|
|
40606
42079
|
},
|
|
42080
|
+
"fromRollingReleaseId": {
|
|
42081
|
+
"type": "string",
|
|
42082
|
+
"description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
|
|
42083
|
+
},
|
|
40607
42084
|
"jobStatus": {
|
|
40608
42085
|
"type": "string",
|
|
40609
42086
|
"enum": [
|
|
@@ -40670,10 +42147,10 @@
|
|
|
40670
42147
|
"deploymentType": {
|
|
40671
42148
|
"type": "string",
|
|
40672
42149
|
"enum": [
|
|
40673
|
-
"
|
|
42150
|
+
"production",
|
|
40674
42151
|
"preview",
|
|
40675
|
-
"
|
|
40676
|
-
"
|
|
42152
|
+
"all",
|
|
42153
|
+
"prod_deployment_urls_and_all_previews"
|
|
40677
42154
|
]
|
|
40678
42155
|
},
|
|
40679
42156
|
"addresses": {
|
|
@@ -40713,10 +42190,10 @@
|
|
|
40713
42190
|
"deploymentType": {
|
|
40714
42191
|
"type": "string",
|
|
40715
42192
|
"enum": [
|
|
40716
|
-
"
|
|
42193
|
+
"production",
|
|
40717
42194
|
"preview",
|
|
40718
|
-
"
|
|
40719
|
-
"
|
|
42195
|
+
"all",
|
|
42196
|
+
"prod_deployment_urls_and_all_previews"
|
|
40720
42197
|
]
|
|
40721
42198
|
}
|
|
40722
42199
|
},
|
|
@@ -41712,7 +43189,161 @@
|
|
|
41712
43189
|
"content": {
|
|
41713
43190
|
"application/json": {
|
|
41714
43191
|
"schema": {
|
|
41715
|
-
"
|
|
43192
|
+
"properties": {
|
|
43193
|
+
"id": {
|
|
43194
|
+
"type": "string",
|
|
43195
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
43196
|
+
},
|
|
43197
|
+
"slug": {
|
|
43198
|
+
"type": "string",
|
|
43199
|
+
"description": "URL-friendly name of the environment"
|
|
43200
|
+
},
|
|
43201
|
+
"type": {
|
|
43202
|
+
"type": "string",
|
|
43203
|
+
"enum": [
|
|
43204
|
+
"production",
|
|
43205
|
+
"preview",
|
|
43206
|
+
"development"
|
|
43207
|
+
],
|
|
43208
|
+
"description": "The type of environment (production, preview, or development)"
|
|
43209
|
+
},
|
|
43210
|
+
"description": {
|
|
43211
|
+
"type": "string",
|
|
43212
|
+
"description": "Optional description of the environment's purpose"
|
|
43213
|
+
},
|
|
43214
|
+
"branchMatcher": {
|
|
43215
|
+
"properties": {
|
|
43216
|
+
"type": {
|
|
43217
|
+
"type": "string",
|
|
43218
|
+
"enum": [
|
|
43219
|
+
"endsWith",
|
|
43220
|
+
"startsWith",
|
|
43221
|
+
"equals"
|
|
43222
|
+
],
|
|
43223
|
+
"description": "The type of matching to perform"
|
|
43224
|
+
},
|
|
43225
|
+
"pattern": {
|
|
43226
|
+
"type": "string",
|
|
43227
|
+
"description": "The pattern to match against branch names"
|
|
43228
|
+
}
|
|
43229
|
+
},
|
|
43230
|
+
"required": [
|
|
43231
|
+
"type",
|
|
43232
|
+
"pattern"
|
|
43233
|
+
],
|
|
43234
|
+
"type": "object",
|
|
43235
|
+
"description": "Configuration for matching git branches to this environment"
|
|
43236
|
+
},
|
|
43237
|
+
"domains": {
|
|
43238
|
+
"items": {
|
|
43239
|
+
"properties": {
|
|
43240
|
+
"name": {
|
|
43241
|
+
"type": "string"
|
|
43242
|
+
},
|
|
43243
|
+
"apexName": {
|
|
43244
|
+
"type": "string"
|
|
43245
|
+
},
|
|
43246
|
+
"projectId": {
|
|
43247
|
+
"type": "string"
|
|
43248
|
+
},
|
|
43249
|
+
"redirect": {
|
|
43250
|
+
"nullable": true,
|
|
43251
|
+
"type": "string"
|
|
43252
|
+
},
|
|
43253
|
+
"redirectStatusCode": {
|
|
43254
|
+
"nullable": true,
|
|
43255
|
+
"type": "number",
|
|
43256
|
+
"enum": [
|
|
43257
|
+
307,
|
|
43258
|
+
301,
|
|
43259
|
+
302,
|
|
43260
|
+
308
|
|
43261
|
+
]
|
|
43262
|
+
},
|
|
43263
|
+
"gitBranch": {
|
|
43264
|
+
"nullable": true,
|
|
43265
|
+
"type": "string"
|
|
43266
|
+
},
|
|
43267
|
+
"customEnvironmentId": {
|
|
43268
|
+
"nullable": true,
|
|
43269
|
+
"type": "string"
|
|
43270
|
+
},
|
|
43271
|
+
"updatedAt": {
|
|
43272
|
+
"type": "number"
|
|
43273
|
+
},
|
|
43274
|
+
"createdAt": {
|
|
43275
|
+
"type": "number"
|
|
43276
|
+
},
|
|
43277
|
+
"verified": {
|
|
43278
|
+
"type": "boolean",
|
|
43279
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
43280
|
+
},
|
|
43281
|
+
"verification": {
|
|
43282
|
+
"items": {
|
|
43283
|
+
"properties": {
|
|
43284
|
+
"type": {
|
|
43285
|
+
"type": "string"
|
|
43286
|
+
},
|
|
43287
|
+
"domain": {
|
|
43288
|
+
"type": "string"
|
|
43289
|
+
},
|
|
43290
|
+
"value": {
|
|
43291
|
+
"type": "string"
|
|
43292
|
+
},
|
|
43293
|
+
"reason": {
|
|
43294
|
+
"type": "string"
|
|
43295
|
+
}
|
|
43296
|
+
},
|
|
43297
|
+
"required": [
|
|
43298
|
+
"type",
|
|
43299
|
+
"domain",
|
|
43300
|
+
"value",
|
|
43301
|
+
"reason"
|
|
43302
|
+
],
|
|
43303
|
+
"type": "object",
|
|
43304
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
43305
|
+
},
|
|
43306
|
+
"type": "array",
|
|
43307
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
43308
|
+
}
|
|
43309
|
+
},
|
|
43310
|
+
"required": [
|
|
43311
|
+
"name",
|
|
43312
|
+
"apexName",
|
|
43313
|
+
"projectId",
|
|
43314
|
+
"verified"
|
|
43315
|
+
],
|
|
43316
|
+
"type": "object",
|
|
43317
|
+
"description": "List of domains associated with this environment"
|
|
43318
|
+
},
|
|
43319
|
+
"type": "array",
|
|
43320
|
+
"description": "List of domains associated with this environment"
|
|
43321
|
+
},
|
|
43322
|
+
"currentDeploymentAliases": {
|
|
43323
|
+
"items": {
|
|
43324
|
+
"type": "string"
|
|
43325
|
+
},
|
|
43326
|
+
"type": "array",
|
|
43327
|
+
"description": "List of aliases for the current deployment"
|
|
43328
|
+
},
|
|
43329
|
+
"createdAt": {
|
|
43330
|
+
"type": "number",
|
|
43331
|
+
"description": "Timestamp when the environment was created"
|
|
43332
|
+
},
|
|
43333
|
+
"updatedAt": {
|
|
43334
|
+
"type": "number",
|
|
43335
|
+
"description": "Timestamp when the environment was last updated"
|
|
43336
|
+
}
|
|
43337
|
+
},
|
|
43338
|
+
"required": [
|
|
43339
|
+
"id",
|
|
43340
|
+
"slug",
|
|
43341
|
+
"type",
|
|
43342
|
+
"createdAt",
|
|
43343
|
+
"updatedAt"
|
|
43344
|
+
],
|
|
43345
|
+
"type": "object",
|
|
43346
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
41716
43347
|
}
|
|
41717
43348
|
}
|
|
41718
43349
|
}
|
|
@@ -41858,6 +43489,159 @@
|
|
|
41858
43489
|
},
|
|
41859
43490
|
"environments": {
|
|
41860
43491
|
"items": {
|
|
43492
|
+
"properties": {
|
|
43493
|
+
"id": {
|
|
43494
|
+
"type": "string",
|
|
43495
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
43496
|
+
},
|
|
43497
|
+
"slug": {
|
|
43498
|
+
"type": "string",
|
|
43499
|
+
"description": "URL-friendly name of the environment"
|
|
43500
|
+
},
|
|
43501
|
+
"type": {
|
|
43502
|
+
"type": "string",
|
|
43503
|
+
"enum": [
|
|
43504
|
+
"production",
|
|
43505
|
+
"preview",
|
|
43506
|
+
"development"
|
|
43507
|
+
],
|
|
43508
|
+
"description": "The type of environment (production, preview, or development)"
|
|
43509
|
+
},
|
|
43510
|
+
"description": {
|
|
43511
|
+
"type": "string",
|
|
43512
|
+
"description": "Optional description of the environment's purpose"
|
|
43513
|
+
},
|
|
43514
|
+
"branchMatcher": {
|
|
43515
|
+
"properties": {
|
|
43516
|
+
"type": {
|
|
43517
|
+
"type": "string",
|
|
43518
|
+
"enum": [
|
|
43519
|
+
"endsWith",
|
|
43520
|
+
"startsWith",
|
|
43521
|
+
"equals"
|
|
43522
|
+
],
|
|
43523
|
+
"description": "The type of matching to perform"
|
|
43524
|
+
},
|
|
43525
|
+
"pattern": {
|
|
43526
|
+
"type": "string",
|
|
43527
|
+
"description": "The pattern to match against branch names"
|
|
43528
|
+
}
|
|
43529
|
+
},
|
|
43530
|
+
"required": [
|
|
43531
|
+
"type",
|
|
43532
|
+
"pattern"
|
|
43533
|
+
],
|
|
43534
|
+
"type": "object",
|
|
43535
|
+
"description": "Configuration for matching git branches to this environment"
|
|
43536
|
+
},
|
|
43537
|
+
"domains": {
|
|
43538
|
+
"items": {
|
|
43539
|
+
"properties": {
|
|
43540
|
+
"name": {
|
|
43541
|
+
"type": "string"
|
|
43542
|
+
},
|
|
43543
|
+
"apexName": {
|
|
43544
|
+
"type": "string"
|
|
43545
|
+
},
|
|
43546
|
+
"projectId": {
|
|
43547
|
+
"type": "string"
|
|
43548
|
+
},
|
|
43549
|
+
"redirect": {
|
|
43550
|
+
"nullable": true,
|
|
43551
|
+
"type": "string"
|
|
43552
|
+
},
|
|
43553
|
+
"redirectStatusCode": {
|
|
43554
|
+
"nullable": true,
|
|
43555
|
+
"type": "number",
|
|
43556
|
+
"enum": [
|
|
43557
|
+
307,
|
|
43558
|
+
301,
|
|
43559
|
+
302,
|
|
43560
|
+
308
|
|
43561
|
+
]
|
|
43562
|
+
},
|
|
43563
|
+
"gitBranch": {
|
|
43564
|
+
"nullable": true,
|
|
43565
|
+
"type": "string"
|
|
43566
|
+
},
|
|
43567
|
+
"customEnvironmentId": {
|
|
43568
|
+
"nullable": true,
|
|
43569
|
+
"type": "string"
|
|
43570
|
+
},
|
|
43571
|
+
"updatedAt": {
|
|
43572
|
+
"type": "number"
|
|
43573
|
+
},
|
|
43574
|
+
"createdAt": {
|
|
43575
|
+
"type": "number"
|
|
43576
|
+
},
|
|
43577
|
+
"verified": {
|
|
43578
|
+
"type": "boolean",
|
|
43579
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
43580
|
+
},
|
|
43581
|
+
"verification": {
|
|
43582
|
+
"items": {
|
|
43583
|
+
"properties": {
|
|
43584
|
+
"type": {
|
|
43585
|
+
"type": "string"
|
|
43586
|
+
},
|
|
43587
|
+
"domain": {
|
|
43588
|
+
"type": "string"
|
|
43589
|
+
},
|
|
43590
|
+
"value": {
|
|
43591
|
+
"type": "string"
|
|
43592
|
+
},
|
|
43593
|
+
"reason": {
|
|
43594
|
+
"type": "string"
|
|
43595
|
+
}
|
|
43596
|
+
},
|
|
43597
|
+
"required": [
|
|
43598
|
+
"type",
|
|
43599
|
+
"domain",
|
|
43600
|
+
"value",
|
|
43601
|
+
"reason"
|
|
43602
|
+
],
|
|
43603
|
+
"type": "object",
|
|
43604
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
43605
|
+
},
|
|
43606
|
+
"type": "array",
|
|
43607
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
43608
|
+
}
|
|
43609
|
+
},
|
|
43610
|
+
"required": [
|
|
43611
|
+
"name",
|
|
43612
|
+
"apexName",
|
|
43613
|
+
"projectId",
|
|
43614
|
+
"verified"
|
|
43615
|
+
],
|
|
43616
|
+
"type": "object",
|
|
43617
|
+
"description": "List of domains associated with this environment"
|
|
43618
|
+
},
|
|
43619
|
+
"type": "array",
|
|
43620
|
+
"description": "List of domains associated with this environment"
|
|
43621
|
+
},
|
|
43622
|
+
"currentDeploymentAliases": {
|
|
43623
|
+
"items": {
|
|
43624
|
+
"type": "string"
|
|
43625
|
+
},
|
|
43626
|
+
"type": "array",
|
|
43627
|
+
"description": "List of aliases for the current deployment"
|
|
43628
|
+
},
|
|
43629
|
+
"createdAt": {
|
|
43630
|
+
"type": "number",
|
|
43631
|
+
"description": "Timestamp when the environment was created"
|
|
43632
|
+
},
|
|
43633
|
+
"updatedAt": {
|
|
43634
|
+
"type": "number",
|
|
43635
|
+
"description": "Timestamp when the environment was last updated"
|
|
43636
|
+
}
|
|
43637
|
+
},
|
|
43638
|
+
"required": [
|
|
43639
|
+
"id",
|
|
43640
|
+
"slug",
|
|
43641
|
+
"type",
|
|
43642
|
+
"createdAt",
|
|
43643
|
+
"updatedAt"
|
|
43644
|
+
],
|
|
41861
43645
|
"type": "object"
|
|
41862
43646
|
},
|
|
41863
43647
|
"type": "array"
|
|
@@ -41957,6 +43741,159 @@
|
|
|
41957
43741
|
"content": {
|
|
41958
43742
|
"application/json": {
|
|
41959
43743
|
"schema": {
|
|
43744
|
+
"properties": {
|
|
43745
|
+
"id": {
|
|
43746
|
+
"type": "string",
|
|
43747
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
43748
|
+
},
|
|
43749
|
+
"slug": {
|
|
43750
|
+
"type": "string",
|
|
43751
|
+
"description": "URL-friendly name of the environment"
|
|
43752
|
+
},
|
|
43753
|
+
"type": {
|
|
43754
|
+
"type": "string",
|
|
43755
|
+
"enum": [
|
|
43756
|
+
"production",
|
|
43757
|
+
"preview",
|
|
43758
|
+
"development"
|
|
43759
|
+
],
|
|
43760
|
+
"description": "The type of environment (production, preview, or development)"
|
|
43761
|
+
},
|
|
43762
|
+
"description": {
|
|
43763
|
+
"type": "string",
|
|
43764
|
+
"description": "Optional description of the environment's purpose"
|
|
43765
|
+
},
|
|
43766
|
+
"branchMatcher": {
|
|
43767
|
+
"properties": {
|
|
43768
|
+
"type": {
|
|
43769
|
+
"type": "string",
|
|
43770
|
+
"enum": [
|
|
43771
|
+
"endsWith",
|
|
43772
|
+
"startsWith",
|
|
43773
|
+
"equals"
|
|
43774
|
+
],
|
|
43775
|
+
"description": "The type of matching to perform"
|
|
43776
|
+
},
|
|
43777
|
+
"pattern": {
|
|
43778
|
+
"type": "string",
|
|
43779
|
+
"description": "The pattern to match against branch names"
|
|
43780
|
+
}
|
|
43781
|
+
},
|
|
43782
|
+
"required": [
|
|
43783
|
+
"type",
|
|
43784
|
+
"pattern"
|
|
43785
|
+
],
|
|
43786
|
+
"type": "object",
|
|
43787
|
+
"description": "Configuration for matching git branches to this environment"
|
|
43788
|
+
},
|
|
43789
|
+
"domains": {
|
|
43790
|
+
"items": {
|
|
43791
|
+
"properties": {
|
|
43792
|
+
"name": {
|
|
43793
|
+
"type": "string"
|
|
43794
|
+
},
|
|
43795
|
+
"apexName": {
|
|
43796
|
+
"type": "string"
|
|
43797
|
+
},
|
|
43798
|
+
"projectId": {
|
|
43799
|
+
"type": "string"
|
|
43800
|
+
},
|
|
43801
|
+
"redirect": {
|
|
43802
|
+
"nullable": true,
|
|
43803
|
+
"type": "string"
|
|
43804
|
+
},
|
|
43805
|
+
"redirectStatusCode": {
|
|
43806
|
+
"nullable": true,
|
|
43807
|
+
"type": "number",
|
|
43808
|
+
"enum": [
|
|
43809
|
+
307,
|
|
43810
|
+
301,
|
|
43811
|
+
302,
|
|
43812
|
+
308
|
|
43813
|
+
]
|
|
43814
|
+
},
|
|
43815
|
+
"gitBranch": {
|
|
43816
|
+
"nullable": true,
|
|
43817
|
+
"type": "string"
|
|
43818
|
+
},
|
|
43819
|
+
"customEnvironmentId": {
|
|
43820
|
+
"nullable": true,
|
|
43821
|
+
"type": "string"
|
|
43822
|
+
},
|
|
43823
|
+
"updatedAt": {
|
|
43824
|
+
"type": "number"
|
|
43825
|
+
},
|
|
43826
|
+
"createdAt": {
|
|
43827
|
+
"type": "number"
|
|
43828
|
+
},
|
|
43829
|
+
"verified": {
|
|
43830
|
+
"type": "boolean",
|
|
43831
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
43832
|
+
},
|
|
43833
|
+
"verification": {
|
|
43834
|
+
"items": {
|
|
43835
|
+
"properties": {
|
|
43836
|
+
"type": {
|
|
43837
|
+
"type": "string"
|
|
43838
|
+
},
|
|
43839
|
+
"domain": {
|
|
43840
|
+
"type": "string"
|
|
43841
|
+
},
|
|
43842
|
+
"value": {
|
|
43843
|
+
"type": "string"
|
|
43844
|
+
},
|
|
43845
|
+
"reason": {
|
|
43846
|
+
"type": "string"
|
|
43847
|
+
}
|
|
43848
|
+
},
|
|
43849
|
+
"required": [
|
|
43850
|
+
"type",
|
|
43851
|
+
"domain",
|
|
43852
|
+
"value",
|
|
43853
|
+
"reason"
|
|
43854
|
+
],
|
|
43855
|
+
"type": "object",
|
|
43856
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
43857
|
+
},
|
|
43858
|
+
"type": "array",
|
|
43859
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
43860
|
+
}
|
|
43861
|
+
},
|
|
43862
|
+
"required": [
|
|
43863
|
+
"name",
|
|
43864
|
+
"apexName",
|
|
43865
|
+
"projectId",
|
|
43866
|
+
"verified"
|
|
43867
|
+
],
|
|
43868
|
+
"type": "object",
|
|
43869
|
+
"description": "List of domains associated with this environment"
|
|
43870
|
+
},
|
|
43871
|
+
"type": "array",
|
|
43872
|
+
"description": "List of domains associated with this environment"
|
|
43873
|
+
},
|
|
43874
|
+
"currentDeploymentAliases": {
|
|
43875
|
+
"items": {
|
|
43876
|
+
"type": "string"
|
|
43877
|
+
},
|
|
43878
|
+
"type": "array",
|
|
43879
|
+
"description": "List of aliases for the current deployment"
|
|
43880
|
+
},
|
|
43881
|
+
"createdAt": {
|
|
43882
|
+
"type": "number",
|
|
43883
|
+
"description": "Timestamp when the environment was created"
|
|
43884
|
+
},
|
|
43885
|
+
"updatedAt": {
|
|
43886
|
+
"type": "number",
|
|
43887
|
+
"description": "Timestamp when the environment was last updated"
|
|
43888
|
+
}
|
|
43889
|
+
},
|
|
43890
|
+
"required": [
|
|
43891
|
+
"id",
|
|
43892
|
+
"slug",
|
|
43893
|
+
"type",
|
|
43894
|
+
"createdAt",
|
|
43895
|
+
"updatedAt"
|
|
43896
|
+
],
|
|
41960
43897
|
"type": "object",
|
|
41961
43898
|
"description": "Internal representation of a custom environment with all required properties"
|
|
41962
43899
|
}
|
|
@@ -42056,7 +43993,161 @@
|
|
|
42056
43993
|
"content": {
|
|
42057
43994
|
"application/json": {
|
|
42058
43995
|
"schema": {
|
|
42059
|
-
"
|
|
43996
|
+
"properties": {
|
|
43997
|
+
"id": {
|
|
43998
|
+
"type": "string",
|
|
43999
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
44000
|
+
},
|
|
44001
|
+
"slug": {
|
|
44002
|
+
"type": "string",
|
|
44003
|
+
"description": "URL-friendly name of the environment"
|
|
44004
|
+
},
|
|
44005
|
+
"type": {
|
|
44006
|
+
"type": "string",
|
|
44007
|
+
"enum": [
|
|
44008
|
+
"production",
|
|
44009
|
+
"preview",
|
|
44010
|
+
"development"
|
|
44011
|
+
],
|
|
44012
|
+
"description": "The type of environment (production, preview, or development)"
|
|
44013
|
+
},
|
|
44014
|
+
"description": {
|
|
44015
|
+
"type": "string",
|
|
44016
|
+
"description": "Optional description of the environment's purpose"
|
|
44017
|
+
},
|
|
44018
|
+
"branchMatcher": {
|
|
44019
|
+
"properties": {
|
|
44020
|
+
"type": {
|
|
44021
|
+
"type": "string",
|
|
44022
|
+
"enum": [
|
|
44023
|
+
"endsWith",
|
|
44024
|
+
"startsWith",
|
|
44025
|
+
"equals"
|
|
44026
|
+
],
|
|
44027
|
+
"description": "The type of matching to perform"
|
|
44028
|
+
},
|
|
44029
|
+
"pattern": {
|
|
44030
|
+
"type": "string",
|
|
44031
|
+
"description": "The pattern to match against branch names"
|
|
44032
|
+
}
|
|
44033
|
+
},
|
|
44034
|
+
"required": [
|
|
44035
|
+
"type",
|
|
44036
|
+
"pattern"
|
|
44037
|
+
],
|
|
44038
|
+
"type": "object",
|
|
44039
|
+
"description": "Configuration for matching git branches to this environment"
|
|
44040
|
+
},
|
|
44041
|
+
"domains": {
|
|
44042
|
+
"items": {
|
|
44043
|
+
"properties": {
|
|
44044
|
+
"name": {
|
|
44045
|
+
"type": "string"
|
|
44046
|
+
},
|
|
44047
|
+
"apexName": {
|
|
44048
|
+
"type": "string"
|
|
44049
|
+
},
|
|
44050
|
+
"projectId": {
|
|
44051
|
+
"type": "string"
|
|
44052
|
+
},
|
|
44053
|
+
"redirect": {
|
|
44054
|
+
"nullable": true,
|
|
44055
|
+
"type": "string"
|
|
44056
|
+
},
|
|
44057
|
+
"redirectStatusCode": {
|
|
44058
|
+
"nullable": true,
|
|
44059
|
+
"type": "number",
|
|
44060
|
+
"enum": [
|
|
44061
|
+
307,
|
|
44062
|
+
301,
|
|
44063
|
+
302,
|
|
44064
|
+
308
|
|
44065
|
+
]
|
|
44066
|
+
},
|
|
44067
|
+
"gitBranch": {
|
|
44068
|
+
"nullable": true,
|
|
44069
|
+
"type": "string"
|
|
44070
|
+
},
|
|
44071
|
+
"customEnvironmentId": {
|
|
44072
|
+
"nullable": true,
|
|
44073
|
+
"type": "string"
|
|
44074
|
+
},
|
|
44075
|
+
"updatedAt": {
|
|
44076
|
+
"type": "number"
|
|
44077
|
+
},
|
|
44078
|
+
"createdAt": {
|
|
44079
|
+
"type": "number"
|
|
44080
|
+
},
|
|
44081
|
+
"verified": {
|
|
44082
|
+
"type": "boolean",
|
|
44083
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
44084
|
+
},
|
|
44085
|
+
"verification": {
|
|
44086
|
+
"items": {
|
|
44087
|
+
"properties": {
|
|
44088
|
+
"type": {
|
|
44089
|
+
"type": "string"
|
|
44090
|
+
},
|
|
44091
|
+
"domain": {
|
|
44092
|
+
"type": "string"
|
|
44093
|
+
},
|
|
44094
|
+
"value": {
|
|
44095
|
+
"type": "string"
|
|
44096
|
+
},
|
|
44097
|
+
"reason": {
|
|
44098
|
+
"type": "string"
|
|
44099
|
+
}
|
|
44100
|
+
},
|
|
44101
|
+
"required": [
|
|
44102
|
+
"type",
|
|
44103
|
+
"domain",
|
|
44104
|
+
"value",
|
|
44105
|
+
"reason"
|
|
44106
|
+
],
|
|
44107
|
+
"type": "object",
|
|
44108
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
44109
|
+
},
|
|
44110
|
+
"type": "array",
|
|
44111
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
44112
|
+
}
|
|
44113
|
+
},
|
|
44114
|
+
"required": [
|
|
44115
|
+
"name",
|
|
44116
|
+
"apexName",
|
|
44117
|
+
"projectId",
|
|
44118
|
+
"verified"
|
|
44119
|
+
],
|
|
44120
|
+
"type": "object",
|
|
44121
|
+
"description": "List of domains associated with this environment"
|
|
44122
|
+
},
|
|
44123
|
+
"type": "array",
|
|
44124
|
+
"description": "List of domains associated with this environment"
|
|
44125
|
+
},
|
|
44126
|
+
"currentDeploymentAliases": {
|
|
44127
|
+
"items": {
|
|
44128
|
+
"type": "string"
|
|
44129
|
+
},
|
|
44130
|
+
"type": "array",
|
|
44131
|
+
"description": "List of aliases for the current deployment"
|
|
44132
|
+
},
|
|
44133
|
+
"createdAt": {
|
|
44134
|
+
"type": "number",
|
|
44135
|
+
"description": "Timestamp when the environment was created"
|
|
44136
|
+
},
|
|
44137
|
+
"updatedAt": {
|
|
44138
|
+
"type": "number",
|
|
44139
|
+
"description": "Timestamp when the environment was last updated"
|
|
44140
|
+
}
|
|
44141
|
+
},
|
|
44142
|
+
"required": [
|
|
44143
|
+
"id",
|
|
44144
|
+
"slug",
|
|
44145
|
+
"type",
|
|
44146
|
+
"createdAt",
|
|
44147
|
+
"updatedAt"
|
|
44148
|
+
],
|
|
44149
|
+
"type": "object",
|
|
44150
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
42060
44151
|
}
|
|
42061
44152
|
}
|
|
42062
44153
|
}
|
|
@@ -42195,7 +44286,161 @@
|
|
|
42195
44286
|
"content": {
|
|
42196
44287
|
"application/json": {
|
|
42197
44288
|
"schema": {
|
|
42198
|
-
"
|
|
44289
|
+
"properties": {
|
|
44290
|
+
"id": {
|
|
44291
|
+
"type": "string",
|
|
44292
|
+
"description": "Unique identifier for the custom environment (format: env_*)"
|
|
44293
|
+
},
|
|
44294
|
+
"slug": {
|
|
44295
|
+
"type": "string",
|
|
44296
|
+
"description": "URL-friendly name of the environment"
|
|
44297
|
+
},
|
|
44298
|
+
"type": {
|
|
44299
|
+
"type": "string",
|
|
44300
|
+
"enum": [
|
|
44301
|
+
"production",
|
|
44302
|
+
"preview",
|
|
44303
|
+
"development"
|
|
44304
|
+
],
|
|
44305
|
+
"description": "The type of environment (production, preview, or development)"
|
|
44306
|
+
},
|
|
44307
|
+
"description": {
|
|
44308
|
+
"type": "string",
|
|
44309
|
+
"description": "Optional description of the environment's purpose"
|
|
44310
|
+
},
|
|
44311
|
+
"branchMatcher": {
|
|
44312
|
+
"properties": {
|
|
44313
|
+
"type": {
|
|
44314
|
+
"type": "string",
|
|
44315
|
+
"enum": [
|
|
44316
|
+
"endsWith",
|
|
44317
|
+
"startsWith",
|
|
44318
|
+
"equals"
|
|
44319
|
+
],
|
|
44320
|
+
"description": "The type of matching to perform"
|
|
44321
|
+
},
|
|
44322
|
+
"pattern": {
|
|
44323
|
+
"type": "string",
|
|
44324
|
+
"description": "The pattern to match against branch names"
|
|
44325
|
+
}
|
|
44326
|
+
},
|
|
44327
|
+
"required": [
|
|
44328
|
+
"type",
|
|
44329
|
+
"pattern"
|
|
44330
|
+
],
|
|
44331
|
+
"type": "object",
|
|
44332
|
+
"description": "Configuration for matching git branches to this environment"
|
|
44333
|
+
},
|
|
44334
|
+
"domains": {
|
|
44335
|
+
"items": {
|
|
44336
|
+
"properties": {
|
|
44337
|
+
"name": {
|
|
44338
|
+
"type": "string"
|
|
44339
|
+
},
|
|
44340
|
+
"apexName": {
|
|
44341
|
+
"type": "string"
|
|
44342
|
+
},
|
|
44343
|
+
"projectId": {
|
|
44344
|
+
"type": "string"
|
|
44345
|
+
},
|
|
44346
|
+
"redirect": {
|
|
44347
|
+
"nullable": true,
|
|
44348
|
+
"type": "string"
|
|
44349
|
+
},
|
|
44350
|
+
"redirectStatusCode": {
|
|
44351
|
+
"nullable": true,
|
|
44352
|
+
"type": "number",
|
|
44353
|
+
"enum": [
|
|
44354
|
+
307,
|
|
44355
|
+
301,
|
|
44356
|
+
302,
|
|
44357
|
+
308
|
|
44358
|
+
]
|
|
44359
|
+
},
|
|
44360
|
+
"gitBranch": {
|
|
44361
|
+
"nullable": true,
|
|
44362
|
+
"type": "string"
|
|
44363
|
+
},
|
|
44364
|
+
"customEnvironmentId": {
|
|
44365
|
+
"nullable": true,
|
|
44366
|
+
"type": "string"
|
|
44367
|
+
},
|
|
44368
|
+
"updatedAt": {
|
|
44369
|
+
"type": "number"
|
|
44370
|
+
},
|
|
44371
|
+
"createdAt": {
|
|
44372
|
+
"type": "number"
|
|
44373
|
+
},
|
|
44374
|
+
"verified": {
|
|
44375
|
+
"type": "boolean",
|
|
44376
|
+
"description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
|
|
44377
|
+
},
|
|
44378
|
+
"verification": {
|
|
44379
|
+
"items": {
|
|
44380
|
+
"properties": {
|
|
44381
|
+
"type": {
|
|
44382
|
+
"type": "string"
|
|
44383
|
+
},
|
|
44384
|
+
"domain": {
|
|
44385
|
+
"type": "string"
|
|
44386
|
+
},
|
|
44387
|
+
"value": {
|
|
44388
|
+
"type": "string"
|
|
44389
|
+
},
|
|
44390
|
+
"reason": {
|
|
44391
|
+
"type": "string"
|
|
44392
|
+
}
|
|
44393
|
+
},
|
|
44394
|
+
"required": [
|
|
44395
|
+
"type",
|
|
44396
|
+
"domain",
|
|
44397
|
+
"value",
|
|
44398
|
+
"reason"
|
|
44399
|
+
],
|
|
44400
|
+
"type": "object",
|
|
44401
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
44402
|
+
},
|
|
44403
|
+
"type": "array",
|
|
44404
|
+
"description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
|
|
44405
|
+
}
|
|
44406
|
+
},
|
|
44407
|
+
"required": [
|
|
44408
|
+
"name",
|
|
44409
|
+
"apexName",
|
|
44410
|
+
"projectId",
|
|
44411
|
+
"verified"
|
|
44412
|
+
],
|
|
44413
|
+
"type": "object",
|
|
44414
|
+
"description": "List of domains associated with this environment"
|
|
44415
|
+
},
|
|
44416
|
+
"type": "array",
|
|
44417
|
+
"description": "List of domains associated with this environment"
|
|
44418
|
+
},
|
|
44419
|
+
"currentDeploymentAliases": {
|
|
44420
|
+
"items": {
|
|
44421
|
+
"type": "string"
|
|
44422
|
+
},
|
|
44423
|
+
"type": "array",
|
|
44424
|
+
"description": "List of aliases for the current deployment"
|
|
44425
|
+
},
|
|
44426
|
+
"createdAt": {
|
|
44427
|
+
"type": "number",
|
|
44428
|
+
"description": "Timestamp when the environment was created"
|
|
44429
|
+
},
|
|
44430
|
+
"updatedAt": {
|
|
44431
|
+
"type": "number",
|
|
44432
|
+
"description": "Timestamp when the environment was last updated"
|
|
44433
|
+
}
|
|
44434
|
+
},
|
|
44435
|
+
"required": [
|
|
44436
|
+
"id",
|
|
44437
|
+
"slug",
|
|
44438
|
+
"type",
|
|
44439
|
+
"createdAt",
|
|
44440
|
+
"updatedAt"
|
|
44441
|
+
],
|
|
44442
|
+
"type": "object",
|
|
44443
|
+
"description": "Internal representation of a custom environment with all required properties"
|
|
42199
44444
|
}
|
|
42200
44445
|
}
|
|
42201
44446
|
}
|
|
@@ -43407,7 +45652,7 @@
|
|
|
43407
45652
|
"bearerToken": []
|
|
43408
45653
|
}
|
|
43409
45654
|
],
|
|
43410
|
-
"summary": "
|
|
45655
|
+
"summary": "Move a project domain",
|
|
43411
45656
|
"tags": [
|
|
43412
45657
|
"projects"
|
|
43413
45658
|
],
|
|
@@ -59408,59 +61653,165 @@
|
|
|
59408
61653
|
},
|
|
59409
61654
|
"parameters": [
|
|
59410
61655
|
{
|
|
59411
|
-
"name": "from",
|
|
59412
|
-
"description": "Get the alias only if it was created after the provided timestamp",
|
|
59413
|
-
"in": "query",
|
|
59414
|
-
"required": false,
|
|
59415
|
-
"schema": {
|
|
59416
|
-
"deprecated": true,
|
|
59417
|
-
"description": "Get the alias only if it was created after the provided timestamp",
|
|
59418
|
-
"example": 1540095775951,
|
|
59419
|
-
"type": "number"
|
|
59420
|
-
}
|
|
59421
|
-
},
|
|
59422
|
-
{
|
|
59423
|
-
"name": "idOrAlias",
|
|
59424
|
-
"description": "The alias or alias ID to be retrieved",
|
|
61656
|
+
"name": "from",
|
|
61657
|
+
"description": "Get the alias only if it was created after the provided timestamp",
|
|
61658
|
+
"in": "query",
|
|
61659
|
+
"required": false,
|
|
61660
|
+
"schema": {
|
|
61661
|
+
"deprecated": true,
|
|
61662
|
+
"description": "Get the alias only if it was created after the provided timestamp",
|
|
61663
|
+
"example": 1540095775951,
|
|
61664
|
+
"type": "number"
|
|
61665
|
+
}
|
|
61666
|
+
},
|
|
61667
|
+
{
|
|
61668
|
+
"name": "idOrAlias",
|
|
61669
|
+
"description": "The alias or alias ID to be retrieved",
|
|
61670
|
+
"in": "path",
|
|
61671
|
+
"required": true,
|
|
61672
|
+
"schema": {
|
|
61673
|
+
"description": "The alias or alias ID to be retrieved",
|
|
61674
|
+
"example": "example.vercel.app",
|
|
61675
|
+
"type": "string"
|
|
61676
|
+
}
|
|
61677
|
+
},
|
|
61678
|
+
{
|
|
61679
|
+
"name": "projectId",
|
|
61680
|
+
"description": "Get the alias only if it is assigned to the provided project ID",
|
|
61681
|
+
"in": "query",
|
|
61682
|
+
"required": false,
|
|
61683
|
+
"schema": {
|
|
61684
|
+
"description": "Get the alias only if it is assigned to the provided project ID",
|
|
61685
|
+
"example": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
|
|
61686
|
+
"type": "string"
|
|
61687
|
+
}
|
|
61688
|
+
},
|
|
61689
|
+
{
|
|
61690
|
+
"name": "since",
|
|
61691
|
+
"description": "Get the alias only if it was created after this JavaScript timestamp",
|
|
61692
|
+
"in": "query",
|
|
61693
|
+
"required": false,
|
|
61694
|
+
"schema": {
|
|
61695
|
+
"description": "Get the alias only if it was created after this JavaScript timestamp",
|
|
61696
|
+
"example": 1540095775941,
|
|
61697
|
+
"type": "number"
|
|
61698
|
+
}
|
|
61699
|
+
},
|
|
61700
|
+
{
|
|
61701
|
+
"name": "until",
|
|
61702
|
+
"description": "Get the alias only if it was created before this JavaScript timestamp",
|
|
61703
|
+
"in": "query",
|
|
61704
|
+
"required": false,
|
|
61705
|
+
"schema": {
|
|
61706
|
+
"description": "Get the alias only if it was created before this JavaScript timestamp",
|
|
61707
|
+
"example": 1540095775951,
|
|
61708
|
+
"type": "number"
|
|
61709
|
+
}
|
|
61710
|
+
},
|
|
61711
|
+
{
|
|
61712
|
+
"description": "The Team identifier to perform the request on behalf of.",
|
|
61713
|
+
"in": "query",
|
|
61714
|
+
"name": "teamId",
|
|
61715
|
+
"schema": {
|
|
61716
|
+
"type": "string",
|
|
61717
|
+
"example": "team_1a2b3c4d5e6f7g8h9i0j1k2l"
|
|
61718
|
+
}
|
|
61719
|
+
},
|
|
61720
|
+
{
|
|
61721
|
+
"description": "The Team slug to perform the request on behalf of.",
|
|
61722
|
+
"in": "query",
|
|
61723
|
+
"name": "slug",
|
|
61724
|
+
"schema": {
|
|
61725
|
+
"type": "string",
|
|
61726
|
+
"example": "my-team-url-slug"
|
|
61727
|
+
}
|
|
61728
|
+
}
|
|
61729
|
+
]
|
|
61730
|
+
}
|
|
61731
|
+
},
|
|
61732
|
+
"/v2/aliases/{aliasId}": {
|
|
61733
|
+
"delete": {
|
|
61734
|
+
"description": "Delete an Alias with the specified ID.",
|
|
61735
|
+
"operationId": "deleteAlias",
|
|
61736
|
+
"security": [
|
|
61737
|
+
{
|
|
61738
|
+
"bearerToken": []
|
|
61739
|
+
}
|
|
61740
|
+
],
|
|
61741
|
+
"summary": "Delete an Alias",
|
|
61742
|
+
"tags": [
|
|
61743
|
+
"aliases"
|
|
61744
|
+
],
|
|
61745
|
+
"responses": {
|
|
61746
|
+
"200": {
|
|
61747
|
+
"description": "The alias was successfully removed",
|
|
61748
|
+
"content": {
|
|
61749
|
+
"application/json": {
|
|
61750
|
+
"schema": {
|
|
61751
|
+
"properties": {
|
|
61752
|
+
"status": {
|
|
61753
|
+
"type": "string",
|
|
61754
|
+
"enum": [
|
|
61755
|
+
"SUCCESS"
|
|
61756
|
+
]
|
|
61757
|
+
}
|
|
61758
|
+
},
|
|
61759
|
+
"required": [
|
|
61760
|
+
"status"
|
|
61761
|
+
],
|
|
61762
|
+
"type": "object"
|
|
61763
|
+
}
|
|
61764
|
+
}
|
|
61765
|
+
}
|
|
61766
|
+
},
|
|
61767
|
+
"400": {
|
|
61768
|
+
"description": "One of the provided values in the request query is invalid.",
|
|
61769
|
+
"content": {
|
|
61770
|
+
"application/json": {
|
|
61771
|
+
"schema": {
|
|
61772
|
+
"$ref": "#/components/schemas/VercelBadRequestError"
|
|
61773
|
+
}
|
|
61774
|
+
}
|
|
61775
|
+
}
|
|
61776
|
+
},
|
|
61777
|
+
"401": {
|
|
61778
|
+
"description": "",
|
|
61779
|
+
"content": {
|
|
61780
|
+
"application/json": {
|
|
61781
|
+
"schema": {
|
|
61782
|
+
"$ref": "#/components/schemas/VercelForbiddenError"
|
|
61783
|
+
}
|
|
61784
|
+
}
|
|
61785
|
+
}
|
|
61786
|
+
},
|
|
61787
|
+
"403": {
|
|
61788
|
+
"description": "You do not have permission to access this resource."
|
|
61789
|
+
},
|
|
61790
|
+
"404": {
|
|
61791
|
+
"description": "The alias was not found",
|
|
61792
|
+
"content": {
|
|
61793
|
+
"application/json": {
|
|
61794
|
+
"schema": {
|
|
61795
|
+
"$ref": "#/components/schemas/VercelNotFoundError"
|
|
61796
|
+
}
|
|
61797
|
+
}
|
|
61798
|
+
}
|
|
61799
|
+
}
|
|
61800
|
+
},
|
|
61801
|
+
"parameters": [
|
|
61802
|
+
{
|
|
61803
|
+
"name": "aliasId",
|
|
61804
|
+
"description": "The ID or alias that will be removed",
|
|
59425
61805
|
"in": "path",
|
|
59426
61806
|
"required": true,
|
|
59427
61807
|
"schema": {
|
|
59428
|
-
"
|
|
59429
|
-
"
|
|
59430
|
-
"
|
|
59431
|
-
|
|
59432
|
-
|
|
59433
|
-
|
|
59434
|
-
|
|
59435
|
-
"description": "Get the alias only if it is assigned to the provided project ID",
|
|
59436
|
-
"in": "query",
|
|
59437
|
-
"required": false,
|
|
59438
|
-
"schema": {
|
|
59439
|
-
"description": "Get the alias only if it is assigned to the provided project ID",
|
|
59440
|
-
"example": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
|
|
59441
|
-
"type": "string"
|
|
59442
|
-
}
|
|
59443
|
-
},
|
|
59444
|
-
{
|
|
59445
|
-
"name": "since",
|
|
59446
|
-
"description": "Get the alias only if it was created after this JavaScript timestamp",
|
|
59447
|
-
"in": "query",
|
|
59448
|
-
"required": false,
|
|
59449
|
-
"schema": {
|
|
59450
|
-
"description": "Get the alias only if it was created after this JavaScript timestamp",
|
|
59451
|
-
"example": 1540095775941,
|
|
59452
|
-
"type": "number"
|
|
59453
|
-
}
|
|
59454
|
-
},
|
|
59455
|
-
{
|
|
59456
|
-
"name": "until",
|
|
59457
|
-
"description": "Get the alias only if it was created before this JavaScript timestamp",
|
|
59458
|
-
"in": "query",
|
|
59459
|
-
"required": false,
|
|
59460
|
-
"schema": {
|
|
59461
|
-
"description": "Get the alias only if it was created before this JavaScript timestamp",
|
|
59462
|
-
"example": 1540095775951,
|
|
59463
|
-
"type": "number"
|
|
61808
|
+
"example": "2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
61809
|
+
"description": "The ID or alias that will be removed",
|
|
61810
|
+
"oneOf": [
|
|
61811
|
+
{
|
|
61812
|
+
"type": "string"
|
|
61813
|
+
}
|
|
61814
|
+
]
|
|
59464
61815
|
}
|
|
59465
61816
|
},
|
|
59466
61817
|
{
|
|
@@ -59484,43 +61835,25 @@
|
|
|
59484
61835
|
]
|
|
59485
61836
|
}
|
|
59486
61837
|
},
|
|
59487
|
-
"/
|
|
59488
|
-
"
|
|
59489
|
-
"description": "
|
|
59490
|
-
"
|
|
59491
|
-
"
|
|
59492
|
-
{
|
|
59493
|
-
"bearerToken": []
|
|
59494
|
-
}
|
|
59495
|
-
],
|
|
59496
|
-
"summary": "Delete an Alias",
|
|
59497
|
-
"tags": [
|
|
59498
|
-
"aliases"
|
|
59499
|
-
],
|
|
61838
|
+
"/aliases/{id}/protection-bypass": {
|
|
61839
|
+
"patch": {
|
|
61840
|
+
"description": "Update the protection bypass for the alias (used for user access \u0026 comment access for deployments). Used as shareable links and user scoped access for Vercel Authentication and also to allow external (logged in) people to comment on previews for Preview Comments (next-live-mode).",
|
|
61841
|
+
"security": [],
|
|
61842
|
+
"tags": [],
|
|
59500
61843
|
"responses": {
|
|
59501
61844
|
"200": {
|
|
59502
|
-
"description": "
|
|
61845
|
+
"description": "",
|
|
59503
61846
|
"content": {
|
|
59504
61847
|
"application/json": {
|
|
59505
61848
|
"schema": {
|
|
59506
|
-
"
|
|
59507
|
-
"status": {
|
|
59508
|
-
"type": "string",
|
|
59509
|
-
"enum": [
|
|
59510
|
-
"SUCCESS"
|
|
59511
|
-
]
|
|
59512
|
-
}
|
|
59513
|
-
},
|
|
59514
|
-
"required": [
|
|
59515
|
-
"status"
|
|
59516
|
-
],
|
|
61849
|
+
"additionalProperties": true,
|
|
59517
61850
|
"type": "object"
|
|
59518
61851
|
}
|
|
59519
61852
|
}
|
|
59520
61853
|
}
|
|
59521
61854
|
},
|
|
59522
61855
|
"400": {
|
|
59523
|
-
"description": "One of the provided values in the request query is invalid.",
|
|
61856
|
+
"description": "One of the provided values in the request body is invalid.\nOne of the provided values in the request query is invalid.",
|
|
59524
61857
|
"content": {
|
|
59525
61858
|
"application/json": {
|
|
59526
61859
|
"schema": {
|
|
@@ -59543,7 +61876,7 @@
|
|
|
59543
61876
|
"description": "You do not have permission to access this resource."
|
|
59544
61877
|
},
|
|
59545
61878
|
"404": {
|
|
59546
|
-
"description": "
|
|
61879
|
+
"description": "",
|
|
59547
61880
|
"content": {
|
|
59548
61881
|
"application/json": {
|
|
59549
61882
|
"schema": {
|
|
@@ -59551,43 +61884,144 @@
|
|
|
59551
61884
|
}
|
|
59552
61885
|
}
|
|
59553
61886
|
}
|
|
61887
|
+
},
|
|
61888
|
+
"409": {
|
|
61889
|
+
"description": ""
|
|
61890
|
+
},
|
|
61891
|
+
"428": {
|
|
61892
|
+
"description": ""
|
|
61893
|
+
},
|
|
61894
|
+
"500": {
|
|
61895
|
+
"description": ""
|
|
59554
61896
|
}
|
|
59555
61897
|
},
|
|
59556
61898
|
"parameters": [
|
|
59557
61899
|
{
|
|
59558
|
-
"name": "
|
|
59559
|
-
"description": "The
|
|
61900
|
+
"name": "id",
|
|
61901
|
+
"description": "The alias or deployment ID",
|
|
59560
61902
|
"in": "path",
|
|
59561
61903
|
"required": true,
|
|
59562
|
-
"schema": {
|
|
59563
|
-
"example": "2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
59564
|
-
"description": "The ID or alias that will be removed",
|
|
59565
|
-
"oneOf": [
|
|
59566
|
-
{
|
|
59567
|
-
"type": "string"
|
|
59568
|
-
}
|
|
59569
|
-
]
|
|
59570
|
-
}
|
|
59571
|
-
},
|
|
59572
|
-
{
|
|
59573
|
-
"description": "The Team identifier to perform the request on behalf of.",
|
|
59574
|
-
"in": "query",
|
|
59575
|
-
"name": "teamId",
|
|
59576
61904
|
"schema": {
|
|
59577
61905
|
"type": "string",
|
|
59578
|
-
"
|
|
61906
|
+
"description": "The alias or deployment ID"
|
|
59579
61907
|
}
|
|
59580
|
-
}
|
|
59581
|
-
|
|
59582
|
-
|
|
59583
|
-
|
|
59584
|
-
"
|
|
59585
|
-
|
|
59586
|
-
|
|
59587
|
-
|
|
61908
|
+
}
|
|
61909
|
+
],
|
|
61910
|
+
"requestBody": {
|
|
61911
|
+
"content": {
|
|
61912
|
+
"application/json": {
|
|
61913
|
+
"schema": {
|
|
61914
|
+
"oneOf": [
|
|
61915
|
+
{
|
|
61916
|
+
"type": "object",
|
|
61917
|
+
"properties": {
|
|
61918
|
+
"revoke": {
|
|
61919
|
+
"description": "Optional instructions for revoking and regenerating a shareable link",
|
|
61920
|
+
"type": "object",
|
|
61921
|
+
"properties": {
|
|
61922
|
+
"secret": {
|
|
61923
|
+
"description": "Sharebale link to revoked",
|
|
61924
|
+
"type": "string"
|
|
61925
|
+
},
|
|
61926
|
+
"regenerate": {
|
|
61927
|
+
"description": "Whether or not a new shareable link should be created after the provided secret is revoked",
|
|
61928
|
+
"type": "boolean"
|
|
61929
|
+
}
|
|
61930
|
+
},
|
|
61931
|
+
"required": [
|
|
61932
|
+
"secret",
|
|
61933
|
+
"regenerate"
|
|
61934
|
+
]
|
|
61935
|
+
}
|
|
61936
|
+
},
|
|
61937
|
+
"additionalProperties": false
|
|
61938
|
+
},
|
|
61939
|
+
{
|
|
61940
|
+
"type": "object",
|
|
61941
|
+
"properties": {
|
|
61942
|
+
"scope": {
|
|
61943
|
+
"description": "Instructions for creating a user scoped protection bypass",
|
|
61944
|
+
"type": "object",
|
|
61945
|
+
"properties": {
|
|
61946
|
+
"userId": {
|
|
61947
|
+
"type": "string",
|
|
61948
|
+
"description": "Specified user id for the scoped bypass."
|
|
61949
|
+
},
|
|
61950
|
+
"email": {
|
|
61951
|
+
"type": "string",
|
|
61952
|
+
"format": "email",
|
|
61953
|
+
"description": "Specified email for the scoped bypass."
|
|
61954
|
+
},
|
|
61955
|
+
"access": {
|
|
61956
|
+
"enum": [
|
|
61957
|
+
"denied",
|
|
61958
|
+
"granted"
|
|
61959
|
+
],
|
|
61960
|
+
"description": "Invitation status for the user scoped bypass."
|
|
61961
|
+
}
|
|
61962
|
+
},
|
|
61963
|
+
"allOf": [
|
|
61964
|
+
{
|
|
61965
|
+
"anyOf": [
|
|
61966
|
+
{
|
|
61967
|
+
"required": [
|
|
61968
|
+
"userId"
|
|
61969
|
+
]
|
|
61970
|
+
},
|
|
61971
|
+
{
|
|
61972
|
+
"required": [
|
|
61973
|
+
"email"
|
|
61974
|
+
]
|
|
61975
|
+
}
|
|
61976
|
+
]
|
|
61977
|
+
},
|
|
61978
|
+
{
|
|
61979
|
+
"required": [
|
|
61980
|
+
"access"
|
|
61981
|
+
]
|
|
61982
|
+
}
|
|
61983
|
+
]
|
|
61984
|
+
}
|
|
61985
|
+
},
|
|
61986
|
+
"required": [
|
|
61987
|
+
"scope"
|
|
61988
|
+
],
|
|
61989
|
+
"additionalProperties": false
|
|
61990
|
+
},
|
|
61991
|
+
{
|
|
61992
|
+
"type": "object",
|
|
61993
|
+
"properties": {
|
|
61994
|
+
"override": {
|
|
61995
|
+
"type": "object",
|
|
61996
|
+
"properties": {
|
|
61997
|
+
"scope": {
|
|
61998
|
+
"enum": [
|
|
61999
|
+
"alias-protection-override"
|
|
62000
|
+
]
|
|
62001
|
+
},
|
|
62002
|
+
"action": {
|
|
62003
|
+
"enum": [
|
|
62004
|
+
"create",
|
|
62005
|
+
"revoke"
|
|
62006
|
+
]
|
|
62007
|
+
}
|
|
62008
|
+
},
|
|
62009
|
+
"required": [
|
|
62010
|
+
"scope",
|
|
62011
|
+
"action"
|
|
62012
|
+
]
|
|
62013
|
+
}
|
|
62014
|
+
},
|
|
62015
|
+
"required": [
|
|
62016
|
+
"override"
|
|
62017
|
+
],
|
|
62018
|
+
"additionalProperties": false
|
|
62019
|
+
}
|
|
62020
|
+
]
|
|
62021
|
+
}
|
|
59588
62022
|
}
|
|
59589
62023
|
}
|
|
59590
|
-
|
|
62024
|
+
}
|
|
59591
62025
|
}
|
|
59592
62026
|
},
|
|
59593
62027
|
"/v7/certs/{id}": {
|
|
@@ -63856,9 +66290,6 @@
|
|
|
63856
66290
|
"enhanced"
|
|
63857
66291
|
]
|
|
63858
66292
|
},
|
|
63859
|
-
"abovePlan": {
|
|
63860
|
-
"type": "boolean"
|
|
63861
|
-
},
|
|
63862
66293
|
"isDefaultBuildMachine": {
|
|
63863
66294
|
"type": "boolean"
|
|
63864
66295
|
},
|
|
@@ -66601,6 +69032,45 @@
|
|
|
66601
69032
|
"oldConnectConfigurations": {
|
|
66602
69033
|
"nullable": true,
|
|
66603
69034
|
"items": {
|
|
69035
|
+
"properties": {
|
|
69036
|
+
"envId": {
|
|
69037
|
+
"oneOf": [
|
|
69038
|
+
{
|
|
69039
|
+
"type": "string"
|
|
69040
|
+
},
|
|
69041
|
+
{
|
|
69042
|
+
"type": "string",
|
|
69043
|
+
"enum": [
|
|
69044
|
+
"preview",
|
|
69045
|
+
"production"
|
|
69046
|
+
]
|
|
69047
|
+
}
|
|
69048
|
+
]
|
|
69049
|
+
},
|
|
69050
|
+
"connectConfigurationId": {
|
|
69051
|
+
"type": "string"
|
|
69052
|
+
},
|
|
69053
|
+
"passive": {
|
|
69054
|
+
"type": "boolean"
|
|
69055
|
+
},
|
|
69056
|
+
"buildsEnabled": {
|
|
69057
|
+
"type": "boolean"
|
|
69058
|
+
},
|
|
69059
|
+
"createdAt": {
|
|
69060
|
+
"type": "number"
|
|
69061
|
+
},
|
|
69062
|
+
"updatedAt": {
|
|
69063
|
+
"type": "number"
|
|
69064
|
+
}
|
|
69065
|
+
},
|
|
69066
|
+
"required": [
|
|
69067
|
+
"envId",
|
|
69068
|
+
"connectConfigurationId",
|
|
69069
|
+
"passive",
|
|
69070
|
+
"buildsEnabled",
|
|
69071
|
+
"createdAt",
|
|
69072
|
+
"updatedAt"
|
|
69073
|
+
],
|
|
66604
69074
|
"type": "object"
|
|
66605
69075
|
},
|
|
66606
69076
|
"type": "array"
|
|
@@ -66608,6 +69078,45 @@
|
|
|
66608
69078
|
"newConnectConfigurations": {
|
|
66609
69079
|
"nullable": true,
|
|
66610
69080
|
"items": {
|
|
69081
|
+
"properties": {
|
|
69082
|
+
"envId": {
|
|
69083
|
+
"oneOf": [
|
|
69084
|
+
{
|
|
69085
|
+
"type": "string"
|
|
69086
|
+
},
|
|
69087
|
+
{
|
|
69088
|
+
"type": "string",
|
|
69089
|
+
"enum": [
|
|
69090
|
+
"preview",
|
|
69091
|
+
"production"
|
|
69092
|
+
]
|
|
69093
|
+
}
|
|
69094
|
+
]
|
|
69095
|
+
},
|
|
69096
|
+
"connectConfigurationId": {
|
|
69097
|
+
"type": "string"
|
|
69098
|
+
},
|
|
69099
|
+
"passive": {
|
|
69100
|
+
"type": "boolean"
|
|
69101
|
+
},
|
|
69102
|
+
"buildsEnabled": {
|
|
69103
|
+
"type": "boolean"
|
|
69104
|
+
},
|
|
69105
|
+
"createdAt": {
|
|
69106
|
+
"type": "number"
|
|
69107
|
+
},
|
|
69108
|
+
"updatedAt": {
|
|
69109
|
+
"type": "number"
|
|
69110
|
+
}
|
|
69111
|
+
},
|
|
69112
|
+
"required": [
|
|
69113
|
+
"envId",
|
|
69114
|
+
"connectConfigurationId",
|
|
69115
|
+
"passive",
|
|
69116
|
+
"buildsEnabled",
|
|
69117
|
+
"createdAt",
|
|
69118
|
+
"updatedAt"
|
|
69119
|
+
],
|
|
66611
69120
|
"type": "object"
|
|
66612
69121
|
},
|
|
66613
69122
|
"type": "array"
|
|
@@ -69367,10 +71876,6 @@
|
|
|
69367
71876
|
],
|
|
69368
71877
|
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
|
|
69369
71878
|
},
|
|
69370
|
-
"abovePlan": {
|
|
69371
|
-
"type": "boolean",
|
|
69372
|
-
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
|
|
69373
|
-
},
|
|
69374
71879
|
"isDefaultBuildMachine": {
|
|
69375
71880
|
"type": "boolean",
|
|
69376
71881
|
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
|