Skip to content

Commit 6890147

Browse files
gilzowgithub-actions[bot]
authored andcommitted
Update API Docs
1 parent ee6b468 commit 6890147

File tree

3 files changed

+295
-509
lines changed

3 files changed

+295
-509
lines changed

shared/pages/api.html

Lines changed: 218 additions & 224 deletions
Large diffs are not rendered by default.

shared/pages/openapispec-upsun.json

Lines changed: 43 additions & 167 deletions
Original file line numberDiff line numberDiff line change
@@ -611,44 +611,6 @@
611611
}
612612
}
613613
},
614-
"/plans": {
615-
"get": {
616-
"tags": [
617-
"Plans"
618-
],
619-
"summary": "List available plans",
620-
"description": "Retrieve information about plans and pricing on Platform.sh.",
621-
"operationId": "list-plans",
622-
"responses": {
623-
"200": {
624-
"description": "The list of plans.",
625-
"content": {
626-
"application/json": {
627-
"schema": {
628-
"properties": {
629-
"count": {
630-
"description": "Total number of plans.",
631-
"type": "integer"
632-
},
633-
"plans": {
634-
"description": "Array of plans.",
635-
"type": "array",
636-
"items": {
637-
"$ref": "#/components/schemas/Plan"
638-
}
639-
},
640-
"_links": {
641-
"$ref": "#/components/schemas/HalLinks"
642-
}
643-
},
644-
"type": "object"
645-
}
646-
}
647-
}
648-
}
649-
}
650-
}
651-
},
652614
"/subscriptions/{subscriptionId}/can-update": {
653615
"get": {
654616
"tags": [
@@ -7893,57 +7855,6 @@
78937855
}
78947856
}
78957857
},
7896-
"/projects/{projectId}/environments/{environmentId}/autoscaling/alerts": {
7897-
"post": {
7898-
"tags": [
7899-
"Autoscaling"
7900-
],
7901-
"description": "Sends an Autoscaler alert for processing",
7902-
"operationId": "post-autoscaler-alert",
7903-
"parameters": [
7904-
{
7905-
"name": "projectId",
7906-
"in": "path",
7907-
"description": "A string that uniquely identifies the project",
7908-
"required": true,
7909-
"schema": {
7910-
"type": "string"
7911-
}
7912-
},
7913-
{
7914-
"name": "environmentId",
7915-
"in": "path",
7916-
"description": "A string that uniquely identifies the project environment",
7917-
"required": true,
7918-
"schema": {
7919-
"type": "string"
7920-
}
7921-
}
7922-
],
7923-
"requestBody": {
7924-
"description": "Alert to process",
7925-
"content": {
7926-
"application/json": {
7927-
"schema": {
7928-
"$ref": "#/components/schemas/AutoscalerAlertPartial"
7929-
}
7930-
}
7931-
}
7932-
},
7933-
"responses": {
7934-
"202": {
7935-
"description": "Alert is accepted for processing",
7936-
"content": {
7937-
"application/json": {
7938-
"schema": {
7939-
"$ref": "#/components/schemas/AutoscalerEmptyBody"
7940-
}
7941-
}
7942-
}
7943-
}
7944-
}
7945-
}
7946-
},
79477858
"/ref/organizations": {
79487859
"get": {
79497860
"summary": "List referenced organizations",
@@ -13706,20 +13617,6 @@
1370613617
},
1370713618
"type": "object"
1370813619
},
13709-
"Plan": {
13710-
"description": "The hosting plan.",
13711-
"properties": {
13712-
"name": {
13713-
"description": "The machine name of the plan.",
13714-
"type": "string"
13715-
},
13716-
"label": {
13717-
"description": "The human-readable name of the plan.",
13718-
"type": "string"
13719-
}
13720-
},
13721-
"type": "object"
13722-
},
1372313620
"Region": {
1372413621
"description": "The hosting region.",
1372513622
"properties": {
@@ -20137,6 +20034,10 @@
2013720034
"title": "Is there any staged activity on this environment"
2013820035
},
2013920036
"can_rolling_deploy": {
20037+
"type": "boolean",
20038+
"title": "If the environment has rolling deployments ready for use"
20039+
},
20040+
"supports_rolling_deployments": {
2014020041
"type": "boolean",
2014120042
"title": "If the environment supports rolling deployments"
2014220043
},
@@ -20217,6 +20118,7 @@
2021720118
"is_dirty",
2021820119
"has_staged_activities",
2021920120
"can_rolling_deploy",
20121+
"supports_rolling_deployments",
2022020122
"has_code",
2022120123
"head_commit",
2022220124
"merge_info",
@@ -21382,6 +21284,20 @@
2138221284
],
2138321285
"title": "The resources used when initializing a new service"
2138421286
},
21287+
"token_expires_at": {
21288+
"type": "string",
21289+
"format": "date-time",
21290+
"nullable": true,
21291+
"title": "'expires_at' value of the current token."
21292+
},
21293+
"rotate_token": {
21294+
"type": "boolean",
21295+
"title": "Whether or not to rotate token automatically using Gitlab API."
21296+
},
21297+
"rotate_token_validity_in_weeks": {
21298+
"type": "integer",
21299+
"title": "Validity in weeks of a new token after rotation."
21300+
},
2138521301
"base_url": {
2138621302
"type": "string",
2138721303
"title": "The base URL of the GitLab installation."
@@ -21410,6 +21326,9 @@
2141021326
"fetch_branches",
2141121327
"prune_branches",
2141221328
"environment_init_resources",
21329+
"token_expires_at",
21330+
"rotate_token",
21331+
"rotate_token_validity_in_weeks",
2141321332
"base_url",
2141421333
"project",
2141521334
"build_merge_requests",
@@ -21447,6 +21366,14 @@
2144721366
"type": "string",
2144821367
"title": "The GitLab private token."
2144921368
},
21369+
"rotate_token": {
21370+
"type": "boolean",
21371+
"title": "Whether or not to rotate token automatically using Gitlab API."
21372+
},
21373+
"rotate_token_validity_in_weeks": {
21374+
"type": "integer",
21375+
"title": "Validity in weeks of a new token after rotation."
21376+
},
2145021377
"base_url": {
2145121378
"type": "string",
2145221379
"title": "The base URL of the GitLab installation."
@@ -21504,6 +21431,14 @@
2150421431
"type": "string",
2150521432
"title": "The GitLab private token."
2150621433
},
21434+
"rotate_token": {
21435+
"type": "boolean",
21436+
"title": "Whether or not to rotate token automatically using Gitlab API."
21437+
},
21438+
"rotate_token_validity_in_weeks": {
21439+
"type": "integer",
21440+
"title": "Validity in weeks of a new token after rotation."
21441+
},
2150721442
"base_url": {
2150821443
"type": "string",
2150921444
"title": "The base URL of the GitLab installation."
@@ -23576,6 +23511,10 @@
2357623511
"type": "boolean",
2357723512
"title": "Whether self-upgrades are enabled"
2357823513
},
23514+
"self_upgrade_latest_major": {
23515+
"type": "boolean",
23516+
"title": "Whether to check for n+1 major version when self-upgrades are enabled"
23517+
},
2357923518
"additional_hosts": {
2358023519
"type": "object",
2358123520
"additionalProperties": {
@@ -23790,6 +23729,7 @@
2379023729
"build_resources",
2379123730
"outbound_restrictions_default_policy",
2379223731
"self_upgrade",
23732+
"self_upgrade_latest_major",
2379323733
"additional_hosts",
2379423734
"max_allowed_routes",
2379523735
"max_allowed_redirects_paths",
@@ -25955,64 +25895,6 @@
2595525895
],
2595625896
"additionalProperties": false
2595725897
},
25958-
"AutoscalerAlertPartial": {
25959-
"properties": {
25960-
"name": {
25961-
"description": "User friendly name for the alert",
25962-
"title": "Name",
25963-
"type": "string"
25964-
},
25965-
"environment": {
25966-
"type": "string",
25967-
"nullable": true,
25968-
"title": "Environment",
25969-
"description": "Environment for which the alert was received"
25970-
},
25971-
"service": {
25972-
"description": "Service for which the alert was received",
25973-
"title": "Service",
25974-
"type": "string"
25975-
},
25976-
"resource": {
25977-
"type": "string",
25978-
"nullable": true,
25979-
"title": "Resource",
25980-
"description": "Name of resource that triggered the alert"
25981-
},
25982-
"condition": {
25983-
"description": "Comparison condition to use when evaluating the alert",
25984-
"title": "Condition",
25985-
"type": "string"
25986-
},
25987-
"threshold": {
25988-
"description": "Value that has to be crossed for the alert to be considered triggered",
25989-
"title": "Threshold",
25990-
"type": "number"
25991-
},
25992-
"duration": {
25993-
"type": "object",
25994-
"additionalProperties": {
25995-
"$ref": "#/components/schemas/AutoscalerDuration"
25996-
},
25997-
"nullable": true,
25998-
"description": "Number of seconds during which the condition was satisfied"
25999-
},
26000-
"value": {
26001-
"description": "Current value for the received alert",
26002-
"title": "Value",
26003-
"type": "number"
26004-
}
26005-
},
26006-
"required": [
26007-
"name",
26008-
"service",
26009-
"condition",
26010-
"threshold",
26011-
"value"
26012-
],
26013-
"title": "AutoscalerAlertPartial",
26014-
"type": "object"
26015-
},
2601625898
"AutoscalerCPUPressureTrigger": {
2601725899
"description": "CPU pressure trigger settings.\n\nWhen CPU pressure goes below lower bound, service will be scaled down.\nWhen CPU pressure goes above upper bound, service will be scaled up.",
2601825900
"properties": {
@@ -26113,12 +25995,6 @@
2611325995
"title": "AutoscalerDuration",
2611425996
"type": "integer"
2611525997
},
26116-
"AutoscalerEmptyBody": {
26117-
"description": "Empty body",
26118-
"properties": {},
26119-
"title": "AutoscalerEmptyBody",
26120-
"type": "object"
26121-
},
2612225998
"AutoscalerInstances": {
2612325999
"description": "Horizontal scaling settings",
2612426000
"properties": {

0 commit comments

Comments
 (0)