Skip to content

Commit 0bad7e4

Browse files
committed
Add new properties of OpenAPI
1 parent 424ab62 commit 0bad7e4

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

v2.6/documentation/openapi.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@
176176
]
177177
},
178178
"operation_id": {
179-
"$id": "#documentation/openapi/example",
179+
"$id": "#documentation/openapi/operation_id",
180180
"title": "Operation ID",
181181
"description": "A unique string identifying the operation identifier. Usually the method + the endpoint. If provided, these IDs must be unique among all operations described in your API.\n\nSee: https://www.krakend.io/docs/enterprise/developer/openapi/",
182182
"type": "string",
@@ -190,6 +190,7 @@
190190
"description": "Sets a description for the tags classifiying endpoints when generating the OpenAPI spec.\n\nSee: https://www.krakend.io/docs/enterprise/developer/openapi/",
191191
"type": "array",
192192
"items": {
193+
"title": "Tags",
193194
"type": "object",
194195
"required": [
195196
"name"
@@ -200,9 +201,13 @@
200201
},
201202
"properties": {
202203
"name": {
204+
"title": "Tag name",
205+
"description": "The name of the tag. You will use this name in each endpoint.",
203206
"type": "string"
204207
},
205208
"description": {
209+
"title": "Tag Description",
210+
"description": "Describe what this tag is grouping",
206211
"type": "string"
207212
}
208213
}
@@ -222,6 +227,7 @@
222227
"description": "Sets a description for the query strings allowed in the endpoint. Make sure to include the same strings in the endpoint's `input_query_strings`.\n\nSee: https://www.krakend.io/docs/enterprise/developer/openapi/",
223228
"type": "array",
224229
"items": {
230+
"title": "Query strings",
225231
"type": "object",
226232
"required": [
227233
"name"
@@ -232,9 +238,13 @@
232238
},
233239
"properties": {
234240
"name": {
241+
"title": "Name",
242+
"description": "The name of the querystring, as declared in `input_query_strings`",
235243
"type": "string"
236244
},
237245
"description": {
246+
"title": "Name",
247+
"description": "The description of the querystring",
238248
"type": "string"
239249
}
240250
}

0 commit comments

Comments
 (0)