APIs.io Engineering Platform · Schema

api-shield_endpoint

The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.

APIs.ioEngineeringPlatform

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api-shield_endpoint",
  "title": "api-shield_endpoint",
  "description": "The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.",
  "example": "/api/v1/users/{var1}",
  "format": "uri-template",
  "maxLength": 4096,
  "pattern": "^/.*$",
  "type": "string"
}