---
title: "BaseCapabilityEnvelope"
url: "https://nov18-dev.movespot.fyi/apis/gateway-admin-signals-dev-0/versions/e2254c09-056a-40a6-96db-b4f4a9e798b8/schemas/BaseCapabilityEnvelope"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/gateway-admin-signals-dev-0/versions/e2254c09-056a-40a6-96db-b4f4a9e798b8.md

# BaseCapabilityEnvelope

Base envelope for all capability signals. Contains fields common to all capability signals.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Gateway Admin Signals
  version: 0.1.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    CapabilityOffset:
      description: Capability-defined monotonic offset.
      type: string
      format: offset
      x-rust-type: String
    BaseCapabilityEnvelope:
      description: |
        Base envelope for all capability signals.
        Contains fields common to all capability signals.
      type: object
      properties:
        type:
          description: The signal type identifier.
          type: string
        version:
          description: The capability schema version for this signal type.
          type: string
        offset:
          $ref: "#/components/schemas/CapabilityOffset"
        correlation_id:
          description: Optional correlation id for tracing/debugging.
          type: string
        parameters:
          description: Optional map of additional parameters for future use.
          additionalProperties: true
          type: object
      required:
        - type
        - version
        - offset
```
