Skip to content

Commit ef06b18

Browse files
author
Automated
committed
OpenAPI spec update: Wed Feb 5 16:06:24 UTC 2025
1 parent 394f95f commit ef06b18

File tree

1 file changed

+337
-0
lines changed

1 file changed

+337
-0
lines changed

‎exoscale/openapi.json

Lines changed: 337 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3651,6 +3651,103 @@
36513651
"type"
36523652
]
36533653
},
3654+
"json-schema-valkey": {
3655+
"properties": {
3656+
"ssl": {
3657+
"default": true,
3658+
"title": "Require SSL to access Valkey",
3659+
"type": "boolean"
3660+
},
3661+
"lfu_log_factor": {
3662+
"default": 10,
3663+
"maximum": 100,
3664+
"minimum": 0,
3665+
"title": "Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies",
3666+
"type": "integer"
3667+
},
3668+
"maxmemory_policy": {
3669+
"default": "noeviction",
3670+
"enum": [
3671+
"allkeys-lfu",
3672+
"allkeys-lru",
3673+
"allkeys-random",
3674+
"noeviction",
3675+
"volatile-lfu",
3676+
"volatile-lru",
3677+
"volatile-random",
3678+
"volatile-ttl"
3679+
],
3680+
"nullable": true,
3681+
"title": "Valkey maxmemory-policy",
3682+
"type": "string"
3683+
},
3684+
"io_threads": {
3685+
"description": "Set Valkey IO thread count. Changing this will cause a restart of the Valkey service.",
3686+
"example": 1,
3687+
"maximum": 32,
3688+
"minimum": 1,
3689+
"title": "Valkey IO thread count",
3690+
"type": "integer"
3691+
},
3692+
"lfu_decay_time": {
3693+
"default": 1,
3694+
"maximum": 120,
3695+
"minimum": 1,
3696+
"title": "LFU maxmemory-policy counter decay time in minutes",
3697+
"type": "integer"
3698+
},
3699+
"pubsub_client_output_buffer_limit": {
3700+
"description": "Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.",
3701+
"example": 64,
3702+
"maximum": 512,
3703+
"minimum": 32,
3704+
"title": "Pub/sub client output buffer hard limit in MB",
3705+
"type": "integer"
3706+
},
3707+
"notify_keyspace_events": {
3708+
"default": "",
3709+
"maxLength": 32,
3710+
"pattern": "^[KEg\\$lshzxentdmA]*$",
3711+
"title": "Set notify-keyspace-events option",
3712+
"type": "string"
3713+
},
3714+
"persistence": {
3715+
"description": "When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.",
3716+
"enum": [
3717+
"off",
3718+
"rdb"
3719+
],
3720+
"title": "Valkey persistence",
3721+
"type": "string"
3722+
},
3723+
"timeout": {
3724+
"default": 300,
3725+
"maximum": 31536000,
3726+
"minimum": 0,
3727+
"title": "Valkey idle connection timeout in seconds",
3728+
"type": "integer"
3729+
},
3730+
"acl_channels_default": {
3731+
"description": "Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.",
3732+
"enum": [
3733+
"allchannels",
3734+
"resetchannels"
3735+
],
3736+
"title": "Default ACL for pub/sub channels used when Valkey user is created",
3737+
"type": "string"
3738+
},
3739+
"number_of_databases": {
3740+
"description": "Set number of Valkey databases. Changing this will cause a restart of the Valkey service.",
3741+
"example": 16,
3742+
"maximum": 128,
3743+
"minimum": 1,
3744+
"title": "Number of Valkey databases",
3745+
"type": "integer"
3746+
}
3747+
},
3748+
"title": "Valkey settings",
3749+
"type": "object"
3750+
},
36543751
"dbaas-endpoint-external-prometheus-output": {
36553752
"type": "object",
36563753
"properties": {
@@ -8166,6 +8263,246 @@
81668263
"type"
81678264
]
81688265
},
8266+
"dbaas-service-valkey": {
8267+
"type": "object",
8268+
"properties": {
8269+
"updated-at": {
8270+
"type": "string",
8271+
"format": "date-time",
8272+
"description": "Service last update timestamp (ISO 8601)"
8273+
},
8274+
"node-count": {
8275+
"type": "integer",
8276+
"format": "int64",
8277+
"minimum": 0,
8278+
"exclusiveMinimum": false,
8279+
"description": "Number of service nodes in the active plan"
8280+
},
8281+
"connection-info": {
8282+
"type": "object",
8283+
"properties": {
8284+
"uri": {
8285+
"type": "array",
8286+
"items": {
8287+
"type": "string"
8288+
}
8289+
},
8290+
"password": {
8291+
"type": "string"
8292+
},
8293+
"slave": {
8294+
"type": "array",
8295+
"items": {
8296+
"type": "string"
8297+
}
8298+
}
8299+
},
8300+
"description": "Valkey connection information properties"
8301+
},
8302+
"node-cpu-count": {
8303+
"type": "integer",
8304+
"format": "int64",
8305+
"minimum": 0,
8306+
"exclusiveMinimum": false,
8307+
"description": "Number of CPUs for each node"
8308+
},
8309+
"integrations": {
8310+
"type": "array",
8311+
"items": {
8312+
"$ref": "#/components/schemas/dbaas-integration"
8313+
},
8314+
"description": "Service integrations"
8315+
},
8316+
"zone": {
8317+
"type": "string",
8318+
"description": "The zone where the service is running"
8319+
},
8320+
"node-states": {
8321+
"type": "array",
8322+
"items": {
8323+
"$ref": "#/components/schemas/dbaas-node-state"
8324+
},
8325+
"description": "State of individual service nodes"
8326+
},
8327+
"name": {
8328+
"$ref": "#/components/schemas/dbaas-service-name",
8329+
"description": "Service name"
8330+
},
8331+
"type": {
8332+
"$ref": "#/components/schemas/dbaas-service-type-name",
8333+
"description": "Service type code"
8334+
},
8335+
"state": {
8336+
"$ref": "#/components/schemas/enum-service-state",
8337+
"description": "State of the service"
8338+
},
8339+
"valkey-settings": {
8340+
"$ref": "#/components/schemas/json-schema-valkey",
8341+
"description": "Valkey-specific settings"
8342+
},
8343+
"ip-filter": {
8344+
"type": "array",
8345+
"items": {
8346+
"type": "string"
8347+
},
8348+
"description": "Allowed CIDR address blocks for incoming connections"
8349+
},
8350+
"backups": {
8351+
"type": "array",
8352+
"items": {
8353+
"$ref": "#/components/schemas/dbaas-service-backup"
8354+
},
8355+
"description": "List of backups for the service"
8356+
},
8357+
"termination-protection": {
8358+
"type": "boolean",
8359+
"description": "Service is protected against termination and powering off"
8360+
},
8361+
"notifications": {
8362+
"type": "array",
8363+
"items": {
8364+
"$ref": "#/components/schemas/dbaas-service-notification"
8365+
},
8366+
"description": "Service notifications"
8367+
},
8368+
"components": {
8369+
"type": "array",
8370+
"items": {
8371+
"type": "object",
8372+
"properties": {
8373+
"component": {
8374+
"type": "string",
8375+
"description": "Service component name"
8376+
},
8377+
"host": {
8378+
"type": "string",
8379+
"description": "DNS name for connecting to the service component"
8380+
},
8381+
"port": {
8382+
"type": "integer",
8383+
"format": "int64",
8384+
"minimum": 0,
8385+
"maximum": 65535,
8386+
"exclusiveMinimum": false,
8387+
"exclusiveMaximum": false,
8388+
"description": "Port number for connecting to the service component"
8389+
},
8390+
"route": {
8391+
"$ref": "#/components/schemas/enum-component-route",
8392+
"description": "Network access route"
8393+
},
8394+
"ssl": {
8395+
"type": "boolean",
8396+
"description": "Whether the endpoint is encrypted or accepts plaintext.\n By default endpoints are always encrypted and\n this property is only included for service components that may disable encryption."
8397+
},
8398+
"usage": {
8399+
"$ref": "#/components/schemas/enum-component-usage",
8400+
"description": "DNS usage name"
8401+
}
8402+
},
8403+
"required": [
8404+
"component",
8405+
"host",
8406+
"port",
8407+
"route",
8408+
"usage"
8409+
]
8410+
},
8411+
"description": "Service component information objects"
8412+
},
8413+
"maintenance": {
8414+
"$ref": "#/components/schemas/dbaas-service-maintenance",
8415+
"description": "Automatic maintenance settings"
8416+
},
8417+
"disk-size": {
8418+
"type": "integer",
8419+
"format": "int64",
8420+
"minimum": 0,
8421+
"exclusiveMinimum": false,
8422+
"description": "TODO UNIT disk space for data storage"
8423+
},
8424+
"node-memory": {
8425+
"type": "integer",
8426+
"format": "int64",
8427+
"minimum": 0,
8428+
"exclusiveMinimum": false,
8429+
"description": "TODO UNIT of memory for each node"
8430+
},
8431+
"uri": {
8432+
"type": "string",
8433+
"description": "URI for connecting to the service (may be absent)"
8434+
},
8435+
"uri-params": {
8436+
"type": "object",
8437+
"description": "service_uri parameterized into key-value pairs"
8438+
},
8439+
"version": {
8440+
"type": "string",
8441+
"description": "Valkey version"
8442+
},
8443+
"created-at": {
8444+
"type": "string",
8445+
"format": "date-time",
8446+
"description": "Service creation timestamp (ISO 8601)"
8447+
},
8448+
"plan": {
8449+
"type": "string",
8450+
"description": "Subscription plan"
8451+
},
8452+
"users": {
8453+
"type": "array",
8454+
"items": {
8455+
"type": "object",
8456+
"properties": {
8457+
"type": {
8458+
"type": "string"
8459+
},
8460+
"username": {
8461+
"type": "string"
8462+
},
8463+
"password": {
8464+
"type": "string"
8465+
},
8466+
"access-control": {
8467+
"type": "object",
8468+
"properties": {
8469+
"categories": {
8470+
"type": "array",
8471+
"items": {
8472+
"type": "string"
8473+
}
8474+
},
8475+
"channels": {
8476+
"type": "array",
8477+
"items": {
8478+
"type": "string"
8479+
}
8480+
},
8481+
"commands": {
8482+
"type": "array",
8483+
"items": {
8484+
"type": "string"
8485+
}
8486+
},
8487+
"keys": {
8488+
"type": "array",
8489+
"items": {
8490+
"type": "string"
8491+
}
8492+
}
8493+
}
8494+
}
8495+
}
8496+
},
8497+
"description": "List of service users"
8498+
}
8499+
},
8500+
"required": [
8501+
"name",
8502+
"plan",
8503+
"type"
8504+
]
8505+
},
81698506
"json-schema-timescaledb": {
81708507
"description": "System-wide settings for the timescaledb extension",
81718508
"properties": {

0 commit comments

Comments
 (0)