ovpm/template/network.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "network.proto",
    "version": "version not set"
  },
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/api/v1/network/associate": {
      "post": {
        "operationId": "Associate",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbNetworkAssociateResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbNetworkAssociateRequest"
            }
          }
        ],
        "tags": [
          "NetworkService"
        ]
      }
    },
    "/api/v1/network/create": {
      "post": {
        "operationId": "Create",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbNetworkCreateResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbNetworkCreateRequest"
            }
          }
        ],
        "tags": [
          "NetworkService"
        ]
      }
    },
    "/api/v1/network/delete": {
      "post": {
        "operationId": "Delete",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbNetworkDeleteResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbNetworkDeleteRequest"
            }
          }
        ],
        "tags": [
          "NetworkService"
        ]
      }
    },
    "/api/v1/network/dissociate": {
      "post": {
        "operationId": "Dissociate",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbNetworkDissociateResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/pbNetworkDissociateRequest"
            }
          }
        ],
        "tags": [
          "NetworkService"
        ]
      }
    },
    "/api/v1/network/getalltypes": {
      "get": {
        "operationId": "GetAllTypes",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbNetworkGetAllTypesResponse"
            }
          }
        },
        "tags": [
          "NetworkService"
        ]
      }
    },
    "/api/v1/network/getassociatedusers": {
      "get": {
        "operationId": "GetAssociatedUsers",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbNetworkGetAssociatedUsersResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "NetworkService"
        ]
      }
    },
    "/api/v1/network/list": {
      "get": {
        "operationId": "List",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/pbNetworkListResponse"
            }
          }
        },
        "tags": [
          "NetworkService"
        ]
      }
    }
  },
  "definitions": {
    "pbNetwork": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "cidr": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "associated_usernames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "via": {
          "type": "string"
        }
      }
    },
    "pbNetworkAssociateRequest": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "username": {
          "type": "string"
        }
      }
    },
    "pbNetworkAssociateResponse": {
      "type": "object"
    },
    "pbNetworkCreateRequest": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "cidr": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "via": {
          "type": "string"
        }
      }
    },
    "pbNetworkCreateResponse": {
      "type": "object",
      "properties": {
        "network": {
          "$ref": "#/definitions/pbNetwork"
        }
      }
    },
    "pbNetworkDeleteRequest": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "pbNetworkDeleteResponse": {
      "type": "object",
      "properties": {
        "network": {
          "$ref": "#/definitions/pbNetwork"
        }
      }
    },
    "pbNetworkDissociateRequest": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "username": {
          "type": "string"
        }
      }
    },
    "pbNetworkDissociateResponse": {
      "type": "object"
    },
    "pbNetworkGetAllTypesResponse": {
      "type": "object",
      "properties": {
        "types": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/pbNetworkType"
          }
        }
      }
    },
    "pbNetworkGetAssociatedUsersResponse": {
      "type": "object",
      "properties": {
        "usernames": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "pbNetworkListResponse": {
      "type": "object",
      "properties": {
        "networks": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/pbNetwork"
          }
        }
      }
    },
    "pbNetworkType": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      }
    }
  }
}