swagger.json

{
  "swagger": "2.0",
  "paths": {
    "/api/v1/admin/groups": {
      "get": {
        "tags": [
          "admin"
        ],
        "summary": "Returns a paginated list of groups.",
        "operationId": "groups",
        "parameters": [
          {
            "type": "integer",
            "format": "int64",
            "name": "limit",
            "in": "query"
          },
          {
            "type": "integer",
            "format": "int64",
            "name": "cursor",
            "in": "query"
          },
          {
            "type": "string",
            "name": "filter",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/adminGroupsResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/groups/{id}": {
      "get": {
        "tags": [
          "admin"
        ],
        "summary": "Returns a group and its users.",
        "operationId": "group",
        "parameters": [
          {
            "type": "integer",
            "format": "int64",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/adminGroupResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/impersonate/{id}": {
      "get": {
        "description": "Gets an authentication token for an admin that allows scoping as a user",
        "tags": [
          "admin"
        ],
        "operationId": "impersonate",
        "parameters": [
          {
            "type": "integer",
            "format": "int64",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/tokenResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/settings": {
      "get": {
        "tags": [
          "admin"
        ],
        "summary": "Returns the current application settings.",
        "operationId": "currentSettings",
        "responses": {
          "200": {
            "$ref": "#/responses/adminCurrentSettingsResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/sync": {
      "post": {
        "tags": [
          "admin"
        ],
        "summary": "Returns a google sheet reference.",
        "operationId": "initializeSync",
        "responses": {
          "200": {
            "$ref": "#/responses/adminSyncSheetResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/sync/once/{id}": {
      "post": {
        "tags": [
          "admin"
        ],
        "summary": "Returns a google sheet reference.",
        "operationId": "runSyncOnce",
        "parameters": [
          {
            "type": "integer",
            "format": "int64",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/adminSyncOnceResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/sync/run": {
      "post": {
        "tags": [
          "admin"
        ],
        "summary": "Returns a google sheet reference.",
        "operationId": "runSync",
        "responses": {
          "200": {
            "$ref": "#/responses/adminSyncSheetResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/users": {
      "get": {
        "tags": [
          "admin"
        ],
        "summary": "Returns a paginated list of users.",
        "operationId": "users",
        "parameters": [
          {
            "type": "integer",
            "format": "int64",
            "name": "limit",
            "in": "query"
          },
          {
            "type": "integer",
            "format": "int64",
            "name": "cursor",
            "in": "query"
          },
          {
            "type": "string",
            "name": "filter",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/adminUsersResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/admin/users/{id}": {
      "get": {
        "tags": [
          "admin"
        ],
        "summary": "Returns a user and its group.",
        "operationId": "user",
        "parameters": [
          {
            "type": "integer",
            "format": "int64",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/adminUserResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/exchange/admin": {
      "post": {
        "tags": [
          "auth"
        ],
        "summary": "Exchanges a google authentication token with an admin api token.",
        "operationId": "exchangeAdmin",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/TokenPayload"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/tokenResponse"
          },
          "400": {
            "$ref": "#/responses/apiErrorResponse"
          },
          "401": {
            "$ref": "#/responses/apiErrorResponse"
          },
          "403": {
            "$ref": "#/responses/apiErrorResponse"
          },
          "422": {
            "$ref": "#/responses/apiErrorResponse"
          },
          "500": {
            "$ref": "#/responses/apiErrorResponse"
          }
        }
      }
    },
    "/api/v1/exchange/facebook": {
      "post": {
        "tags": [
          "auth"
        ],
        "summary": "Exchanges a facebook authentication token with an api token.",
        "operationId": "exchangeFacebook",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/TokenPayload"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/tokenResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/exchange/google": {
      "post": {
        "tags": [
          "auth"
        ],
        "summary": "Exchanges a google authentication token with an api token.",
        "operationId": "exchangeGoogle",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/TokenPayload"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/tokenResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/logout": {
      "delete": {
        "tags": [
          "user"
        ],
        "summary": "Log out of the user account.",
        "operationId": "logout",
        "responses": {
          "200": {
            "$ref": "#/responses/tokenResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    },
    "/api/v1/profile": {
      "get": {
        "tags": [
          "user"
        ],
        "summary": "Returns the users profile.",
        "operationId": "profile",
        "responses": {
          "200": {
            "$ref": "#/responses/profileResponse"
          },
          "400": {
            "$ref": "#/responses/errorResponse"
          },
          "401": {
            "$ref": "#/responses/errorResponse"
          },
          "403": {
            "$ref": "#/responses/errorResponse"
          },
          "422": {
            "$ref": "#/responses/errorResponse"
          },
          "500": {
            "$ref": "#/responses/errorResponse"
          }
        }
      }
    }
  },
  "definitions": {
    "ErrorPayload": {
      "description": "ErrorPayload wraps errors in a well-defined api payload",
      "type": "object",
      "properties": {
        "error": {
          "type": "string"
        }
      }
    },
    "Group": {
      "type": "object",
      "title": "Group is an object representing the database table.",
      "properties": {
        "archived": {
          "type": "boolean"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "published": {
          "type": "boolean"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "zoomLink": {
          "type": "string"
        }
      }
    },
    "GroupResponsePayload": {
      "description": "GroupResponsePayload contains the queried group and its users",
      "type": "object",
      "properties": {
        "group": {
          "$ref": "#/definitions/Group"
        },
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/User"
          }
        }
      }
    },
    "GroupsResponsePayload": {
      "description": "GroupsResponsePayload contains paginated groups",
      "type": "object",
      "properties": {
        "groups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Group"
          }
        },
        "pagination": {
          "$ref": "#/definitions/Pagination"
        }
      }
    },
    "Pagination": {
      "description": "Pagination holds query data for pagination",
      "type": "object",
      "properties": {
        "cursor": {
          "type": "integer",
          "format": "int64"
        },
        "filter": {
          "type": "string"
        },
        "limit": {
          "type": "integer",
          "format": "int64"
        }
      }
    },
    "ProfileResponsePayload": {
      "description": "ProfileResponsePayload contains user profile information",
      "type": "object",
      "properties": {
        "user": {
          "$ref": "#/definitions/UserWithGroup"
        }
      }
    },
    "Setting": {
      "type": "object",
      "title": "Setting is an object representing the database table.",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "script": {
          "type": "string"
        },
        "sheet": {
          "type": "string"
        },
        "syncOnce": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "SheetResponsePayload": {
      "description": "SheetResponsePayload contains the synchronized Google sheet",
      "type": "object",
      "properties": {
        "sheet": {
          "type": "string"
        }
      }
    },
    "TokenPayload": {
      "description": "TokenPayload contain the body parameters for a token exchange",
      "type": "object",
      "properties": {
        "token": {
          "type": "string"
        }
      }
    },
    "User": {
      "type": "object",
      "title": "User is an object representing the database table.",
      "properties": {
        "blocked": {
          "type": "boolean"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "email": {
          "type": "string"
        },
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "UserResponsePayload": {
      "description": "UserResponsePayload contains the queried user",
      "type": "object",
      "properties": {
        "user": {
          "$ref": "#/definitions/UserWithGroup"
        }
      }
    },
    "UserWithGroup": {
      "description": "UserWithGroup is a User model with eagerly loaded group data",
      "type": "object",
      "properties": {
        "blocked": {
          "type": "boolean"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "email": {
          "type": "string"
        },
        "group": {
          "$ref": "#/definitions/Group"
        },
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "UsersResponsePayload": {
      "description": "UsersResponsePayload contains the paginated users",
      "type": "object",
      "properties": {
        "pagination": {
          "$ref": "#/definitions/Pagination"
        },
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/UserWithGroup"
          }
        }
      }
    }
  },
  "responses": {
    "adminCurrentSettingsResponse": {
      "description": "CurrentSettingsResponse returns a synchronized Google sheet",
      "schema": {
        "$ref": "#/definitions/Setting"
      }
    },
    "adminGroupResponse": {
      "description": "GroupResponse returns the queried zgroups",
      "schema": {
        "$ref": "#/definitions/GroupResponsePayload"
      }
    },
    "adminGroupsResponse": {
      "description": "GroupsResponse returns the queried groups",
      "schema": {
        "$ref": "#/definitions/GroupsResponsePayload"
      }
    },
    "adminSyncSheetResponse": {
      "description": "SheetResponse returns a synchronized Google sheet",
      "schema": {
        "$ref": "#/definitions/SheetResponsePayload"
      }
    },
    "adminUserResponse": {
      "description": "UserResponse returns the queried user",
      "schema": {
        "$ref": "#/definitions/UserResponsePayload"
      }
    },
    "adminUsersResponse": {
      "description": "UsersResponse returns the queried users",
      "schema": {
        "$ref": "#/definitions/UsersResponsePayload"
      }
    },
    "apiErrorResponse": {
      "description": "ErrorResponse returns an api error",
      "schema": {
        "$ref": "#/definitions/ErrorPayload"
      }
    },
    "profileResponse": {
      "description": "ProfileResponse returns the user profile information",
      "schema": {
        "$ref": "#/definitions/ProfileResponsePayload"
      }
    },
    "tokenResponse": {
      "description": "TokenResponse is a response after a token exchange",
      "schema": {
        "$ref": "#/definitions/TokenPayload"
      }
    }
  }
}