Password

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Password",
  "title": "Password",
  "type": "object",
  "description": "A connection password for a database branch.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the password."
    },
    "name": {
      "type": "string",
      "description": "The descriptive name of the password."
    },
    "role": {
      "type": "string",
      "description": "The access role for the password.",
      "enum": [
        "admin",
        "reader",
        "writer",
        "readwriter"
      ]
    },
    "hostname": {
      "type": "string",
      "description": "The hostname for connecting with this password."
    },
    "username": {
      "type": "string",
      "description": "The username for connecting with this password."
    },
    "database_branch": {
      "type": "string",
      "description": "The branch this password is associated with."
    },
    "region": {
      "type": "object",
      "description": "The region for the connection.",
      "properties": {
        "slug": {
          "type": "string",
          "description": "The region slug."
        },
        "display_name": {
          "type": "string",
          "description": "The region display name."
        }
      }
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the password expires. Null if no expiration."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the password was created."
    },
    "renewable": {
      "type": "boolean",
      "description": "Whether the password can be renewed."
    }
  }
}