Speakeasy · Schema

UsageSnippet

AIDocumentationMCPPlatformSDKsTerraformTesting

Properties

Name Type Description
path string The path of the operation
method object The HTTP method of the operation
operationId string The operation ID for the snippet
language string The language of the snippet
code string The code snippet
View JSON Schema on GitHub

JSON Schema

speakeasy-usagesnippet-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UsageSnippet",
  "title": "UsageSnippet",
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The path of the operation"
    },
    "method": {
      "description": "The HTTP method of the operation"
    },
    "operationId": {
      "type": "string",
      "description": "The operation ID for the snippet"
    },
    "language": {
      "type": "string",
      "description": "The language of the snippet"
    },
    "code": {
      "type": "string",
      "description": "The code snippet"
    }
  },
  "required": [
    "path",
    "method",
    "operationId",
    "language",
    "code"
  ]
}