Skip to content

Commit 31dcdfd

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent 54a0a8a commit 31dcdfd

File tree

1 file changed

+163
-34
lines changed

1 file changed

+163
-34
lines changed

‎services/observability/v1/observability.json‎

Lines changed: 163 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,9 @@
284284
},
285285
"CertCheckResponse": {
286286
"properties": {
287+
"certCheck": {
288+
"$ref": "#/components/schemas/CertCheckChildResponse"
289+
},
287290
"certChecks": {
288291
"items": {
289292
"$ref": "#/components/schemas/CertCheckChildResponse"
@@ -303,6 +306,21 @@
303306
],
304307
"type": "object"
305308
},
309+
"CheckArrayError": {
310+
"items": {
311+
"type": "string"
312+
},
313+
"type": "array"
314+
},
315+
"CheckObjectError": {
316+
"additionalProperties": {
317+
"items": {
318+
"type": "string"
319+
},
320+
"type": "array"
321+
},
322+
"type": "object"
323+
},
306324
"CreateAlertConfigReceiverPayload": {
307325
"description": "Receivers",
308326
"properties": {
@@ -1774,6 +1792,9 @@
17741792
},
17751793
"HttpCheckResponse": {
17761794
"properties": {
1795+
"httpCheck": {
1796+
"$ref": "#/components/schemas/HttpCheckChildResponse"
1797+
},
17771798
"httpChecks": {
17781799
"items": {
17791800
"$ref": "#/components/schemas/HttpCheckChildResponse"
@@ -7805,7 +7826,20 @@
78057826
}
78067827
}
78077828
},
7808-
"description": "Get all cert checks"
7829+
"description": "Get all cert checks."
7830+
},
7831+
"400": {
7832+
"content": {
7833+
"application/json": {
7834+
"example": [
7835+
"instance is not ready"
7836+
],
7837+
"schema": {
7838+
"$ref": "#/components/schemas/CheckArrayError"
7839+
}
7840+
}
7841+
},
7842+
"description": "Something went wrong."
78097843
},
78107844
"403": {
78117845
"content": {
@@ -7818,7 +7852,7 @@
78187852
}
78197853
}
78207854
},
7821-
"description": "You are not authorized"
7855+
"description": "You are not authorized."
78227856
}
78237857
},
78247858
"x-stackit-authorization": {
@@ -7866,20 +7900,61 @@
78667900
"content": {
78677901
"application/json": {
78687902
"example": {
7903+
"certCheck": {
7904+
"id": "bedcfb8ce34aafd00d7b7b09bca37edc",
7905+
"source": "tcp://example.org:80"
7906+
},
78697907
"certChecks": [
78707908
{
78717909
"id": "cdb25317a9cdd3e640ed72d432cde7ea",
78727910
"source": "tcp://example.org:443"
7911+
},
7912+
{
7913+
"id": "bedcfb8ce34aafd00d7b7b09bca37edc",
7914+
"source": "tcp://example.org:80"
78737915
}
78747916
],
7875-
"message": "Successfully got all cert checks"
7917+
"message": "Successfully created cert check"
78767918
},
78777919
"schema": {
78787920
"$ref": "#/components/schemas/CertCheckResponse"
78797921
}
78807922
}
78817923
},
7882-
"description": "Get all cert checks"
7924+
"description": "Get added check (certCheck) and all configured checks (certChecks)."
7925+
},
7926+
"400": {
7927+
"content": {
7928+
"application/json": {
7929+
"examples": {
7930+
"CheckArrayError": {
7931+
"summary": "Global error",
7932+
"value": [
7933+
"instance is not ready"
7934+
]
7935+
},
7936+
"CheckObjectError": {
7937+
"summary": "Field specific error",
7938+
"value": {
7939+
"source": [
7940+
"This field may not be blank."
7941+
]
7942+
}
7943+
}
7944+
},
7945+
"schema": {
7946+
"oneOf": [
7947+
{
7948+
"$ref": "#/components/schemas/CheckObjectError"
7949+
},
7950+
{
7951+
"$ref": "#/components/schemas/CheckArrayError"
7952+
}
7953+
]
7954+
}
7955+
}
7956+
},
7957+
"description": "Something went wrong."
78837958
},
78847959
"403": {
78857960
"content": {
@@ -7892,7 +7967,7 @@
78927967
}
78937968
}
78947969
},
7895-
"description": "You are not authorized"
7970+
"description": "You are not authorized."
78967971
}
78977972
},
78987973
"x-stackit-authorization": {
@@ -7953,33 +8028,33 @@
79538028
}
79548029
}
79558030
},
7956-
"description": "Delete cert check"
8031+
"description": "Delete cert check."
79578032
},
7958-
"403": {
8033+
"400": {
79598034
"content": {
79608035
"application/json": {
7961-
"example": {
7962-
"detail": "You do not have permission to perform this action."
7963-
},
8036+
"example": [
8037+
"instance is not ready"
8038+
],
79648039
"schema": {
7965-
"$ref": "#/components/schemas/PermissionDenied"
8040+
"$ref": "#/components/schemas/CheckArrayError"
79668041
}
79678042
}
79688043
},
7969-
"description": "You are not authorized"
8044+
"description": "Something went wrong."
79708045
},
7971-
"404": {
8046+
"403": {
79728047
"content": {
79738048
"application/json": {
79748049
"example": {
7975-
"message": "Cert check not found"
8050+
"detail": "You do not have permission to perform this action."
79768051
},
79778052
"schema": {
7978-
"$ref": "#/components/schemas/Message"
8053+
"$ref": "#/components/schemas/PermissionDenied"
79798054
}
79808055
}
79818056
},
7982-
"description": "Did not found cert check"
8057+
"description": "You are not authorized."
79838058
}
79848059
},
79858060
"x-stackit-authorization": {
@@ -8821,14 +8896,27 @@
88218896
"url": "https://example.org"
88228897
}
88238898
],
8824-
"message": "Successfully got all check check urls"
8899+
"message": "Successfully got all http checks"
88258900
},
88268901
"schema": {
88278902
"$ref": "#/components/schemas/HttpCheckResponse"
88288903
}
88298904
}
88308905
},
8831-
"description": "Get all http checks"
8906+
"description": "Get all http checks."
8907+
},
8908+
"400": {
8909+
"content": {
8910+
"application/json": {
8911+
"example": [
8912+
"instance is not ready"
8913+
],
8914+
"schema": {
8915+
"$ref": "#/components/schemas/CheckArrayError"
8916+
}
8917+
}
8918+
},
8919+
"description": "Something went wrong."
88328920
},
88338921
"403": {
88348922
"content": {
@@ -8841,7 +8929,7 @@
88418929
}
88428930
}
88438931
},
8844-
"description": "You are not authorized"
8932+
"description": "You are not authorized."
88458933
}
88468934
},
88478935
"x-stackit-authorization": {
@@ -8889,20 +8977,61 @@
88898977
"content": {
88908978
"application/json": {
88918979
"example": {
8980+
"httpCheck": {
8981+
"id": "8cb80949d33b768d4ef61f94f3f54cba",
8982+
"url": "https://example-2.org"
8983+
},
88928984
"httpChecks": [
88938985
{
88948986
"id": "5564fd6a95028f02e52b38bb1743c816",
88958987
"url": "https://example.org"
8988+
},
8989+
{
8990+
"id": "8cb80949d33b768d4ef61f94f3f54cba",
8991+
"url": "https://example-2.org"
88968992
}
88978993
],
8898-
"message": "Successfully got all check check urls"
8994+
"message": "Successfully created http check"
88998995
},
89008996
"schema": {
89018997
"$ref": "#/components/schemas/HttpCheckResponse"
89028998
}
89038999
}
89049000
},
8905-
"description": "Get all http checks"
9001+
"description": "Get added check (httpCheck) and all configured checks (httpChecks)."
9002+
},
9003+
"400": {
9004+
"content": {
9005+
"application/json": {
9006+
"examples": {
9007+
"CheckArrayError": {
9008+
"summary": "Global error",
9009+
"value": [
9010+
"instance is not ready"
9011+
]
9012+
},
9013+
"CheckObjectError": {
9014+
"summary": "Field specific error",
9015+
"value": {
9016+
"url": [
9017+
"This field may not be blank."
9018+
]
9019+
}
9020+
}
9021+
},
9022+
"schema": {
9023+
"oneOf": [
9024+
{
9025+
"$ref": "#/components/schemas/CheckObjectError"
9026+
},
9027+
{
9028+
"$ref": "#/components/schemas/CheckArrayError"
9029+
}
9030+
]
9031+
}
9032+
}
9033+
},
9034+
"description": "Something went wrong."
89069035
},
89079036
"403": {
89089037
"content": {
@@ -8915,7 +9044,7 @@
89159044
}
89169045
}
89179046
},
8918-
"description": "You are not authorized"
9047+
"description": "You are not authorized."
89199048
}
89209049
},
89219050
"x-stackit-authorization": {
@@ -8969,40 +9098,40 @@
89699098
"url": "https://example.org"
89709099
}
89719100
],
8972-
"message": "Successfully deleted ping check urls"
9101+
"message": "Successfully deleted http check"
89739102
},
89749103
"schema": {
89759104
"$ref": "#/components/schemas/HttpCheckResponse"
89769105
}
89779106
}
89789107
},
8979-
"description": "Delete http check"
9108+
"description": "Delete http check."
89809109
},
8981-
"403": {
9110+
"400": {
89829111
"content": {
89839112
"application/json": {
8984-
"example": {
8985-
"detail": "You do not have permission to perform this action."
8986-
},
9113+
"example": [
9114+
"instance is not ready"
9115+
],
89879116
"schema": {
8988-
"$ref": "#/components/schemas/PermissionDenied"
9117+
"$ref": "#/components/schemas/CheckArrayError"
89899118
}
89909119
}
89919120
},
8992-
"description": "You are not authorized"
9121+
"description": "Something went wrong."
89939122
},
8994-
"404": {
9123+
"403": {
89959124
"content": {
89969125
"application/json": {
89979126
"example": {
8998-
"message": "Http check url not found"
9127+
"detail": "You do not have permission to perform this action."
89999128
},
90009129
"schema": {
9001-
"$ref": "#/components/schemas/Message"
9130+
"$ref": "#/components/schemas/PermissionDenied"
90029131
}
90039132
}
90049133
},
9005-
"description": "Did not found http check"
9134+
"description": "You are not authorized."
90069135
}
90079136
},
90089137
"x-stackit-authorization": {

0 commit comments

Comments
 (0)