ovpm/template/user.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "user.proto",
    "version": "version not set"
  },
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/api/v1/user/create": {
      "post": {
        "operationId": "Create",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbUserResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbUserCreateRequest"
            }
          }
        ],
        "tags": [
          "UserService"
        ]
      }
    },
    "/api/v1/user/delete": {
      "post": {
        "operationId": "Delete",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbUserResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbUserDeleteRequest"
            }
          }
        ],
        "tags": [
          "UserService"
        ]
      }
    },
    "/api/v1/user/genconfig": {
      "post": {
        "operationId": "GenConfig",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbUserGenConfigResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbUserGenConfigRequest"
            }
          }
        ],
        "tags": [
          "UserService"
        ]
      }
    },
    "/api/v1/user/list": {
      "get": {
        "operationId": "List",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbUserResponse"
            }
          }
        },
        "tags": [
          "UserService"
        ]
      }
    },
    "/api/v1/user/renew": {
      "post": {
        "operationId": "Renew",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbUserResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbUserRenewRequest"
            }
          }
        ],
        "tags": [
          "UserService"
        ]
      }
    },
    "/api/v1/user/update": {
      "post": {
        "operationId": "Update",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbUserResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbUserUpdateRequest"
            }
          }
        ],
        "tags": [
          "UserService"
        ]
      }
    }
  },
  "definitions": {
    "UserResponseUser": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "server_serial_number": {
          "type": "string"
        },
        "cert": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "ip_net": {
          "type": "string"
        },
        "no_gw": {
          "type": "boolean",
          "format": "boolean"
        },
        "host_id": {
          "type": "integer",
          "format": "int64"
        },
        "is_admin": {
          "type": "boolean",
          "format": "boolean"
        },
        "is_connected": {
          "type": "boolean",
          "format": "boolean"
        },
        "connected_since": {
          "type": "string"
        },
        "bytes_sent": {
          "type": "string",
          "format": "uint64"
        },
        "bytes_received": {
          "type": "string",
          "format": "uint64"
        },
        "expires_at": {
          "type": "string"
        }
      }
    },
    "UserUpdateRequestAdminPref": {
      "type": "string",
      "enum": [
        "NOPREFADMIN",
        "NOADMIN",
        "ADMIN"
      ],
      "default": "NOPREFADMIN"
    },
    "UserUpdateRequestGWPref": {
      "type": "string",
      "enum": [
        "NOPREF",
        "NOGW",
        "GW"
      ],
      "default": "NOPREF"
    },
    "UserUpdateRequestStaticPref": {
      "type": "string",
      "enum": [
        "NOPREFSTATIC",
        "NOSTATIC",
        "STATIC"
      ],
      "default": "NOPREFSTATIC"
    },
    "pbUserCreateRequest": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "no_gw": {
          "type": "boolean",
          "format": "boolean"
        },
        "host_id": {
          "type": "integer",
          "format": "int64"
        },
        "is_admin": {
          "type": "boolean",
          "format": "boolean"
        }
      }
    },
    "pbUserDeleteRequest": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        }
      }
    },
    "pbUserGenConfigRequest": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        }
      }
    },
    "pbUserGenConfigResponse": {
      "type": "object",
      "properties": {
        "client_config": {
          "type": "string"
        }
      }
    },
    "pbUserRenewRequest": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        }
      }
    },
    "pbUserResponse": {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/UserResponseUser"
          }
        }
      }
    },
    "pbUserUpdateRequest": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "gwpref": {
          "$ref": "#/definitions/UserUpdateRequestGWPref"
        },
        "host_id": {
          "type": "integer",
          "format": "int64"
        },
        "static_pref": {
          "$ref": "#/definitions/UserUpdateRequestStaticPref"
        },
        "admin_pref": {
          "$ref": "#/definitions/UserUpdateRequestAdminPref"
        }
      }
    }
  }
}