Skip to content

Commit

Permalink
Add a custom request ID to API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@yunkon-kim
yunkon-kim committed May 14, 2024
1 parent 2e788a6 commit 5e12de9
Show file tree
Hide file tree
Showing 5 changed files with 306 additions and 0 deletions.
108 changes: 108 additions & 0 deletions pkg/api/rest/docs/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -196,6 +202,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -250,6 +262,12 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/handlers.CreateBluprintOfGcpAwsVpnRequest"
}
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -295,6 +313,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -340,6 +364,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -385,6 +415,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -437,6 +473,12 @@ const docTemplate = `{
"name": "requestId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -482,6 +524,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -527,6 +575,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -572,6 +626,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -615,6 +675,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -669,6 +735,12 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/handlers.CreateBluprintOfGcpAzureVpnRequest"
}
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -714,6 +786,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -759,6 +837,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -804,6 +888,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -856,6 +946,12 @@ const docTemplate = `{
"name": "requestId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -901,6 +997,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -946,6 +1048,12 @@ const docTemplate = `{
"name": "resourceGroupId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down
Loading

0 comments on commit 5e12de9

Please sign in to comment.