@elastic/schemas 0.7.0 → 0.7.2

package/lib/serverless/json/create_elasticsearch_project.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "createElasticsearchProject", "x-api": { "id": "elasticsearch-projects.create-elasticsearch-project", "name": "create-elasticsearch-project", "namespace": "elasticsearch-projects" }, "x-method": "POST", "x-path": "/api/v1/serverless/projects/elasticsearch", "x-destructive": true, "type": "object", "properties": { "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "region_id": { "type": "string", "x-found-in": "body" }, "optimized_for": { "enum": ["general_purpose", "vector"], "x-found-in": "body" }, "search_lake": { "type": "object", "properties": { "search_power": { "type": "number" }, "boost_window": { "type": "number" } }, "x-found-in": "body" }, "traffic_filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "x-found-in": "body" }, "linked": { "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, "minProperties": 1 } }, "required": ["projects"], "additionalProperties": false, "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "maxProperties": 64, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["name", "region_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "createElasticsearchProject", "x-api": { "id": "elasticsearch-projects.create-elasticsearch-project", "name": "create-elasticsearch-project", "namespace": "elasticsearch-projects" }, "x-method": "POST", "x-path": "/api/v1/serverless/projects/elasticsearch", "x-destructive": true, "type": "object", "properties": { "exclude_credentials": { "type": "boolean", "description": "If true, the username and password fields in the response credentials are set to empty strings and no usable credentials are returned. Credentials can be retrieved later using the _reset-credentials endpoint.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "region_id": { "type": "string", "x-found-in": "body" }, "optimized_for": { "enum": ["general_purpose", "vector"], "x-found-in": "body" }, "search_lake": { "type": "object", "properties": { "search_power": { "type": "number" }, "boost_window": { "type": "number" } }, "x-found-in": "body" }, "traffic_filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "x-found-in": "body" }, "linked": { "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, "minProperties": 1 } }, "required": ["projects"], "additionalProperties": false, "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "maxProperties": 64, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["name", "region_id"] }

package/lib/serverless/json/create_observability_project.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "createObservabilityProject", "x-api": { "id": "observability-projects.create-observability-project", "name": "create-observability-project", "namespace": "observability-projects" }, "x-method": "POST", "x-path": "/api/v1/serverless/projects/observability", "x-destructive": true, "type": "object", "properties": { "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "region_id": { "type": "string", "x-found-in": "body" }, "traffic_filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "x-found-in": "body" }, "product_tier": { "enum": ["complete", "logs_essentials"], "x-found-in": "body" }, "linked": { "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, "minProperties": 1 } }, "required": ["projects"], "additionalProperties": false, "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "maxProperties": 64, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["name", "region_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "createObservabilityProject", "x-api": { "id": "observability-projects.create-observability-project", "name": "create-observability-project", "namespace": "observability-projects" }, "x-method": "POST", "x-path": "/api/v1/serverless/projects/observability", "x-destructive": true, "type": "object", "properties": { "exclude_credentials": { "type": "boolean", "description": "If true, the username and password fields in the response credentials are set to empty strings and no usable credentials are returned. Credentials can be retrieved later using the _reset-credentials endpoint.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "region_id": { "type": "string", "x-found-in": "body" }, "traffic_filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "x-found-in": "body" }, "product_tier": { "enum": ["complete", "logs_essentials"], "x-found-in": "body" }, "linked": { "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, "minProperties": 1 } }, "required": ["projects"], "additionalProperties": false, "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "maxProperties": 64, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["name", "region_id"] }

package/lib/serverless/json/create_security_project.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "createSecurityProject", "x-api": { "id": "security-projects.create-security-project", "name": "create-security-project", "namespace": "security-projects" }, "x-method": "POST", "x-path": "/api/v1/serverless/projects/security", "x-destructive": true, "type": "object", "properties": { "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "region_id": { "type": "string", "x-found-in": "body" }, "admin_features_package": { "enum": ["standard", "enterprise"], "x-found-in": "body" }, "product_types": { "type": "array", "items": { "type": "object", "properties": { "product_line": { "enum": ["security", "cloud", "endpoint"] }, "product_tier": { "enum": ["complete", "essentials"] } }, "required": ["product_line", "product_tier"] }, "x-found-in": "body" }, "search_lake": { "type": "object", "properties": { "data_retention": { "oneOf": [{ "type": "object", "properties": { "max_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] }, "default_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] } } }, { "type": "null" }] } }, "x-found-in": "body" }, "traffic_filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "x-found-in": "body" }, "linked": { "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, "minProperties": 1 } }, "required": ["projects"], "additionalProperties": false, "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "maxProperties": 64, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["name", "region_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "createSecurityProject", "x-api": { "id": "security-projects.create-security-project", "name": "create-security-project", "namespace": "security-projects" }, "x-method": "POST", "x-path": "/api/v1/serverless/projects/security", "x-destructive": true, "type": "object", "properties": { "exclude_credentials": { "type": "boolean", "description": "If true, the username and password fields in the response credentials are set to empty strings and no usable credentials are returned. Credentials can be retrieved later using the _reset-credentials endpoint.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "name": { "type": "string", "x-found-in": "body" }, "alias": { "type": "string", "x-found-in": "body" }, "region_id": { "type": "string", "x-found-in": "body" }, "admin_features_package": { "enum": ["standard", "enterprise"], "x-found-in": "body" }, "product_types": { "type": "array", "items": { "type": "object", "properties": { "product_line": { "enum": ["security", "cloud", "endpoint"] }, "product_tier": { "enum": ["complete", "essentials"] } }, "required": ["product_line", "product_tier"] }, "x-found-in": "body" }, "search_lake": { "type": "object", "properties": { "data_retention": { "oneOf": [{ "type": "object", "properties": { "max_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] }, "default_retention_days": { "oneOf": [{ "type": "number" }, { "type": "null" }] } } }, { "type": "null" }] } }, "x-found-in": "body" }, "traffic_filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": ["id"] }, "x-found-in": "body" }, "linked": { "type": "object", "properties": { "projects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "type": { "enum": ["elasticsearch", "observability", "security", "vectordb"] } }, "required": ["type"], "additionalProperties": false }, "minProperties": 1 } }, "required": ["projects"], "additionalProperties": false, "x-found-in": "body" }, "metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "maxProperties": 64, "minProperties": 1 } }, "required": ["tags"], "x-found-in": "body" } }, "required": ["name", "region_id"] }

package/lib/serverless/json/get_traffic_filter.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getTrafficFilter", "x-api": { "id": "traffic-filters.get-traffic-filter", "name": "get-traffic-filter", "namespace": "traffic-filters" }, "x-method": "GET", "x-path": "/api/v1/serverless/traffic-filters/{id}", "x-destructive": false, "type": "object", "properties": { "id": { "type": "string", "description": "The traffic filter ID.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getTrafficFilter", "x-api": { "id": "traffic-filters.get-traffic-filter", "name": "get-traffic-filter", "namespace": "traffic-filters" }, "x-method": "GET", "x-path": "/api/v1/serverless/traffic-filters/{id}", "x-destructive": false, "type": "object", "properties": { "id": { "type": "string", "description": "The traffic filter ID.", "x-found-in": "path" }, "organization_id": { "type": "string", "description": "The Organization ID to scope the request to.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } } }, "required": ["id", "organization_id"] }

package/lib/serverless/json/get_traffic_filter_metadata.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getTrafficFilterMetadata", "x-api": { "id": "traffic-filters.get-traffic-filter-metadata", "name": "get-traffic-filter-metadata", "namespace": "traffic-filters" }, "x-method": "GET", "x-path": "/api/v1/serverless/traffic-filters/metadata", "x-destructive": false, "type": "object", "properties": { "region": { "type": "string", "description": "Filter metadata to a specific region (e.g. aws-eu-west-1, azure-australiaeast).", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "csp": { "type": "string", "description": "Filter metadata to a specific cloud service provider (aws, azure, gcp).", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "getTrafficFilterMetadata", "x-api": { "id": "traffic-filters.get-traffic-filter-metadata", "name": "get-traffic-filter-metadata", "namespace": "traffic-filters" }, "x-method": "GET", "x-path": "/api/v1/serverless/traffic-filters/metadata", "x-destructive": false, "type": "object", "properties": { "region": { "type": "string", "description": "Filter metadata to a specific region (e.g. aws-eu-west-1, azure-australiaeast).", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "csp": { "type": "string", "description": "Filter metadata to a specific cloud service provider (aws, azure, gcp).", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "organization_id": { "type": "string", "description": "The Organization ID to scope the request to.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } } }, "required": ["organization_id"] }

package/lib/serverless/json/list_traffic_filters.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "listTrafficFilters", "x-api": { "id": "traffic-filters.list-traffic-filters", "name": "list-traffic-filters", "namespace": "traffic-filters" }, "x-method": "GET", "x-path": "/api/v1/serverless/traffic-filters", "x-destructive": false, "type": "object", "properties": { "include_by_default": { "type": "boolean", "description": "Retrieves a list of resources that have include_by_default set or not set", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "region": { "type": "string", "description": "If provided limits the traffic filters to that region only.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "listTrafficFilters", "x-api": { "id": "traffic-filters.list-traffic-filters", "name": "list-traffic-filters", "namespace": "traffic-filters" }, "x-method": "GET", "x-path": "/api/v1/serverless/traffic-filters", "x-destructive": false, "type": "object", "properties": { "include_by_default": { "type": "boolean", "description": "Retrieves a list of resources that have include_by_default set or not set", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "region": { "type": "string", "description": "If provided limits the traffic filters to that region only.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } }, "organization_id": { "type": "string", "description": "The Organization ID to scope the request to.", "x-found-in": "query", "x-query-serialization": { "style": "form", "explode": true } } }, "required": ["organization_id"] }