envelope

Generated reference page for spec/v1/schemas/common/envelope.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/common/envelope.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/common/envelope.json
• Defs: 1
• Properties: 0
• Required: 0

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/common/envelope.json",
  "$defs": {
    "successEnvelope": {
      "type": "object",
      "required": ["code", "message"],
      "properties": {
        "code": {
          "type": "integer",
          "const": 0
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "data": true
      }
    }
  }
}