github.com/s7techlab/cckit@v0.10.5/extensions/debug/debug_state.swagger.json (about)

     1  {
     2    "swagger": "2.0",
     3    "info": {
     4      "title": "debug/debug_state.proto",
     5      "version": "version not set"
     6    },
     7    "consumes": [
     8      "application/json"
     9    ],
    10    "produces": [
    11      "application/json"
    12    ],
    13    "paths": {
    14      "/debug/state": {
    15        "put": {
    16          "summary": "Put state value",
    17          "operationId": "DebugStateService_PutState",
    18          "responses": {
    19            "200": {
    20              "description": "A successful response.",
    21              "schema": {
    22                "$ref": "#/definitions/debugValue"
    23              }
    24            },
    25            "default": {
    26              "description": "An unexpected error response.",
    27              "schema": {
    28                "$ref": "#/definitions/runtimeError"
    29              }
    30            }
    31          },
    32          "parameters": [
    33            {
    34              "name": "body",
    35              "in": "body",
    36              "required": true,
    37              "schema": {
    38                "$ref": "#/definitions/debugValue"
    39              }
    40            }
    41          ],
    42          "tags": [
    43            "DebugStateService"
    44          ]
    45        }
    46      },
    47      "/debug/state/clean": {
    48        "post": {
    49          "summary": "Delete all states or, if prefixes are defined, only prefix matched",
    50          "operationId": "DebugStateService_DeleteStates",
    51          "responses": {
    52            "200": {
    53              "description": "A successful response.",
    54              "schema": {
    55                "$ref": "#/definitions/debugPrefixesMatchCount"
    56              }
    57            },
    58            "default": {
    59              "description": "An unexpected error response.",
    60              "schema": {
    61                "$ref": "#/definitions/runtimeError"
    62              }
    63            }
    64          },
    65          "parameters": [
    66            {
    67              "name": "body",
    68              "in": "body",
    69              "required": true,
    70              "schema": {
    71                "$ref": "#/definitions/debugPrefixes"
    72              }
    73            }
    74          ],
    75          "tags": [
    76            "DebugStateService"
    77          ]
    78        }
    79      },
    80      "/debug/state/keys/{key}": {
    81        "get": {
    82          "summary": "Get keys list, returns all keys or, if prefixes are defined, only prefix matched",
    83          "operationId": "DebugStateService_ListKeys",
    84          "responses": {
    85            "200": {
    86              "description": "A successful response.",
    87              "schema": {
    88                "$ref": "#/definitions/debugCompositeKeys"
    89              }
    90            },
    91            "default": {
    92              "description": "An unexpected error response.",
    93              "schema": {
    94                "$ref": "#/definitions/runtimeError"
    95              }
    96            }
    97          },
    98          "parameters": [
    99            {
   100              "name": "key",
   101              "description": "parts of key",
   102              "in": "path",
   103              "required": true,
   104              "type": "array",
   105              "items": {
   106                "type": "string"
   107              },
   108              "collectionFormat": "csv",
   109              "minItems": 1
   110            }
   111          ],
   112          "tags": [
   113            "DebugStateService"
   114          ]
   115        }
   116      },
   117      "/debug/state/{key}": {
   118        "get": {
   119          "summary": "Get state value by key",
   120          "operationId": "DebugStateService_GetState",
   121          "responses": {
   122            "200": {
   123              "description": "A successful response.",
   124              "schema": {
   125                "$ref": "#/definitions/debugValue"
   126              }
   127            },
   128            "default": {
   129              "description": "An unexpected error response.",
   130              "schema": {
   131                "$ref": "#/definitions/runtimeError"
   132              }
   133            }
   134          },
   135          "parameters": [
   136            {
   137              "name": "key",
   138              "in": "path",
   139              "required": true,
   140              "type": "array",
   141              "items": {
   142                "type": "string"
   143              },
   144              "collectionFormat": "csv",
   145              "minItems": 1
   146            }
   147          ],
   148          "tags": [
   149            "DebugStateService"
   150          ]
   151        },
   152        "delete": {
   153          "summary": "Delete state value",
   154          "operationId": "DebugStateService_DeleteState",
   155          "responses": {
   156            "200": {
   157              "description": "A successful response.",
   158              "schema": {
   159                "$ref": "#/definitions/debugValue"
   160              }
   161            },
   162            "default": {
   163              "description": "An unexpected error response.",
   164              "schema": {
   165                "$ref": "#/definitions/runtimeError"
   166              }
   167            }
   168          },
   169          "parameters": [
   170            {
   171              "name": "key",
   172              "in": "path",
   173              "required": true,
   174              "type": "array",
   175              "items": {
   176                "type": "string"
   177              },
   178              "collectionFormat": "csv",
   179              "minItems": 1
   180            }
   181          ],
   182          "tags": [
   183            "DebugStateService"
   184          ]
   185        }
   186      }
   187    },
   188    "definitions": {
   189      "debugCompositeKey": {
   190        "type": "object",
   191        "properties": {
   192          "key": {
   193            "type": "array",
   194            "items": {
   195              "type": "string"
   196            }
   197          }
   198        },
   199        "title": "State key"
   200      },
   201      "debugCompositeKeys": {
   202        "type": "object",
   203        "properties": {
   204          "keys": {
   205            "type": "array",
   206            "items": {
   207              "$ref": "#/definitions/debugCompositeKey"
   208            }
   209          }
   210        },
   211        "title": "State keys"
   212      },
   213      "debugPrefix": {
   214        "type": "object",
   215        "properties": {
   216          "key": {
   217            "type": "array",
   218            "items": {
   219              "type": "string"
   220            },
   221            "title": "parts of key"
   222          }
   223        },
   224        "title": "State key prefix"
   225      },
   226      "debugPrefixes": {
   227        "type": "object",
   228        "properties": {
   229          "prefixes": {
   230            "type": "array",
   231            "items": {
   232              "$ref": "#/definitions/debugPrefix"
   233            }
   234          }
   235        }
   236      },
   237      "debugPrefixesMatchCount": {
   238        "type": "object",
   239        "properties": {
   240          "matches": {
   241            "type": "object",
   242            "additionalProperties": {
   243              "type": "integer",
   244              "format": "int64"
   245            }
   246          }
   247        },
   248        "title": "State key prefix match count"
   249      },
   250      "debugValue": {
   251        "type": "object",
   252        "properties": {
   253          "key": {
   254            "type": "array",
   255            "items": {
   256              "type": "string"
   257            }
   258          },
   259          "value": {
   260            "type": "string",
   261            "format": "byte"
   262          },
   263          "json": {
   264            "type": "string"
   265          }
   266        },
   267        "title": "State value"
   268      },
   269      "protobufAny": {
   270        "type": "object",
   271        "properties": {
   272          "type_url": {
   273            "type": "string"
   274          },
   275          "value": {
   276            "type": "string",
   277            "format": "byte"
   278          }
   279        }
   280      },
   281      "runtimeError": {
   282        "type": "object",
   283        "properties": {
   284          "error": {
   285            "type": "string"
   286          },
   287          "code": {
   288            "type": "integer",
   289            "format": "int32"
   290          },
   291          "message": {
   292            "type": "string"
   293          },
   294          "details": {
   295            "type": "array",
   296            "items": {
   297              "$ref": "#/definitions/protobufAny"
   298            }
   299          }
   300        }
   301      }
   302    }
   303  }