Skip to content

Commit

Permalink
Add middleware to support tracing-like functionalities
Browse files Browse the repository at this point in the history
  • Loading branch information
@cb-github-robot
cb-github-robot authored Sep 10, 2024
2 parents 7b3146b + efb97a8 commit 5bd99be
Show file tree
Hide file tree
Showing 12 changed files with 379 additions and 0 deletions.
78 changes: 78 additions & 0 deletions api/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ const docTemplate = `{
"[Admin] System management"
],
"summary": "Check HTTP version of incoming request",
"parameters": [
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
"200": {
"description": "OK",
Expand Down Expand Up @@ -89,6 +97,12 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/controller.MigrateInfraRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -143,6 +157,12 @@ const docTemplate = `{
"name": "mciId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -195,6 +215,12 @@ const docTemplate = `{
"name": "mciId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -232,6 +258,14 @@ const docTemplate = `{
"[Admin] System management"
],
"summary": "Check Beetle is ready",
"parameters": [
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
"200": {
"description": "OK",
Expand Down Expand Up @@ -271,6 +305,12 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/controller.RecommendInfraRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -309,6 +349,14 @@ const docTemplate = `{
],
"summary": "Get a list of users",
"operationId": "GetUsers",
"parameters": [
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
"200": {
"description": "(sample) This is a sample description for success response in Swagger UI",
Expand Down Expand Up @@ -346,6 +394,12 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/controller.CreateUserRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -385,6 +439,12 @@ const docTemplate = `{
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -431,6 +491,12 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/controller.UpdateUserRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -468,6 +534,12 @@ const docTemplate = `{
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -520,6 +592,12 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/controller.PatchUserRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down
78 changes: 78 additions & 0 deletions api/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@
"[Admin] System management"
],
"summary": "Check HTTP version of incoming request",
"parameters": [
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
"200": {
"description": "OK",
Expand Down Expand Up @@ -82,6 +90,12 @@
"schema": {
"$ref": "#/definitions/controller.MigrateInfraRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -136,6 +150,12 @@
"name": "mciId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -188,6 +208,12 @@
"name": "mciId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -225,6 +251,14 @@
"[Admin] System management"
],
"summary": "Check Beetle is ready",
"parameters": [
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
"200": {
"description": "OK",
Expand Down Expand Up @@ -264,6 +298,12 @@
"schema": {
"$ref": "#/definitions/controller.RecommendInfraRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -302,6 +342,14 @@
],
"summary": "Get a list of users",
"operationId": "GetUsers",
"parameters": [
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
"200": {
"description": "(sample) This is a sample description for success response in Swagger UI",
Expand Down Expand Up @@ -339,6 +387,12 @@
"schema": {
"$ref": "#/definitions/controller.CreateUserRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -378,6 +432,12 @@
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -424,6 +484,12 @@
"schema": {
"$ref": "#/definitions/controller.UpdateUserRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -461,6 +527,12 @@
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down Expand Up @@ -513,6 +585,12 @@
"schema": {
"$ref": "#/definitions/controller.PatchUserRequest"
}
},
{
"type": "string",
"description": "Custom request ID (NOTE: It will be used as a trace ID.)",
"name": "x-request-id",
"in": "header"
}
],
"responses": {
Expand Down
Loading

0 comments on commit 5bd99be

Please sign in to comment.