Skip to content

Commit 0f1f866

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent fa4804d commit 0f1f866

File tree

1 file changed

+17
-38
lines changed

1 file changed

+17
-38
lines changed

‎services/lb-application/v1alpha/lb-application.json

Lines changed: 17 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,12 @@
5252
},
5353
"CookiePersistence": {
5454
"properties": {
55-
"insert": {
56-
"description": "Insert specifies if a new cookie should be inserted by the Application Load Balancer or not.",
57-
"type": "boolean"
58-
},
5955
"name": {
6056
"description": "Cookie is the name of the cookie to use.",
6157
"type": "string"
6258
},
6359
"ttl": {
64-
"description": "TTL specifies the time-to-live for the cookie.\nThe default value is 0s, if set to zero, and it acts as a session cookie, expiring when the client session ends.\nTTL is configurable only when insert is set to true.",
60+
"description": "TTL specifies the time-to-live for the cookie.\nThe default value is 0s, and it acts as a session cookie, expiring when the client session ends.\n",
6561
"example": "120s",
6662
"pattern": "^-?(?:0|[1-9][0-9]{0,11})(?:\\.[0-9]{1,9})?s$",
6763
"title": "TTL (Time-to-live)",
@@ -692,17 +688,6 @@
692688
},
693689
"type": "object"
694690
},
695-
"SessionPersistence": {
696-
"properties": {
697-
"useSourceIpAddress": {
698-
"description": "If enabled then all connections from one source IP address are redirected to the same target. This setting changes the load balancing algorithm to Maglev.",
699-
"example": true,
700-
"title": "UseSourceIPAddress",
701-
"type": "boolean"
702-
}
703-
},
704-
"type": "object"
705-
},
706691
"Status": {
707692
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
708693
"properties": {
@@ -751,9 +736,6 @@
751736
"pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,18}[0-9a-z])?$",
752737
"type": "string"
753738
},
754-
"sessionPersistence": {
755-
"$ref": "#/components/schemas/SessionPersistence"
756-
},
757739
"targetPort": {
758740
"description": "The number identifying the port where each target listens for traffic.",
759741
"example": 5732,
@@ -885,9 +867,6 @@
885867
"pattern": "^[0-9a-z](?:(?:[0-9a-z]|-){0,18}[0-9a-z])?$",
886868
"type": "string"
887869
},
888-
"sessionPersistence": {
889-
"$ref": "#/components/schemas/SessionPersistence"
890-
},
891870
"targetPort": {
892871
"description": "The number identifying the port where each target listens for traffic.",
893872
"example": 5732,
@@ -915,7 +894,7 @@
915894
"paths": {
916895
"/v1alpha/plans": {
917896
"get": {
918-
"description": "ListPlans returns for the configured service plans for a project.",
897+
"description": "Lists the configured service plans for a project.",
919898
"operationId": "ListPlans",
920899
"responses": {
921900
"200": {
@@ -964,7 +943,7 @@
964943
"/v1alpha/projects/{projectId}": {
965944
"delete": {
966945
"deprecated": true,
967-
"description": "DEPRECATED! Disabling the application load balancer functionality is now automatic. The endpoint is kept for compatibility.\n Disable will disable the application load balancer functionality for the project specified.",
946+
"description": "DEPRECATED! Disabling the Application Load Balancer functionality is now automatic.\n This endpoint is kept for compatibility.\n Disables the Application Load Balancer functionality for the specified project.",
968947
"operationId": "DisableService",
969948
"parameters": [
970949
{
@@ -1021,7 +1000,7 @@
10211000
},
10221001
"get": {
10231002
"deprecated": true,
1024-
"description": "DEPRECATED! Checking the status is now obsolete. The endpoint is kept for compatibility.\n Status will return the Application Load Balancer functionality status for the project specified.",
1003+
"description": "DEPRECATED! Checking the status is now obsolete. The endpoint is kept for compatibility.\n Status will return the Application Load Balancer functionality status for the specified project.",
10251004
"operationId": "GetServiceStatus",
10261005
"parameters": [
10271006
{
@@ -1078,7 +1057,7 @@
10781057
},
10791058
"post": {
10801059
"deprecated": true,
1081-
"description": "DEPRECATED! Use CreateLoadBalancer directly instead.\n Enable will enable the Application Load Balancer functionality for the project specified.",
1060+
"description": "DEPRECATED! Checking the status is now obsolete. The endpoint is kept for compatibility.\n Enables the Application Load Balancer service for the specified project.",
10821061
"operationId": "EnableService",
10831062
"parameters": [
10841063
{
@@ -1146,7 +1125,7 @@
11461125
},
11471126
"/v1alpha/projects/{projectId}/credentials": {
11481127
"get": {
1149-
"description": "List Credentials",
1128+
"description": "Lists the stored Observability credentials.",
11501129
"operationId": "ListCredentials",
11511130
"parameters": [
11521131
{
@@ -1202,7 +1181,7 @@
12021181
"summary": "List all credentials in a project."
12031182
},
12041183
"post": {
1205-
"description": "Create credentials can be used to store existing credentials, which are valid to be used for Application Load Balancer Observability.\n This means, e.g. when using ARGUS, that credentials first must be created for that ARGUS instance (by using their API) and\n then can be provided to the Application Load Balancer by storing them with this endpoint.",
1184+
"description": "Creates and stores credentials for use with Application Load Balancer Observability.\n For example, when using ARGUS, credentials must first be created via the ARGUS API\n and then stored with this endpoint to be used by the Application Load Balancer.",
12061185
"operationId": "CreateCredentials",
12071186
"parameters": [
12081187
{
@@ -1280,7 +1259,7 @@
12801259
},
12811260
"/v1alpha/projects/{projectId}/credentials/{credentialsRef}": {
12821261
"delete": {
1283-
"description": "Delete Credential",
1262+
"description": "Deletes the stored Observability credentials.",
12841263
"operationId": "DeleteCredentials",
12851264
"parameters": [
12861265
{
@@ -1344,7 +1323,7 @@
13441323
"summary": "Delete a single credential in a project."
13451324
},
13461325
"get": {
1347-
"description": "Get Credentials",
1326+
"description": "Gets the stored Observability credentials.",
13481327
"operationId": "GetCredentials",
13491328
"parameters": [
13501329
{
@@ -1411,7 +1390,7 @@
14111390
"summary": "Get a single credential reference in a project."
14121391
},
14131392
"put": {
1414-
"description": "Update Credentials",
1393+
"description": "Updates the stored Observability credentials.",
14151394
"operationId": "UpdateCredentials",
14161395
"parameters": [
14171396
{
@@ -1490,7 +1469,7 @@
14901469
},
14911470
"/v1alpha/projects/{projectId}/load-balancers": {
14921471
"get": {
1493-
"description": "ListLoadBalancer will list load balancers of a project. This contains information set during\n creation or updates for every load balancer in the project. Additionally, it will have information about\n the state of the load balancer in the form of a status field and error description feedback.",
1472+
"description": "Lists all Application Load Balancers in a project.\n Includes details from creation or updates, along with their status and any error descriptions.",
14941473
"operationId": "ListLoadBalancers",
14951474
"parameters": [
14961475
{
@@ -1562,7 +1541,7 @@
15621541
"summary": "List load balancers in a project."
15631542
},
15641543
"post": {
1565-
"description": "Create Application Load Balancer will create a Application Load Balancer.\n The default load balancing algorithm is round robin unless useSourceIpAddress in session persistence is enabled for a target pool then it is Maglev.",
1544+
"description": "Creates an Application Load Balancer.\n The default load balancing algorithm is Maglev, and selecting a different algorithm is currently not supported.",
15661545
"operationId": "CreateLoadBalancer",
15671546
"parameters": [
15681547
{
@@ -1643,7 +1622,7 @@
16431622
},
16441623
"/v1alpha/projects/{projectId}/load-balancers/{name}": {
16451624
"delete": {
1646-
"description": "DeleteLoadBalancer will delete a given load balancer.",
1625+
"description": "Deletes the specified Application Load Balancer.",
16471626
"operationId": "DeleteLoadBalancer",
16481627
"parameters": [
16491628
{
@@ -1707,7 +1686,7 @@
17071686
"summary": "Delete a given load balancer in a project."
17081687
},
17091688
"get": {
1710-
"description": "Get Load Balancer will get a single load balancer of a project. This contains all the information set during\n creation or updates. Additionally, it will have information about the state of the load balancer in the form\n of a status field and error description feedback.",
1689+
"description": "Retrieves details of a specific Application Load Balancer in a project.\n Includes creation and update information, current status, and any error descriptions.",
17111690
"operationId": "GetLoadBalancer",
17121691
"parameters": [
17131692
{
@@ -1774,7 +1753,7 @@
17741753
"summary": "Get a single application load balancer in a project."
17751754
},
17761755
"put": {
1777-
"description": "Update Load Balancer allows the change of listeners and target pools of an existing Load Balancer.\n The Load balancer resource version needs to be the current version to ensure concurrency safe updates.\n The default load balancing algorithm is round robin unless useSourceIpAddress in session persistence is enabled for a target pool then it is Maglev.",
1756+
"description": "Updates an existing Application Load Balancer by modifying its listeners and target pools.\n Ensure the resource version is current to maintain concurrency safety.\n The default load balancing algorithm is Maglev, and selecting a different algorithm is currently not supported.",
17781757
"operationId": "UpdateLoadBalancer",
17791758
"parameters": [
17801759
{
@@ -1853,7 +1832,7 @@
18531832
},
18541833
"/v1alpha/projects/{projectId}/load-balancers/{name}/target-pools/{targetPoolName}": {
18551834
"put": {
1856-
"description": "ReplaceTargetPool will replace a specific target pool of a load balancer with new content.\n Useful to add/remove target servers. will update a load balancer.\n Only replaces the mentioned target pools and leaves others unchanged.\n Cannot be used to create or rename a target pool.",
1835+
"description": "Replaces the content of a specific target pool in the Application Load Balancer (useful for adding or removing target servers).\n Only updates the specified target pool, leaving others unchanged.\n Cannot be used to create or rename target pools.",
18571836
"operationId": "UpdateTargetPool",
18581837
"parameters": [
18591838
{
@@ -1937,7 +1916,7 @@
19371916
},
19381917
"/v1alpha/projects/{projectId}/quota": {
19391918
"get": {
1940-
"description": "GetQuota gets the configured application load balancer quota for the project. Default is 3.",
1919+
"description": "Retrieves the configured Application Load Balancer quota for the project.\n The default quota is 3.",
19411920
"operationId": "GetQuota",
19421921
"parameters": [
19431922
{

0 commit comments

Comments
 (0)