Skip to content

OpenAPI drift: 32 gaps between live spec and library #1482

Open

Description

@sdairs

Opened manually: this is drift that appeared after the #1466 snapshot (remediated by #1476, #1477, #1478). These findings are measured against the snapshot on top of #1478.

The live ClickHouse Cloud OpenAPI spec has drifted from the Rust API library.
The comparison was produced by the shared syn-based analyzer.

  • Live spec: https://api.clickhouse.cloud/v1
  • Client: crates/clickhouse-cloud-api/src/client.rs
  • Models: crates/clickhouse-cloud-api/src/models.rs
  • Analyzer: crates/clickhouse-openapi-analyzer

Summary

Change Count
Missing client methods 4
Extra client methods 0
Permission and operation metadata changes 5
Missing operation parameters 2
Operation parameter mismatches 0
Incompatible response shapes 0
Incompatible request shapes and bodies 0
Unsupported success response schemas 0
Missing model types 5
Missing schema definitions 0
Missing struct fields 0
Extra struct fields 0
Missing enum values 0
Extra enum values 0
Enum VALUES const mismatches 0
Additional properties mismatches 0
Field optionality mismatches 0
Beta status changes 4
Deprecated-field changes 0
Stale snapshot changes 12
Stale exemptions 0
New unsupported enum constraints 0
Changed acknowledged enum constraints 0
Acknowledged unsupported enum constraints 3

Missing Client Methods

postgres_private_endpoint_delete

DELETE /v1/organizations/{organizationId}/postgres/{postgresId}/privateEndpoint

Delete the PostgreSQL private endpoint

Operation spec JSON
{
  "summary": "Delete the PostgreSQL private endpoint",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Deletes the AWS private endpoint service of a Postgres service. Connections through approved VPC endpoints stop working. Private endpoints are available only for AWS Postgres services, and only for organizations with the feature enabled.",
  "operationId": "postgresPrivateEndpointDelete",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the organization that owns the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "postgresId",
      "description": "ID of the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:postgres-service:manage"
      ]
    }
  ],
  "tags": [
    "Postgres"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

postgres_private_endpoint_get

GET /v1/organizations/{organizationId}/postgres/{postgresId}/privateEndpoint

Get the PostgreSQL private endpoint

Operation spec JSON
{
  "summary": "Get the PostgreSQL private endpoint",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Returns the AWS private endpoint service of a Postgres service, or 404 if it has not been created. Private endpoints are available only for AWS Postgres services, and only for organizations with the feature enabled.",
  "operationId": "postgresPrivateEndpointGet",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the organization that owns the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "postgresId",
      "description": "ID of the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/PostgresPrivateEndpoint"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:postgres-service:view"
      ]
    }
  ],
  "tags": [
    "Postgres"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

postgres_private_endpoint_patch

PATCH /v1/organizations/{organizationId}/postgres/{postgresId}/privateEndpoint

Update the PostgreSQL private endpoint

Operation spec JSON
{
  "summary": "Update the PostgreSQL private endpoint",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Approves VPC endpoints by ID and sets the supported regions. At least one of `allowedVpcEndpoints` and `supportedRegions` is required, and each one provided replaces the existing list in full, so include every entry to keep. Private endpoints are available only for AWS Postgres services, and only for organizations with the feature enabled.",
  "operationId": "postgresPrivateEndpointPatch",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the organization that owns the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "postgresId",
      "description": "ID of the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PostgresPrivateEndpointPatchRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/PostgresPrivateEndpoint"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:postgres-service:manage"
      ]
    }
  ],
  "tags": [
    "Postgres"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

postgres_private_endpoint_post

POST /v1/organizations/{organizationId}/postgres/{postgresId}/privateEndpoint

Create the PostgreSQL private endpoint

Operation spec JSON
{
  "summary": "Create the PostgreSQL private endpoint",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Creates the AWS private endpoint service of a Postgres service. Creation takes about 5 to 10 minutes: `state` is `creating` until the service is `available`. A VPC endpoint can connect only after its ID is approved with the update endpoint. Private endpoints are available only for AWS Postgres services, and only for organizations with the feature enabled.",
  "operationId": "postgresPrivateEndpointPost",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the organization that owns the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "postgresId",
      "description": "ID of the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PostgresPrivateEndpointPostRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/PostgresPrivateEndpoint"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:postgres-service:manage"
      ]
    }
  ],
  "tags": [
    "Postgres"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

Missing Operation Descriptors

  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/delete/security — postgresPrivateEndpointDelete has no public operation descriptor
    • Operation: postgresPrivateEndpointDelete
    • Rust metadata: meta::operations::POSTGRES_PRIVATE_ENDPOINT_DELETE
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/get/security — postgresPrivateEndpointGet has no public operation descriptor
    • Operation: postgresPrivateEndpointGet
    • Rust metadata: meta::operations::POSTGRES_PRIVATE_ENDPOINT_GET
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/patch/security — postgresPrivateEndpointPatch has no public operation descriptor
    • Operation: postgresPrivateEndpointPatch
    • Rust metadata: meta::operations::POSTGRES_PRIVATE_ENDPOINT_PATCH
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/post/security — postgresPrivateEndpointPost has no public operation descriptor
    • Operation: postgresPrivateEndpointPost
    • Rust metadata: meta::operations::POSTGRES_PRIVATE_ENDPOINT_POST

Operation Catalog Mismatches

  • meta::operations::ALL — ALL must contain each spec operation descriptor exactly once, sorted by operation ID
    • Rust metadata: meta::operations::ALL

Missing Operation Parameters

  • /paths/~1v1~1organizations~1{organizationId}~1roles/get/parameters/2 — organization_roles_get_list has no argument for query parameter cursor
  • /paths/~1v1~1organizations~1{organizationId}~1roles/get/parameters/1 — organization_roles_get_list has no argument for query parameter limit

Changed Operation Response Contracts

  • /paths/~1v1~1organizations~1{organizationId}~1roles/get/responses/200/content/application~1json/schema — organization_roles_get_list JSON success response 200 differs from the snapshot
    • Snapshot contract: {"properties":{"requestId":{"format":"uuid","type":"string"},"result":{"items":{"properties":{"actors":{"items":{"type":"string"},"type":"array"},"createdAt":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"ownerId":{"type":"string"},"policies":{"items":{"properties":{"allowDeny":{"enum":["ALLOW","DENY"],"type":"string"},"id":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"},"resources":{"items":{"type":"string"},"type":"array"},"roleId":{"type":"string"},"tags":{"properties":{"grants":{"items":{"type":"string"},"type":"array"},"roleV2":{"enum":["sql-console-admin","sql-console-readonly"],"type":"string"}}},"tenantId":{"type":"string"}}},"type":"array"},"tenantId":{"type":"string"},"type":{"enum":["custom","system"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}}},"type":"array"},"status":{"type":"number"}},"type":"object"}
    • Live contract: {"properties":{"limit":{"type":"integer"},"nextCursor":{"type":["null","string"]},"requestId":{"format":"uuid","type":"string"},"result":{"items":{"properties":{"actors":{"items":{"type":"string"},"type":"array"},"createdAt":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"ownerId":{"type":"string"},"policies":{"items":{"properties":{"allowDeny":{"enum":["ALLOW","DENY"],"type":"string"},"id":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"},"resources":{"items":{"type":"string"},"type":"array"},"roleId":{"type":"string"},"tags":{"properties":{"grants":{"items":{"type":"string"},"type":"array"},"roleV2":{"enum":["sql-console-admin","sql-console-readonly"],"type":"string"}}},"tenantId":{"type":"string"}}},"type":"array"},"tenantId":{"type":"string"},"type":{"enum":["custom","system"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}}},"type":"array"},"status":{"type":"number"}},"type":"object"}
    • Snapshot location: /paths/~1v1~1organizations~1{organizationId}~1roles/get/responses/200/content/application~1json/schema

New Operation Parameters Missing From Snapshot

  • /paths/~1v1~1organizations~1{organizationId}~1roles/get/parameters/2 — organization_roles_get_list query parameter cursor differs from the snapshot
    • Live contract: {"in":"query","name":"cursor","required":false,"schema":{"type":"string"}}
  • /paths/~1v1~1organizations~1{organizationId}~1roles/get/parameters/1 — organization_roles_get_list query parameter limit differs from the snapshot
    • Live contract: {"in":"query","name":"limit","required":false,"schema":{"default":250,"minimum":1,"type":"integer"}}

Newly Beta Operations

  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/delete — postgres_private_endpoint_delete is Beta in the spec but absent from BETA_OPERATIONS
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/get — postgres_private_endpoint_get is Beta in the spec but absent from BETA_OPERATIONS
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/patch — postgres_private_endpoint_patch is Beta in the spec but absent from BETA_OPERATIONS
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/post — postgres_private_endpoint_post is Beta in the spec but absent from BETA_OPERATIONS

New Operations Missing From Snapshot

  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/delete — operation postgres_private_endpoint_delete is present in the target spec but absent from the snapshot
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/get — operation postgres_private_endpoint_get is present in the target spec but absent from the snapshot
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/patch — operation postgres_private_endpoint_patch is present in the target spec but absent from the snapshot
  • /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1privateEndpoint/post — operation postgres_private_endpoint_post is present in the target spec but absent from the snapshot

New Schemas Missing From Snapshot

  • /components/schemas/PostgresPrivateEndpoint — schema PostgresPrivateEndpoint is present in the target spec but absent from the snapshot
  • /components/schemas/PostgresPrivateEndpointPatchRequest — schema PostgresPrivateEndpointPatchRequest is present in the target spec but absent from the snapshot
  • /components/schemas/PostgresPrivateEndpointPort — schema PostgresPrivateEndpointPort is present in the target spec but absent from the snapshot
  • /components/schemas/PostgresPrivateEndpointPostRequest — schema PostgresPrivateEndpointPostRequest is present in the target spec but absent from the snapshot
  • /components/schemas/PostgresPrivateEndpointVpcEndpoint — schema PostgresPrivateEndpointVpcEndpoint is present in the target spec but absent from the snapshot

Missing Model Types

PostgresPrivateEndpoint (spec: PostgresPrivateEndpoint)

Schema JSON
{
  "properties": {
    "id": {
      "description": "ID of the private endpoint service.",
      "type": "string",
      "example": "ps0123456789abcdefghjkmnpq"
    },
    "state": {
      "description": "State of the private endpoint service: one of 'creating', 'available', 'deleting'. More states may be added. It is `creating` for about 5 to 10 minutes after creation, then `available`.",
      "type": "string",
      "example": "available"
    },
    "endpointServiceName": {
      "description": "Name of the AWS endpoint service. Use it as the service name when creating a VPC endpoint. Omitted until the service is created.",
      "type": "string",
      "example": "com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0"
    },
    "endpointServiceId": {
      "description": "ID of the AWS endpoint service. Omitted until the service is created.",
      "type": "string",
      "example": "vpce-svc-0123456789abcdef0"
    },
    "privateHostname": {
      "description": "Hostname that resolves to the Postgres service from an approved VPC endpoint. Omitted until the service is available.",
      "type": "string"
    },
    "privateDnsName": {
      "description": "Private DNS name of the endpoint service. Omitted until it is assigned.",
      "type": "string"
    },
    "privateDnsVerificationState": {
      "description": "Verification state of the private DNS name. Omitted until it is assigned.",
      "type": "string"
    },
    "ipAddressType": {
      "description": "IP address type of the endpoint service.",
      "type": "string",
      "example": "dual"
    },
    "ports": {
      "type": "array",
      "description": "Ports the endpoint service forwards.",
      "items": {
        "$ref": "#/components/schemas/PostgresPrivateEndpointPort"
      }
    },
    "supportedRegions": {
      "type": "array",
      "description": "AWS region IDs, other than the service region, from which VPC endpoints can connect, such as `us-west-2`. Requires cross-region private endpoints to be enabled for the organization.",
      "items": {
        "type": "string"
      },
      "example": [
        "us-west-2"
      ]
    },
    "allowedVpcEndpoints": {
      "type": "array",
      "description": "VPC endpoints approved to connect.",
      "items": {
        "$ref": "#/components/schemas/PostgresPrivateEndpointVpcEndpoint"
      }
    }
  },
  "required": [
    "id",
    "state",
    "ipAddressType",
    "ports",
    "supportedRegions",
    "allowedVpcEndpoints"
  ]
}

PostgresPrivateEndpointPatchRequest (spec: PostgresPrivateEndpointPatchRequest)

Schema JSON
{
  "properties": {
    "allowedVpcEndpoints": {
      "type": "array",
      "description": "Full replacement of the approved VPC endpoints: endpoints not listed are no longer allowed to connect. Each endpoint ID must be unique.",
      "items": {
        "$ref": "#/components/schemas/PostgresPrivateEndpointVpcEndpoint"
      },
      "example": [
        {
          "vpcEndpointId": "vpce-0123456789abcdef0",
          "description": "Production VPC"
        }
      ],
      "maxItems": 50
    },
    "supportedRegions": {
      "type": "array",
      "description": "Full replacement of the supported regions. AWS region IDs, other than the service region, from which VPC endpoints can connect, such as `us-west-2`. Requires cross-region private endpoints to be enabled for the organization.",
      "items": {
        "type": "string"
      },
      "example": [
        "us-west-2"
      ],
      "uniqueItems": true
    }
  }
}

PostgresPrivateEndpointPort (spec: PostgresPrivateEndpointPort)

Schema JSON
{
  "properties": {
    "port": {
      "description": "Port exposed by the endpoint service.",
      "type": "integer",
      "example": 5432
    },
    "targetPort": {
      "description": "Port on the Postgres service it forwards to.",
      "type": "integer",
      "example": 5432
    }
  },
  "required": [
    "port",
    "targetPort"
  ]
}

PostgresPrivateEndpointPostRequest (spec: PostgresPrivateEndpointPostRequest)

Schema JSON
{
  "properties": {
    "supportedRegions": {
      "type": "array",
      "description": "AWS region IDs, other than the service region, from which VPC endpoints can connect, such as `us-west-2`. Requires cross-region private endpoints to be enabled for the organization.",
      "items": {
        "type": "string"
      },
      "example": [
        "us-west-2"
      ],
      "uniqueItems": true
    }
  }
}

PostgresPrivateEndpointVpcEndpoint (spec: PostgresPrivateEndpointVpcEndpoint)

Schema JSON
{
  "properties": {
    "vpcEndpointId": {
      "description": "ID of the AWS VPC endpoint that is allowed to connect.",
      "type": "string",
      "example": "vpce-0123456789abcdef0",
      "pattern": "^vpce-[0-9a-f]{17}$"
    },
    "description": {
      "description": "Optional description of the VPC endpoint.",
      "type": "string",
      "example": "Production VPC",
      "maxLength": 255
    }
  },
  "required": [
    "vpcEndpointId"
  ]
}

Acknowledged Unsupported Enum Constraints

These locations are inventoried but cannot yet be compared to a typed Rust value enum.
Acknowledgments cover the snapshot's enum values; changed values and new or stale locations count as drift.

  • /components/schemas/ApiKey/properties/roles/items (models.rs::ApiKey::roles) — Rust type String is not an enum
  • /components/schemas/ApiKeyPatchRequest/properties/roles/items (models.rs::ApiKeyPatchRequest::roles) — Rust type String is not an enum
  • /components/schemas/ApiKeyPostRequest/properties/roles/items (models.rs::ApiKeyPostRequest::roles) — Rust type String is not an enum

Implementation Guide

Follow the openapi-drift-remediation skill (.agents/skills/openapi-drift-remediation/SKILL.md).

Activity

  1. added
    openapi-driftAutomated: live OpenAPI spec differs from the Rust library
    on Nov 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    openapi-driftAutomated: live OpenAPI spec differs from the Rust library

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions