A continuation of netlify_openapi_swagger.json. The complete source identity, every recorded occurrence, and linked equations are on its first page.
Source transcript · continued
Download complete source text ↓24,715 lines · 705.9 KB
},
"functionConfig": {
"type": "object",
"properties": {
"display_name": {
"type": "string"
},
"generator": {
"type": "string"
},
"build_data": {
"type": "object"
},
"memory": {
"type": "integer",
"description": "The function's memory allocation in MB. Mutually exclusive with `vcpu`.\n"
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string"
},
"literal": {
"type": "string"
},
"expression": {
"type": "string"
},
"methods": {
"type": "array",
"items": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS"
]
}
},
"prefer_static": {
"type": "boolean"
}
}
}
},
"excluded_routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string"
},
"literal": {
"type": "string"
},
"expression": {
"type": "string"
}
}
}
},
"priority": {
"type": "integer"
},
"region": {
"type": "string"
},
"traffic_rules": {
"type": "object",
"properties": {
"action": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"config": {
"type": "object",
"properties": {
"to": {
"type": "string"
},
"rate_limit_config": {
"type": "object",
"properties": {
"algorithm": {
"type": "string",
"enum": [
"sliding_window"
]
},
"window_size": {
"type": "integer"
},
"window_limit": {
"type": "integer"
}
}
},
"aggregate": {
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ip",
"domain"
]
}
}
}
}
}
}
}
}
}
}
}
},
"vcpu": {
"type": "number",
"format": "float",
"description": "Number of vCPUs to provision for the function. Allowed range is\n0.5–2.\n"
},
"event_subscriptions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"functionRoute": {
"type": "object",
"properties": {
"pattern": {
"type": "string"
},
"literal": {
"type": "string"
},
"expression": {
"type": "string"
},
"methods": {
"type": "array",
"items": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS"
]
}
},
"prefer_static": {
"type": "boolean"
}
}
},
"excludedFunctionRoute": {
"type": "object",
"properties": {
"pattern": {
"type": "string"
},
"literal": {
"type": "string"
},
"expression": {
"type": "string"
}
}
},
"trafficRulesConfig": {
"type": "object",
"properties": {
"action": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"config": {
"type": "object",
"properties": {
"to": {
"type": "string"
},
"rate_limit_config": {
"type": "object",
"properties": {
"algorithm": {
"type": "string",
"enum": [
"sliding_window"
]
},
"window_size": {
"type": "integer"
},
"window_limit": {
"type": "integer"
}
}
},
"aggregate": {
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ip",
"domain"
]
}
}
}
}
}
}
}
}
}
}
}
},
"trafficRulesRateLimitConfig": {
"type": "object",
"properties": {
"algorithm": {
"type": "string",
"enum": [
"sliding_window"
]
},
"window_size": {
"type": "integer"
},
"window_limit": {
"type": "integer"
}
}
},
"trafficRulesAggregateConfig": {
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ip",
"domain"
]
}
}
}
}
}
},
"siteFunction": {
"type": "object",
"properties": {
"branch": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"functions": {
"type": "array",
"items": {
"type": "object"
}
},
"id": {
"type": "string"
},
"log_type": {
"type": "string"
},
"provider": {
"type": "string"
}
}
},
"devServer": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"state": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"starting_at": {
"type": "string",
"format": "dateTime"
},
"error_at": {
"type": "string",
"format": "dateTime"
},
"live_at": {
"type": "string",
"format": "dateTime"
},
"done_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
}
}
},
"devServerHook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"site_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"type": {
"type": "string",
"enum": [
"new_dev_server",
"content_refresh"
]
}
}
},
"devServerHookSetup": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"new_dev_server",
"content_refresh"
]
}
}
},
"providerDefinition": {
"type": "object",
"properties": {
"token_env_var": {
"type": "string"
},
"url_env_var": {
"type": "string"
},
"models": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"aiGatewayToken": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "The AI Gateway authentication token"
},
"url": {
"type": "string",
"description": "AI gateway base url"
},
"expires_at": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp when the token expires"
}
}
}
},
"parameters": {
"page": {
"type": "integer",
"format": "int32",
"name": "page",
"required": false,
"in": "query"
},
"perPage": {
"type": "integer",
"format": "int32",
"name": "per_page",
"required": false,
"in": "query"
},
"retryCount": {
"name": "X-Nf-Retry-Count",
"type": "integer",
"in": "header"
}
},
"x-tagGroups": [
{
"name": "OAuth",
"tags": [
"ticket",
"accessToken"
]
},
{
"name": "User accounts",
"tags": [
"user",
"accountMembership",
"member",
"accountType",
"paymentMethod",
"auditLog"
]
},
{
"name": "Site",
"tags": [
"site",
"environmentVariables",
"file",
"metadata",
"purge",
"snippet"
]
},
{
"name": "Domain names",
"tags": [
"dnsZone",
"sniCertificate"
]
},
{
"name": "Deploys",
"tags": [
"deploy",
"deployedBranch",
"deployKey"
]
},
{
"name": "Builds",
"tags": [
"build",
"buildLogMsg"
]
},
{
"name": "Dev servers",
"tags": [
"devServer"
]
},
{
"name": "Webhooks and notifications",
"tags": [
"hook",
"hookType",
"buildHook",
"devServerHook"
]
},
{
"name": "Services",
"tags": [
"service",
"serviceInstance"
]
},
{
"name": "Functions",
"tags": [
"function"
]
},
{
"name": "Database",
"tags": [
"database"
]
},
{
"name": "Forms",
"tags": [
"form",
"submission"
]
},
{
"name": "Split tests",
"tags": [
"splitTest"
]
},
{
"name": "Large media",
"tags": [
"asset",
"assetPublicSignature"
]
}
],
"tags": [
{
"name": "ticket",
"x-displayName": "Ticket"
},
{
"name": "accessToken",
"x-displayName": "Access token"
},
{
"name": "user",
"x-displayName": "User"
},
{
"name": "accountMembership",
"x-displayName": "Accounts"
},
{
"name": "member",
"x-displayName": "Member"
},
{
"name": "accountType",
"x-displayName": "Access type"
},
{
"name": "paymentMethod",
"x-displayName": "Payment method"
},
{
"name": "auditLog",
"x-displayName": "Audit log"
},
{
"name": "site",
"x-displayName": "Site"
},
{
"name": "environmentVariables",
"x-displayName": "Environment variables"
},
{
"name": "file",
"x-displayName": "File"
},
{
"name": "metadata",
"x-displayName": "Metadata"
},
{
"name": "snippet",
"x-displayName": "Snippet"
},
{
"name": "purge",
"x-displayName": "Cache purge"
},
{
"name": "dnsZone",
"x-displayName": "DNS zone"
},
{
"name": "sniCertificate",
"x-displayName": "SNI certificate"
},
{
"name": "deploy",
"x-displayName": "Deploy"
},
{
"name": "deployedBranch",
"x-displayName": "Deployed branch"
},
{
"name": "deployKey",
"x-displayName": "Deploy key"
},
{
"name": "build",
"x-displayName": "Build"
},
{
"name": "buildLogMsg",
"x-displayName": "Build log message"
},
{
"name": "hook",
"x-displayName": "Hook"
},
{
"name": "hookType",
"x-displayName": "Hook type"
},
{
"name": "buildHook",
"x-displayName": "Build hook"
},
{
"name": "service",
"x-displayName": "Service"
},
{
"name": "serviceInstance",
"x-displayName": "Service instance"
},
{
"name": "function",
"x-displayName": "Function"
},
{
"name": "form",
"x-displayName": "Form"
},
{
"name": "submission",
"x-displayName": "Form submission"
},
{
"name": "splitTest",
"x-displayName": "Split test"
},
{
"name": "asset",
"x-displayName": "Asset"
},
{
"name": "assetPublicSignature",
"x-displayName": "Asset public signature"
},
{
"name": "devServer",
"x-displayName": "Dev server"
},
{
"name": "devServerHook",
"x-displayName": "Dev server hook"
},
{
"name": "database",
"x-displayName": "Database"
}
]
}