API ReferenceSchemas

Update schema

PUT
/api/v1/schemas/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.

In: header

Path Parameters

id*string

Schema ID

Request Body

application/json

category?string

Schema category

description?string

Schema description

name?string

Schema name

schema_yaml?string

YAML schema content

tags?|null

Schema tags

visibility?string

Schema visibility

Value in"private" | "public"
[key: string]?never

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:8080/api/v1/schemas/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "category": "string",
  "created_at": "string",
  "description": "string",
  "id": "string",
  "is_platform": true,
  "name": "string",
  "organization_id": "string",
  "schema_yaml": "string",
  "tags": [
    "string"
  ],
  "updated_at": "string",
  "usage_count": 0,
  "user_id": "string",
  "visibility": "string"
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}