diff --git a/CHANGELOG.md b/CHANGELOG.md index 78148586d..893f991bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -55,6 +55,25 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Fixed `create_pit` `keep_alive` query parameter to be required ([#1102](https://github.com/opensearch-project/opensearch-api-specification/pull/1102)) - Fixed ISM index parameters to use `Indices` type instead of `IndexName` for multi-index support ([#1097](https://github.com/opensearch-project/opensearch-api-specification/issues/1097)) - Fixed `failures` field type in `PauseIngestionResponse` and `ResumeIngestionResponse` from array to map keyed by index name, matching server serialization ([#1107](https://github.com/opensearch-project/opensearch-api-specification/pull/1107)) +- Fixed `SearchResult`, `HitsMetadataJsonValue`, and `SearchResultJsonValue` hit items to compose with `Hit` via `allOf`, restoring `_id`, `_index`, `_score`, `sort`, and other hit fields that were lost by bare `_source`-only inline overrides; also fixed `SearchResultJsonValue` completion suggest options to compose with `CompletionSuggestOption` ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed `Hit._score` and `matched_queries` score format from `double` to `float`; fixed `PhraseSuggestOption.score` and `TermSuggestOption.score` from `double` to `float` to match server's Java `float` types ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed `TermSuggestOption.freq` format from `int64` to `int32` to match server's Java `int` type ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Deprecated `Hit.ignored_field_values` as an Elasticsearch-only field not present in OpenSearch server responses ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Consolidated duplicate inline schemas in `ml._common.yaml` and `flow_framework.common.yaml` to use `$ref`s to canonical `SearchResult`, `TotalHits`, `Hit`, and `ShardStatistics` definitions ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Added missing fields to security plugin schemas: `format`, `alias`, `serial_number`, `has_private_key` to `CertificatesDetail`; `is_authenticated` to `WhoAmI`; `resource_sharing_enabled` to `DashboardsInfo` ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed `GetAlertsResponse.total_alerts` and `GetFindingsResponse.total_findings` format from `int64` to `int32` to match server's Java `Integer` type; fixed `FindingWithScore.score` format from `float` to `double` to match server's Java `Double` type ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed `HeaderParamsMap` additionalProperties type from `integer int32` to `string` to match server's `Map` type ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed flow-framework type mismatches: `last_provisioned_time` from `number` to `integer int64`, added `format: int64` to `created_time` and `last_updated_time`, `resources_created` items from `string` to `ResourcesCreated`, `user_outputs` from `array of string` to `object`, `provision_start_time`/`provision_end_time` from `string date-time` to `integer int64`; added missing `ui_metadata`, `tenant_id`, `all_shared_principals` fields; removed phantom `status`/`code` fields from 15 error schemas ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Added missing `bootstrap_details` and `shard_replication_details` to cross-cluster-replication `Status` schema with full `RestoreDetails` and `ShardInfoResponse` types; added `format: int64` to `SyncingDetails` checkpoint fields ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Added `cron` variant to rollups `Schedule` (was interval-only); removed misplaced `cron` from inside `Interval`; fixed `start_time` and `schedule_delay` from `number` to `integer int64`, `period` from `number` to `integer int32`; added `schedule_delay` to `Cron` ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed asynchronous-search `ResponseBody`: `start_time_in_millis` and `expiration_time_in_millis` from `number` to `integer int64`, removed phantom `took` field, added `error` as `ErrorCause`; added `format: int64` to all `AsynchronousSearchStats` counters ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed geospatial upload stats counters and durations to `integer int64`; added `failures` array with `UploadFailure` schema to `GeoSpatialGeojsonUploadResponse`; added `format: int64` to `Database.valid_for_in_days` and `updated_at` field; added missing `last_failed_at*`, `last_skipped_at*`, `last_succeeded_at` fields to `UpdateStats` ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Added missing neural-search stat names: 7 event stats (`semantic_highlighting_batch_request_count`, `agentic_query_translator_executions`, `agentic_context_executions`, `agentic_query_requests`, `seismic_query_requests`, `sparse_encoding_seismic_executions`, `mmr_neural_query_transformer_executions`), 2 info stats (`agentic_query_translator_processors`, `agentic_context_processors`), and 4 memory metric stats (`sparse_memory_usage`, `sparse_memory_usage_percentage`, `forward_index_usage`, `clustered_posting_usage`) with flat/nested schema entries and `MemoryStat` type ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed query-insights `TopQuery`: renamed `query_hashcode` to `query_group_hashcode`, added `format: int64` to `timestamp`, added `additionalProperties` to `phase_latency_map`, reduced `GroupingType` enum to server-emitted uppercase values only, added 8 missing fields (`description`, `is_cancelled`, `wlm_group_id`, `username`, `user_roles`, `backend_roles`, `source_truncated`, `failed`); fixed `Measurement.number` from `integer` to `number`, added `aggregationType` enum; added `format: int64` to `TaskResourceUsages.taskId`/`parentTaskId` and `TaskResourceUsage.cpu_time_in_nanos`/`memory_in_bytes` ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed observability `ObservabilityObjectList`: added `format: int64` to `startIndex`/`totalHits`, added `enum: [eq, gte]` to `totalHitRelation`; added `format: int64` to `ObservabilityObject.lastUpdatedTimeMs`/`createdTimeMs`, added `access` array; added 6 missing fields to `SavedVisualization` (`application_id`, `user_configs`, `sub_type`, `metric_type`, `units_of_measure`, `selected_labels`) ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Added missing `description` to `PutSearchConfigurationRequest` and `ubiQueriesIndex` to `PostQuerySetsRequest` in search-relevance; fixed UBI `Initialize` response type from `string` to `object` with `message` field ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Fixed k-NN `NodeStats.graph_memory_usage` and `training_memory_usage` from `ByteCount` to `integer int64` (values are kilobytes, not bytes); added `remote_vector_index_build_stats` to `KnnStatName` enum; added missing `data_type`, `space_type`, `engine` to `TrainedModel`; defined `ModelResponse` schema with `ModelState` enum for `knn.get_model` endpoint ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) +- Renamed WLM `query_group` paths to `workload_group` (renamed in server 3.0.0); marked old `query_group` operations with `x-version-removed: 3.0.0`, added new `workload_group` operations with `x-version-added: 3.0.0`; renamed response key from `query_groups` to `workload_groups`; added `settings` field (`Map`) to `WorkloadGroupResponse`, `WorkloadGroupCreate`, and `WorkloadGroupUpdate` ([#1113](https://github.com/opensearch-project/opensearch-api-specification/pull/1113)) - Fixed the default parameters for `data_stream/_stats` and `shard_stores/status` ([#931](https://github.com/opensearch-project/opensearch-api-specification/pull/931)) - Fixed the type of `SearchStats`'s `concurrent_avg_slice_count` to be a double ([#942](https://github.com/opensearch-project/opensearch-api-specification/pull/942)) - Fixed name and metadata missing from metric aggregations ([#969](https://github.com/opensearch-project/opensearch-api-specification/pull/969)) diff --git a/spec/namespaces/knn.yaml b/spec/namespaces/knn.yaml index c9223a10e..6f9863018 100644 --- a/spec/namespaces/knn.yaml +++ b/spec/namespaces/knn.yaml @@ -262,7 +262,7 @@ components: content: application/json: schema: - type: object + $ref: '../schemas/knn._common.yaml#/components/schemas/ModelResponse' knn.search_models@200: content: application/json: diff --git a/spec/namespaces/search_relevance.yaml b/spec/namespaces/search_relevance.yaml index 3659fa8d0..fe7fa740a 100644 --- a/spec/namespaces/search_relevance.yaml +++ b/spec/namespaces/search_relevance.yaml @@ -228,6 +228,18 @@ paths: responses: '200': $ref: '#/components/responses/search_relevance.get_experiments@200' + patch: + operationId: search_relevance.patch_experiment.0 + x-operation-group: search_relevance.patch_experiment + x-version-added: '3.6' + description: Partially updates an experiment's name or description. + parameters: + - $ref: '#/components/parameters/search_relevance.patch_experiment::path.experiment_id' + requestBody: + $ref: '#/components/requestBodies/search_relevance.patch_experiment' + responses: + '200': + $ref: '#/components/responses/search_relevance.patch_experiment@200' delete: operationId: search_relevance.delete_experiments.0 x-operation-group: search_relevance.delete_experiments @@ -427,6 +439,13 @@ components: schema: type: string + search_relevance.patch_experiment::path.experiment_id: + name: experiment_id + in: path + required: true + description: The experiment id. + schema: + type: string search_relevance.get_scheduled_experiments::path.experiment_id: name: experiment_id in: path @@ -599,6 +618,11 @@ components: application/json: schema: $ref: '../schemas/search_relevance._common.yaml#/components/schemas/SearchRequest' + search_relevance.patch_experiment: + content: + application/json: + schema: + $ref: '../schemas/search_relevance._common.yaml#/components/schemas/PatchExperimentRequest' search_relevance.post_scheduled_experiments: content: application/json: @@ -690,6 +714,11 @@ components: application/json: schema: $ref: '../schemas/_common.yaml#/components/schemas/WriteResponseBase' + search_relevance.patch_experiment@200: + content: + application/json: + schema: + $ref: '../schemas/search_relevance._common.yaml#/components/schemas/PatchExperimentResponse' search_relevance.get_node_stats@200: content: application/json: diff --git a/spec/namespaces/wlm.yaml b/spec/namespaces/wlm.yaml index d9179f33e..7d1f9e7dd 100644 --- a/spec/namespaces/wlm.yaml +++ b/spec/namespaces/wlm.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Workload Management Query Group API - description: The Query Group Lifecycle APIs create, update, and delete workload management query groups. + title: Workload Management API + description: The Workload Group Lifecycle APIs create, update, and delete workload management groups. version: 1.0.0 paths: /_wlm/query_group: @@ -9,6 +9,7 @@ paths: operationId: wlm.get_query_group.0 x-operation-group: wlm.get_query_group x-version-added: '2.17' + x-version-removed: 3.0.0 description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. responses: '200': @@ -17,6 +18,7 @@ paths: operationId: wlm.create_query_group.0 x-operation-group: wlm.create_query_group x-version-added: '2.17' + x-version-removed: 3.0.0 description: Creates a new query group and sets the resource limits for the new query group. requestBody: $ref: '#/components/requestBodies/wlm.create_query_group' @@ -28,6 +30,7 @@ paths: operationId: wlm.get_query_group.1 x-operation-group: wlm.get_query_group x-version-added: '2.17' + x-version-removed: 3.0.0 description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. parameters: - $ref: '#/components/parameters/wlm.get_query_group::path.name' @@ -38,6 +41,7 @@ paths: operationId: wlm.update_query_group.0 x-operation-group: wlm.update_query_group x-version-added: '2.17' + x-version-removed: 3.0.0 description: Updates the specified query group. parameters: - $ref: '#/components/parameters/wlm.update_query_group::path.name' @@ -50,12 +54,65 @@ paths: operationId: wlm.delete_query_group.0 x-operation-group: wlm.delete_query_group x-version-added: '2.17' + x-version-removed: 3.0.0 description: Deletes the specified query group. parameters: - $ref: '#/components/parameters/wlm.delete_query_group::path.name' responses: '200': $ref: '#/components/responses/wlm.delete_query_group@200' + /_wlm/workload_group: + get: + operationId: wlm.get_workload_group.0 + x-operation-group: wlm.get_workload_group + x-version-added: 3.0.0 + description: Retrieves the specified workload group. If no workload group is specified, all workload groups in the cluster are retrieved. + responses: + '200': + $ref: '#/components/responses/wlm.get_workload_group@200' + put: + operationId: wlm.create_workload_group.0 + x-operation-group: wlm.create_workload_group + x-version-added: 3.0.0 + description: Creates a new workload group and sets the resource limits for the new workload group. + requestBody: + $ref: '#/components/requestBodies/wlm.create_workload_group' + responses: + '200': + $ref: '#/components/responses/wlm.create_workload_group@200' + /_wlm/workload_group/{name}: + get: + operationId: wlm.get_workload_group.1 + x-operation-group: wlm.get_workload_group + x-version-added: 3.0.0 + description: Retrieves the specified workload group. If no workload group is specified, all workload groups in the cluster are retrieved. + parameters: + - $ref: '#/components/parameters/wlm.get_workload_group::path.name' + responses: + '200': + $ref: '#/components/responses/wlm.get_workload_group@200' + put: + operationId: wlm.update_workload_group.0 + x-operation-group: wlm.update_workload_group + x-version-added: 3.0.0 + description: Updates the specified workload group. + parameters: + - $ref: '#/components/parameters/wlm.update_workload_group::path.name' + requestBody: + $ref: '#/components/requestBodies/wlm.update_workload_group' + responses: + '200': + $ref: '#/components/responses/wlm.update_workload_group@200' + delete: + operationId: wlm.delete_workload_group.0 + x-operation-group: wlm.delete_workload_group + x-version-added: 3.0.0 + description: Deletes the specified workload group. + parameters: + - $ref: '#/components/parameters/wlm.delete_workload_group::path.name' + responses: + '200': + $ref: '#/components/responses/wlm.delete_workload_group@200' components: requestBodies: wlm.create_query_group: @@ -70,6 +127,18 @@ components: schema: $ref: '../schemas/wlm._common.yaml#/components/schemas/QueryGroupUpdate' required: true + wlm.create_workload_group: + content: + application/json: + schema: + $ref: '../schemas/wlm._common.yaml#/components/schemas/WorkloadGroupCreate' + required: true + wlm.update_workload_group: + content: + application/json: + schema: + $ref: '../schemas/wlm._common.yaml#/components/schemas/WorkloadGroupUpdate' + required: true responses: wlm.create_query_group@200: description: '' @@ -103,6 +172,38 @@ components: type: array items: $ref: '../schemas/wlm._common.yaml#/components/schemas/QueryGroupResponse' + wlm.create_workload_group@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/wlm._common.yaml#/components/schemas/WorkloadGroupResponse' + wlm.update_workload_group@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/wlm._common.yaml#/components/schemas/WorkloadGroupResponse' + wlm.delete_workload_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + wlm.get_workload_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + workload_groups: + type: array + items: + $ref: '../schemas/wlm._common.yaml#/components/schemas/WorkloadGroupResponse' parameters: wlm.update_query_group::path.name: name: name @@ -125,3 +226,24 @@ components: schema: type: string required: true + wlm.update_workload_group::path.name: + name: name + in: path + description: The name of the workload group. + schema: + type: string + required: true + wlm.delete_workload_group::path.name: + name: name + in: path + description: The name of the workload group. + schema: + type: string + required: true + wlm.get_workload_group::path.name: + name: name + in: path + description: The name of the workload group. + schema: + type: string + required: true diff --git a/spec/schemas/_core.search.yaml b/spec/schemas/_core.search.yaml index 6f43fb904..a7fe582e6 100644 --- a/spec/schemas/_core.search.yaml +++ b/spec/schemas/_core.search.yaml @@ -40,9 +40,11 @@ components: hits: type: array items: - type: object - properties: - _source: {} + allOf: + - $ref: '#/components/schemas/Hit' + - type: object + properties: + _source: {} TotalHits: type: object properties: @@ -78,7 +80,7 @@ components: oneOf: - type: 'null' - type: number - format: double + format: float _explanation: $ref: '_core.explain.yaml#/components/schemas/Explanation' fields: @@ -107,7 +109,7 @@ components: type: object additionalProperties: type: number - format: double + format: float _nested: $ref: '#/components/schemas/NestedIdentity' _ignored: @@ -115,6 +117,9 @@ components: items: type: string ignored_field_values: + deprecated: true + x-version-deprecated: 1.0.0 + description: 'Elasticsearch-only field: not present in OpenSearch server responses.' type: object additionalProperties: type: array @@ -690,7 +695,7 @@ components: type: string score: type: number - format: double + format: float highlighted: type: string collate_match: @@ -718,10 +723,10 @@ components: type: string score: type: number - format: double + format: float freq: type: integer - format: int64 + format: int32 highlighted: type: string collate_match: @@ -1359,10 +1364,12 @@ components: hits: type: array items: - type: object - properties: - _source: - $ref: '#/components/schemas/TDocument' + allOf: + - $ref: '#/components/schemas/Hit' + - type: object + properties: + _source: + $ref: '#/components/schemas/TDocument' processor_results: x-version-added: '3.0' type: array @@ -1407,9 +1414,11 @@ components: hits: type: array items: - type: object - properties: - _source: {} + allOf: + - $ref: '#/components/schemas/Hit' + - type: object + properties: + _source: {} suggest: type: object additionalProperties: @@ -1417,18 +1426,24 @@ components: items: oneOf: - title: completion - type: object - properties: - options: - oneOf: - - type: object - properties: - _source: {} - - type: array - items: - type: object - properties: - _source: {} + allOf: + - $ref: '#/components/schemas/CompletionSuggest' + - type: object + properties: + options: + oneOf: + - allOf: + - $ref: '#/components/schemas/CompletionSuggestOption' + - type: object + properties: + _source: {} + - type: array + items: + allOf: + - $ref: '#/components/schemas/CompletionSuggestOption' + - type: object + properties: + _source: {} - title: phrase $ref: '#/components/schemas/PhraseSuggest' - title: term diff --git a/spec/schemas/asynchronous_search._common.yaml b/spec/schemas/asynchronous_search._common.yaml index c4daa3adc..8e395e550 100644 --- a/spec/schemas/asynchronous_search._common.yaml +++ b/spec/schemas/asynchronous_search._common.yaml @@ -13,14 +13,16 @@ components: type: string state: type: string - start_time_in_millis: - type: number + start_time_in_millis: + type: integer + format: int64 expiration_time_in_millis: - type: number - took: - type: number + type: integer + format: int64 response: $ref: '_core.search.yaml#/components/schemas/SearchResponse' + error: + $ref: '_common.yaml#/components/schemas/ErrorCause' StatsResponse: allOf: - $ref: 'nodes._common.yaml#/components/schemas/NodesResponseBase' @@ -167,19 +169,28 @@ components: properties: submitted: type: integer + format: int64 initialized: type: integer + format: int64 search_failed: type: integer + format: int64 search_completed: type: integer + format: int64 rejected: type: integer + format: int64 persist_failed: type: integer + format: int64 cancelled: type: integer + format: int64 running_current: type: integer + format: int64 persisted: - type: integer \ No newline at end of file + type: integer + format: int64 \ No newline at end of file diff --git a/spec/schemas/flow_framework.common.yaml b/spec/schemas/flow_framework.common.yaml index 4e103ccd0..0eb0300ec 100644 --- a/spec/schemas/flow_framework.common.yaml +++ b/spec/schemas/flow_framework.common.yaml @@ -61,6 +61,9 @@ components: workflows: type: object description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for `user_params` and lists of nodes and edges. + ui_metadata: + type: object + description: A map of UI metadata. required: - name FlowFrameworkUpdate: @@ -77,6 +80,9 @@ components: description: A use case ID, which can be used with the Search Workflow API to find related workflows. workflows: type: object + ui_metadata: + type: object + description: A map of UI metadata. version: $ref: '#/components/schemas/version' minProperties: 1 @@ -100,13 +106,29 @@ components: $ref: '#/components/schemas/user' created_time: type: integer + format: int64 description: When the workflow was created. last_updated_time: type: integer + format: int64 description: When the workflow was last updated. last_provisioned_time: - type: number + type: integer + format: int64 description: When the workflow was last provisioned. + ui_metadata: + type: object + description: A map of UI metadata. + tenant_id: + type: string + description: The tenant ID of the workflow. + x-version-added: 3.0.0 + all_shared_principals: + type: array + items: + type: string + description: The entities this workflow is shared with. + x-version-added: 3.4.0 version: type: object description: A key-value map with two fields, template, which identifies the template version, and compatibility, which identifies a list of minimum required OpenSearch versions. @@ -120,77 +142,23 @@ components: type: string description: A list of minimum required OpenSearch versions. shards: - type: object - properties: - total: - type: integer - description: The total number of shards involved in the deletion. - successful: - type: integer - description: The number of shards where the deletion was successful. - failed: - type: integer - description: The number of shards where the deletion failed. - skipped: - type: integer - description: The number of shards where the deletion was skipped. + $ref: '_common.yaml#/components/schemas/ShardStatistics' total: - type: object - properties: - value: - type: integer - description: The total number of matching documents. - relation: - type: string - description: The relation of the total hits. + $ref: '_core.search.yaml#/components/schemas/TotalHits' itemsObject: - type: object - properties: - _index: - type: string - description: The index name where the document resides. - _id: - type: string - description: The document ID. - _version: - type: integer - description: The version of the document. - _seq_no: - type: integer - description: The sequence number of the document. - _primary_term: - type: integer - description: The primary term of the document. - _score: - type: number - format: float - description: The score of the search hit. - _source: - $ref: '#/components/schemas/FlowFrameworkGetResponse' + allOf: + - $ref: '_core.search.yaml#/components/schemas/Hit' + - type: object + properties: + _source: + $ref: '#/components/schemas/FlowFrameworkGetResponse' StateItems: - type: object - properties: - _index: - type: string - description: The index name where the document resides. - _id: - type: string - description: The document ID. - _version: - type: integer - description: The version of the document. - _seq_no: - type: integer - description: The sequence number of the document. - _primary_term: - type: integer - description: The primary term of the document. - _score: - type: number - format: float - description: The score of the search hit. - _source: - $ref: '#/components/schemas/SearchStateResponse' + allOf: + - $ref: '_core.search.yaml#/components/schemas/Hit' + - type: object + properties: + _source: + $ref: '#/components/schemas/SearchStateResponse' SearchStateResponse: type: object properties: @@ -329,8 +297,8 @@ components: resources_created: type: array items: - type: string - description: A list of resources created by the workflow + $ref: '#/components/schemas/ResourcesCreated' + description: A list of resources created by the workflow. WorkFlowState: type: string enum: @@ -354,27 +322,36 @@ components: resources_created: type: array items: - type: string + $ref: '#/components/schemas/ResourcesCreated' description: A list of resources created by the workflow. provisioning_progress: type: string description: The current progress of the provisioning process. nullable: true provision_start_time: - type: string - format: date-time - description: When the provisioning process started. + type: integer + format: int64 + description: When the provisioning process started, in epoch milliseconds. provision_end_time: - type: string - format: date-time - description: When the provisioning process completed. + type: integer + format: int64 + description: When the provisioning process completed, in epoch milliseconds. user: $ref: '#/components/schemas/user' user_outputs: + type: object + additionalProperties: true + description: A map of essential API responses for backend use and lookup. + tenant_id: + type: string + description: The tenant ID of the workflow. + x-version-added: 3.0.0 + all_shared_principals: type: array items: type: string - description: The list of outputs generated by the user. + description: The entities this workflow is shared with. + x-version-added: 3.4.0 UserProvidedSubstitutionExpressions: type: object description: A map of user-provided substitution expressions and their values. diff --git a/spec/schemas/flow_framework.errors.yaml b/spec/schemas/flow_framework.errors.yaml index df5a1910b..c6f794f4b 100644 --- a/spec/schemas/flow_framework.errors.yaml +++ b/spec/schemas/flow_framework.errors.yaml @@ -13,8 +13,6 @@ components: error: type: string # example: This API is disabled. To enable it, set [flow_framework.enabled] to true. - status: - type: integer InvalidParameterError: type: object description: Indicates that invalid parameters were provided in the request. @@ -22,8 +20,6 @@ components: error: type: string # example: Only the parameters [param1, param2] are permitted unless the provision parameter is set to true. - status: - type: integer ConflictError: type: object description: Indicates that conflicting parameters were provided in the request. @@ -31,8 +27,6 @@ components: error: type: string # example: You cannot use both the 'provision_workflow' and 'update_workflow_fields' parameters in the same request. - status: - type: integer MissingParameterError: type: object description: Indicates that required parameters are missing from the request. @@ -40,8 +34,6 @@ components: error: type: string # example: You cannot use the 'reprovision_workflow' parameter to create a new template. - status: - type: integer ParameterConflictError: type: object description: Indicates that mutually exclusive parameters were provided in the request. @@ -49,8 +41,6 @@ components: error: type: string # example: You cannot use the 'reprovision_workflow' and 'use_case' parameters in the same request. - status: - type: integer WorkFlowIdNullError: type: object description: Indicates that the workflow ID is missing. @@ -58,8 +48,6 @@ components: error: type: string # example: Workflow ID can not be null - status: - type: integer DuplicateKeyError: type: object description: Indicates that a duplicate key was found in the request. @@ -67,10 +55,6 @@ components: error: type: string description: Error message when a duplicate key is found in the request. - status: - type: integer - description: The HTTP status code for the error. - # example: 400 InvalidRequestBodyFieldError: type: object description: Indicates that a field in the request body has an invalid type. @@ -78,9 +62,6 @@ components: error: type: string description: Error message when a request body field is not a string. - status: - type: integer - description: HTTP status code for the error. RequestBodyParsingFailedError: type: object description: Indicates that the request body could not be parsed. @@ -88,10 +69,6 @@ components: error: type: string description: Error message when request body parsing fails. - status: - type: integer - description: HTTP status code for the error. - # example: 400 WorkflowSaveError: type: object description: Indicates that the workflow state could not be saved. @@ -99,8 +76,6 @@ components: error: type: string # example: Failed to save workflow state - status: - type: integer MaxWorkflowsLimitError: type: object description: Indicates that the maximum number of workflows has been reached. @@ -108,8 +83,6 @@ components: error: type: string # example: Maximum workflows limit reached 50 - code: - type: integer TemplateNameRequiredError: type: object description: Indicates that the template name is missing from the request. @@ -124,8 +97,6 @@ components: error: type: string # example: Failed to retrieve template (12345) from global context. - code: - type: integer InvalidTemplateVersionError: type: object description: Indicates that the template version is invalid or missing. @@ -154,8 +125,6 @@ components: error: type: string # example: Failed to retrieve workflow step json. - code: - type: integer DeprovisioningError: type: object description: Indicates that some resources could not be deprovisioned and names the resources. @@ -180,18 +149,10 @@ components: error: type: string description: Indicates that the request exceeded the time limit. - status: - type: integer - description: HTTP status code for the error. - # example: 408 BadRequestError: type: object description: Indicates that the request contains invalid parameters or body. properties: error: type: string - # example: Invalid request body or query parameters. - status: - type: integer - description: The HTTP status code for the error. - # example: 400 \ No newline at end of file + # example: Invalid request body or query parameters. \ No newline at end of file diff --git a/spec/schemas/geospatial._common.yaml b/spec/schemas/geospatial._common.yaml index 26f261eec..23e055342 100644 --- a/spec/schemas/geospatial._common.yaml +++ b/spec/schemas/geospatial._common.yaml @@ -23,12 +23,30 @@ components: failure: type: integer description: Number of features that failed to upload. + failures: + type: array + description: Details of individual feature upload failures. Only present when errors is true. + items: + $ref: '#/components/schemas/UploadFailure' required: - errors - failure - success - took - total + UploadFailure: + type: object + properties: + id: + type: string + description: The document ID that failed. + status: + type: integer + format: int32 + description: The HTTP status code of the failure. + message: + type: string + description: The failure message. GeoSpatialUploadStats: type: object properties: @@ -46,18 +64,24 @@ components: properties: request_count: type: integer + format: int64 description: Total number of upload requests. upload: type: integer + format: int64 description: Total number of uploads. success: type: integer + format: int64 description: Total successful uploads. failed: type: integer + format: int64 description: Total failed uploads. duration: - $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + type: integer + format: int64 + description: Total duration in milliseconds. required: - duration - failed @@ -76,15 +100,20 @@ components: description: Type of upload (such as "GeoJSON"). upload: type: integer + format: int64 description: Number of features in this upload. success: type: integer + format: int64 description: Number of successful features in this upload. failed: type: integer + format: int64 description: Number of failed features in this upload. duration: - $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + type: integer + format: int64 + description: Duration in milliseconds. required: - duration - failed @@ -148,8 +177,12 @@ components: type: string updated_at_in_epoch_millis: $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + updated_at: + type: string + description: Human-readable timestamp of when the database was updated. valid_for_in_days: type: integer + format: int64 fields: type: array items: @@ -159,8 +192,23 @@ components: properties: last_succeeded_at_in_epoch_millis: $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + last_succeeded_at: + type: string + description: Human-readable timestamp of the last successful update. last_processing_time_in_millis: + type: integer + format: int64 + description: Processing time of the last update in milliseconds. + last_failed_at_in_epoch_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + last_failed_at: + type: string + description: Human-readable timestamp of the last failed update. + last_skipped_at_in_epoch_millis: $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + last_skipped_at: + type: string + description: Human-readable timestamp of the last skipped update. PutIP2GeoDataSourceRequest: type: object properties: diff --git a/spec/schemas/insights._common.yaml b/spec/schemas/insights._common.yaml index 1b9202499..2cc9d1072 100644 --- a/spec/schemas/insights._common.yaml +++ b/spec/schemas/insights._common.yaml @@ -18,7 +18,6 @@ components: top_queries: type: array items: - type: object $ref: '#/components/schemas/TopQuery' required: - top_queries @@ -31,19 +30,19 @@ components: $ref: '#/components/schemas/GroupingType' timestamp: type: integer + format: int64 description: The timestamp of the query execution. total_shards: type: integer + format: int32 description: The total number of shards involved in the query. task_resource_usages: type: array items: - type: object $ref: '#/components/schemas/TaskResourceUsages' - - query_hashcode: + query_group_hashcode: type: string - description: The hash code of the query. + description: The hash code of the query group. labels: type: object description: Additional labels for the query. @@ -51,7 +50,6 @@ components: type: string description: The search query type (for example, `query_then_fetch`). source: - type: object $ref: '#/components/schemas/Source' node_id: type: string @@ -63,16 +61,52 @@ components: description: The indexes involved in the query. phase_latency_map: type: object + additionalProperties: + type: integer + format: int64 measurements: - type: object $ref: '#/components/schemas/Measurements' + description: + type: string + description: A description of the search query. + x-version-added: 3.0.0 + is_cancelled: + type: boolean + description: Whether the search query was cancelled. + x-version-added: 3.1.0 + wlm_group_id: + type: string + description: The workload management group ID associated with the query. + x-version-added: 3.3.0 + username: + type: string + description: The username who initiated the search query. + x-version-added: 3.5.0 + user_roles: + type: array + items: + type: string + description: The roles of the user who initiated the search query. + x-version-added: 3.5.0 + backend_roles: + type: array + items: + type: string + description: The backend roles of the user who initiated the search query. + x-version-added: 3.5.0 + source_truncated: + type: boolean + description: Whether the source was truncated due to length limits. + x-version-added: 3.5.0 + failed: + type: boolean + description: Whether the search request failed during execution. + x-version-added: 3.6.0 GroupingType: type: string enum: - NONE - SIMILARITY - - none - - similarity TaskResourceUsages: type: object properties: @@ -81,24 +115,27 @@ components: description: The action type of the task. taskId: type: integer + format: int64 description: The task ID. parentTaskId: type: integer + format: int64 description: The parent task ID. nodeId: type: string description: The node ID where the task was executed. taskResourceUsage: - type: object $ref: '#/components/schemas/TaskResourceUsage' TaskResourceUsage: type: object properties: cpu_time_in_nanos: type: integer + format: int64 description: The CPU time used in nanoseconds. memory_in_bytes: type: integer + format: int64 description: The memory usage in bytes. Source: type: object @@ -226,20 +263,24 @@ components: type: object properties: number: - type: integer + type: number count: type: integer + format: int32 aggregationType: - type: string + $ref: '#/components/schemas/AggregationType' + AggregationType: + type: string + enum: + - AVERAGE + - NONE + - SUM Measurements: type: object properties: latency: - type: object $ref: '#/components/schemas/Measurement' cpu: - type: object $ref: '#/components/schemas/Measurement' memory: - type: object $ref: '#/components/schemas/Measurement' \ No newline at end of file diff --git a/spec/schemas/knn._common.yaml b/spec/schemas/knn._common.yaml index 7fb12579d..0008b624d 100644 --- a/spec/schemas/knn._common.yaml +++ b/spec/schemas/knn._common.yaml @@ -35,14 +35,18 @@ components: type: integer format: int64 graph_memory_usage: - $ref: '_common.yaml#/components/schemas/ByteCount' + type: integer + format: int64 + description: The amount of native memory used by loaded graphs, in kilobytes. cache_capacity_reached: type: boolean load_success_count: type: integer format: int64 training_memory_usage: - $ref: '_common.yaml#/components/schemas/ByteCount' + type: integer + format: int64 + description: The amount of native memory used by training data, in kilobytes. indices_in_cache: type: object additionalProperties: true @@ -258,8 +262,21 @@ components: type: string method: $ref: '#/components/schemas/KnnMethod' + data_type: + type: string + description: The vector data type. + x-version-added: 2.16.0 + space_type: + type: string + description: The space type for distance calculation. + x-version-added: 2.17.0 + engine: + type: string + description: The k-NN engine to use. + x-version-added: 2.17.0 spaceType: type: string + description: The space type for distance calculation (alias for space_type). required: - dimension - training_field @@ -279,6 +296,56 @@ components: required: - model_id - result + ModelResponse: + type: object + properties: + model_id: + type: string + model_blob: + type: string + description: The base64-encoded model data. + state: + $ref: '#/components/schemas/ModelState' + timestamp: + type: string + description: The timestamp when the model was created. + description: + type: string + error: + type: string + space_type: + type: string + dimension: + type: integer + format: int32 + engine: + type: string + training_node_assignment: + type: string + model_definition: + type: object + additionalProperties: true + data_type: + type: string + description: The vector data type. + x-version-added: 2.17.0 + mode: + type: string + x-version-added: 2.17.0 + compression_level: + type: string + x-version-added: 2.17.0 + model_version: + type: string + x-version-added: 2.17.0 + required: + - model_id + ModelState: + type: string + enum: + - created + - failed + - training KnnStatName: type: string enum: @@ -308,6 +375,7 @@ components: - miss_count - model_index_status - nmslib_initialized + - remote_vector_index_build_stats - script_compilation_errors - script_compilations - script_query_errors diff --git a/spec/schemas/ml._common.yaml b/spec/schemas/ml._common.yaml index e8219e469..0be244028 100644 --- a/spec/schemas/ml._common.yaml +++ b/spec/schemas/ml._common.yaml @@ -11,77 +11,26 @@ components: SearchModelsResponse: $ref: '#/components/schemas/SearchResponse' SearchResponse: - type: object - properties: - took: - type: integer - description: The time taken to execute the search. - timed_out: - type: boolean - description: Whether the search timed out. - _shards: - $ref: '_common.yaml#/components/schemas/ShardStatistics' - hits: - $ref: '#/components/schemas/SearchHits' - required: - - hits - SearchHits: - type: object - properties: - total: - $ref: '#/components/schemas/HitsTotal' - hits: - type: array - items: - $ref: '#/components/schemas/SearchHitsHit' - max_score: - type: ['null', number] - description: The maximum score. - required: - - hits - - total - HitsTotal: - type: object - properties: - value: - type: integer - format: int64 - description: The total number of hits. - relation: - type: string - description: The relation. - required: - - relation - - value + allOf: + - $ref: '_core.search.yaml#/components/schemas/SearchResult' + - type: object + properties: + hits: + type: object + properties: + hits: + type: array + items: + $ref: '#/components/schemas/SearchHitsHit' SearchHitsHit: - type: object - properties: - _version: - $ref: '_common.yaml#/components/schemas/VersionNumber' - _seq_no: - $ref: '_common.yaml#/components/schemas/SequenceNumber' - _primary_term: - type: integer - description: The primary term. - _index: - $ref: '_common.yaml#/components/schemas/IndexName' - _id: - $ref: '_common.yaml#/components/schemas/Id' - _score: - type: ['null', number] - description: The score. - _source: - $ref: '#/components/schemas/Source' - model_id: - $ref: '_common.yaml#/components/schemas/Name' - sort: - type: array - items: - type: number - format: float - description: The sort values. - required: - - _score + allOf: + - $ref: '_core.search.yaml#/components/schemas/Hit' + - type: object + properties: + _source: + $ref: '#/components/schemas/Source' + model_id: + $ref: '_common.yaml#/components/schemas/Name' ModelState: type: string description: The model state. diff --git a/spec/schemas/neural._common.yaml b/spec/schemas/neural._common.yaml index 0f8c0db00..18b0e5f7e 100644 --- a/spec/schemas/neural._common.yaml +++ b/spec/schemas/neural._common.yaml @@ -9,7 +9,13 @@ components: NeuralStatName: type: string enum: + - agentic_context_executions + - agentic_context_processors + - agentic_query_requests + - agentic_query_translator_executions + - agentic_query_translator_processors - cluster_version + - clustered_posting_usage - comb_arithmetic_executions - comb_arithmetic_processors - comb_geometric_executions @@ -18,10 +24,12 @@ components: - comb_harmonic_processors - comb_rrf_executions - comb_rrf_processors + - forward_index_usage - hybrid_query_requests - hybrid_query_with_filter_requests - hybrid_query_with_inner_hits_requests - hybrid_query_with_pagination_requests + - mmr_neural_query_transformer_executions - neural_query_against_knn_requests - neural_query_against_semantic_dense_requests - neural_query_against_semantic_sparse_requests @@ -45,13 +53,18 @@ components: - rerank_by_field_processors - rerank_ml_executions - rerank_ml_processors + - seismic_query_requests - semantic_field_chunking_executions - semantic_field_executions + - semantic_highlighting_batch_request_count - semantic_highlighting_request_count - skip_existing_executions - skip_existing_processors - sparse_encoding_executions - sparse_encoding_processors + - sparse_encoding_seismic_executions + - sparse_memory_usage + - sparse_memory_usage_percentage - text_chunking_delimiter_executions - text_chunking_delimiter_processors - text_chunking_executions @@ -181,6 +194,13 @@ components: processors.search.neural_query_enricher_processors: $ref: '#/components/schemas/InfoCounterStat' x-version-added: '3.1' + # Search processors - agentic related + processors.search.agentic.agentic_query_translator_processors: + $ref: '#/components/schemas/InfoCounterStat' + x-version-added: 3.2.0 + processors.search.agentic.agentic_context_processors: + $ref: '#/components/schemas/InfoCounterStat' + x-version-added: 3.3.0 NestedNeuralInfoStats: type: object properties: @@ -233,6 +253,8 @@ components: properties: hybrid: $ref: '#/components/schemas/NestedNeuralInfoStatsProcessorsSearchHybrid' + agentic: + $ref: '#/components/schemas/NestedNeuralInfoStatsProcessorsSearchAgentic' # Search processors - rerank related rerank_ml_processors: @@ -283,7 +305,15 @@ components: comb_arithmetic_processors: $ref: '#/components/schemas/InfoCounterStat' x-version-added: '3.1' - + NestedNeuralInfoStatsProcessorsSearchAgentic: + type: object + properties: + agentic_query_translator_processors: + $ref: '#/components/schemas/InfoCounterStat' + x-version-added: 3.2.0 + agentic_context_processors: + $ref: '#/components/schemas/InfoCounterStat' + x-version-added: 3.3.0 FlatNeuralNodeStats: type: object properties: @@ -322,6 +352,9 @@ components: processors.ingest.semantic_field_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + processors.ingest.sparse_encoding_seismic_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.5.0 # Search executions - normalization related processors.search.hybrid.normalization_processor_executions: @@ -361,6 +394,10 @@ components: processors.search.rerank_by_field_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + # Search executions - MMR related + processors.search.mmr_neural_query_transformer_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 # Search executions - neural related processors.search.neural_sparse_two_phase_executions: @@ -369,6 +406,13 @@ components: processors.search.neural_query_enricher_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + # Search executions - agentic related + processors.search.agentic.agentic_query_translator_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.2.0 + processors.search.agentic.agentic_context_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 # Query stats - hybrid query.hybrid.hybrid_query_requests: @@ -383,6 +427,10 @@ components: query.hybrid.hybrid_query_with_inner_hits_requests: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + # Query stats - agentic + query.agentic.agentic_query_requests: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.2.0 # Query stats - neural query.neural.neural_query_requests: @@ -402,11 +450,30 @@ components: query.neural_sparse.neural_sparse_query_requests: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + query.neural_sparse.seismic_query_requests: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 # Semantic highlighting semantic_highlighting.semantic_highlighting_request_count: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + semantic_highlighting.semantic_highlighting_batch_request_count: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 + # Memory stats - sparse + memory.sparse.sparse_memory_usage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 + memory.sparse.sparse_memory_usage_percentage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 + memory.sparse.forward_index_usage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 + memory.sparse.clustered_posting_usage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 NestedNeuralNodeStats: type: object properties: @@ -416,6 +483,8 @@ components: $ref: '#/components/schemas/NestedNeuralNodeStatsSemanticHighlighting' processors: $ref: '#/components/schemas/NestedNeuralNodeStatsProcessors' + memory: + $ref: '#/components/schemas/NestedNeuralNodeStatsMemory' NestedNeuralNodeStatsQuery: type: object properties: @@ -425,6 +494,8 @@ components: $ref: '#/components/schemas/NestedNeuralNodeStatsQueryNeural' neural_sparse: $ref: '#/components/schemas/NestedNeuralNodeStatsQueryNeuralSparse' + agentic: + $ref: '#/components/schemas/NestedNeuralNodeStatsQueryAgentic' NestedNeuralNodeStatsQueryHybrid: type: object @@ -464,6 +535,15 @@ components: neural_sparse_query_requests: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + seismic_query_requests: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 + NestedNeuralNodeStatsQueryAgentic: + type: object + properties: + agentic_query_requests: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.2.0 NestedNeuralNodeStatsSemanticHighlighting: type: object @@ -471,6 +551,9 @@ components: semantic_highlighting_request_count: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + semantic_highlighting_batch_request_count: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 NestedNeuralNodeStatsProcessors: type: object @@ -517,13 +600,16 @@ components: semantic_field_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' - + sparse_encoding_seismic_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.5.0 NestedNeuralNodeStatsProcessorsSearch: type: object properties: hybrid: $ref: '#/components/schemas/NestedNeuralNodeStatsProcessorsSearchHybrid' - + agentic: + $ref: '#/components/schemas/NestedNeuralNodeStatsProcessorsSearchAgentic' # Search executions - neural related neural_sparse_two_phase_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' @@ -531,7 +617,6 @@ components: neural_query_enricher_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' - # Search executions - rerank related rerank_by_field_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' @@ -539,6 +624,10 @@ components: rerank_ml_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + # Search executions - MMR related + mmr_neural_query_transformer_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 NestedNeuralNodeStatsProcessorsSearchHybrid: type: object @@ -573,6 +662,35 @@ components: comb_arithmetic_executions: $ref: '#/components/schemas/TimestampedEventCounterStat' x-version-added: '3.1' + NestedNeuralNodeStatsProcessorsSearchAgentic: + type: object + properties: + agentic_query_translator_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.2.0 + agentic_context_executions: + $ref: '#/components/schemas/TimestampedEventCounterStat' + x-version-added: 3.3.0 + NestedNeuralNodeStatsMemory: + type: object + properties: + sparse: + $ref: '#/components/schemas/NestedNeuralNodeStatsMemorySparse' + NestedNeuralNodeStatsMemorySparse: + type: object + properties: + sparse_memory_usage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 + sparse_memory_usage_percentage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 + forward_index_usage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 + clustered_posting_usage: + $ref: '#/components/schemas/MemoryStat' + x-version-added: 3.3.0 StatMetadata: type: object required: @@ -582,6 +700,7 @@ components: value: oneOf: - type: integer + - type: number - type: string stat_type: type: string @@ -620,3 +739,13 @@ components: type: integer minutes_since_last_event: type: integer + MemoryStat: + oneOf: + - type: number + - allOf: + - $ref: '#/components/schemas/StatMetadata' + - type: object + properties: + stat_type: + type: string + const: memory diff --git a/spec/schemas/notifications._common.yaml b/spec/schemas/notifications._common.yaml index 791816731..55da3a8db 100644 --- a/spec/schemas/notifications._common.yaml +++ b/spec/schemas/notifications._common.yaml @@ -148,8 +148,7 @@ components: HeaderParamsMap: type: object additionalProperties: - type: integer - format: int32 + type: string SmtpAccount: type: object properties: diff --git a/spec/schemas/observability._common.yaml b/spec/schemas/observability._common.yaml index b9b512798..3689d5cf1 100644 --- a/spec/schemas/observability._common.yaml +++ b/spec/schemas/observability._common.yaml @@ -12,12 +12,14 @@ components: properties: startIndex: type: integer + format: int64 description: The starting index of the returned objects. totalHits: type: integer + format: int64 description: The total number of matching objects. totalHitRelation: - type: string + $ref: '#/components/schemas/TotalHitRelation' description: The relationship of total hits to the query. observabilityObjectList: type: array @@ -30,6 +32,12 @@ components: - totalHitRelation - totalHits + TotalHitRelation: + type: string + enum: + - eq + - gte + ObservabilityObject: type: object description: The core observability object containing visualization and query data. @@ -39,13 +47,21 @@ components: description: The unique identifier of the observability object. lastUpdatedTimeMs: type: integer + format: int64 description: When the object was last updated in milliseconds. createdTimeMs: type: integer + format: int64 description: When the object was created in milliseconds. tenant: type: string description: The tenant associated with the observability object. + access: + type: array + items: + type: string + description: The access control list for the observability object. + x-version-added: 1.2.0 operationalPanel: $ref: '#/components/schemas/OperationalPanel' savedVisualization: @@ -161,6 +177,29 @@ components: $ref: '#/components/schemas/SelectedTimestamp' selected_fields: $ref: '#/components/schemas/SelectedFields' + application_id: + type: string + description: The identifier of the associated application. + x-version-added: 1.3.0 + user_configs: + type: string + description: User-specific configuration for the visualization. + x-version-added: 1.3.0 + sub_type: + type: string + description: The sub-type of the visualization. + x-version-added: 1.3.0 + metric_type: + type: string + description: The metric type for the visualization. + x-version-added: 1.3.0 + units_of_measure: + type: string + description: The units of measure for the visualization. + x-version-added: 1.3.0 + selected_labels: + $ref: '#/components/schemas/SelectedFields' + x-version-added: 1.3.0 required: - description - name diff --git a/spec/schemas/replication._common.yaml b/spec/schemas/replication._common.yaml index 22cf4c947..0f4ea50a8 100644 --- a/spec/schemas/replication._common.yaml +++ b/spec/schemas/replication._common.yaml @@ -49,17 +49,71 @@ components: $ref: '_common.yaml#/components/schemas/IndexName' syncing_details: $ref: '#/components/schemas/SyncingDetails' + bootstrap_details: + $ref: '#/components/schemas/RestoreDetails' + shard_replication_details: + type: array + items: + $ref: '#/components/schemas/ShardInfoResponse' + description: Per-shard replication details. Only present in verbose status responses. SyncingDetails: type: object properties: leader_checkpoint: type: integer + format: int64 description: The checkpoint of the leader index in the replication process. follower_checkpoint: type: integer + format: int64 description: The checkpoint of the follower index in the replication process. seq_no: $ref: '_common.yaml#/components/schemas/SequenceNumber' + RestoreDetails: + type: object + properties: + bytes_total: + type: integer + format: int64 + description: The total number of bytes to restore. + bytes_recovered: + type: integer + format: int64 + description: The number of bytes recovered so far. + bytes_percent: + type: number + format: float + description: The percentage of bytes recovered. + files_total: + type: integer + format: int32 + description: The total number of files to restore. + files_recovered: + type: integer + format: int32 + description: The number of files recovered so far. + files_percent: + type: number + format: float + description: The percentage of files recovered. + start_time: + type: integer + format: int64 + description: When the restore started, in epoch milliseconds. + running_time: + type: integer + format: int64 + description: The elapsed restore time in milliseconds. + ShardInfoResponse: + type: object + properties: + shard_id: + type: string + description: The shard identifier. + syncing_task_details: + $ref: '#/components/schemas/SyncingDetails' + bootstrap_task_details: + $ref: '#/components/schemas/RestoreDetails' LeaderStatus: type: object properties: diff --git a/spec/schemas/rollups._common.yaml b/spec/schemas/rollups._common.yaml index 3237d9ff2..929098ea6 100644 --- a/spec/schemas/rollups._common.yaml +++ b/spec/schemas/rollups._common.yaml @@ -208,34 +208,40 @@ components: timezone: type: string description: The timezone for interpreting the cron expression. + schedule_delay: + type: integer + format: int64 + description: The delay in milliseconds before starting the rollup process. + x-version-added: 1.3.0 Schedule: - description: Defines the execution schedule for a rollup job. + description: Defines the execution schedule for a rollup job. Exactly one of `interval` or `cron` must be specified. type: object properties: interval: $ref: '#/components/schemas/Interval' + cron: + $ref: '#/components/schemas/Cron' + minProperties: 1 + maxProperties: 1 Interval: description: Specifies the timing details for rollup job execution. type: object properties: start_time: - type: number + type: integer + format: int64 description: When the rollup job should start, in epoch milliseconds. period: - type: number + type: integer + format: int32 description: The numerical value for the execution interval. unit: type: string description: The time unit for the execution interval, such as `MINUTES` or `HOURS`. - cron: - oneOf: - - type: array - items: - $ref: '#/components/schemas/Cron' - - $ref: '#/components/schemas/Cron' - description: The cron schedule configuration for the rollup job. schedule_delay: - type: number - description: The delay in milliseconds before starting the rollup process. \ No newline at end of file + type: integer + format: int64 + description: The delay in milliseconds before starting the rollup process. + x-version-added: 1.3.0 \ No newline at end of file diff --git a/spec/schemas/search_relevance._common.yaml b/spec/schemas/search_relevance._common.yaml index 9885a3fcb..a0efa8ad0 100644 --- a/spec/schemas/search_relevance._common.yaml +++ b/spec/schemas/search_relevance._common.yaml @@ -13,6 +13,22 @@ components: type: string experiment_result: type: string + PatchExperimentRequest: + type: object + description: Partially updates an experiment's name or description. + properties: + name: + type: string + description: + type: string + minProperties: 1 + PatchExperimentResponse: + type: object + properties: + experiment_id: + type: string + experiment_result: + type: string PutSearchConfigurationResponse: type: object properties: @@ -101,6 +117,8 @@ components: type: string querySetSize: type: integer + ubiQueriesIndex: + type: string PutQuerySetsRequest: type: object description: The schema for updating a query set. @@ -174,11 +192,11 @@ components: properties: name: type: string - index: - type: string description: type: string x-version-added: '3.5' + index: + type: string query: type: string searchPipeline: diff --git a/spec/schemas/security._common.yaml b/spec/schemas/security._common.yaml index 6fe8cde9c..5ece0aaf2 100644 --- a/spec/schemas/security._common.yaml +++ b/spec/schemas/security._common.yaml @@ -187,12 +187,24 @@ components: CertificatesDetail: type: object properties: - issuer_dn: + format: + type: string + x-version-added: 3.0.0 + alias: type: string + x-version-added: 3.0.0 subject_dn: type: string san: type: string + serial_number: + type: string + x-version-added: 3.0.0 + issuer_dn: + type: string + has_private_key: + type: boolean + x-version-added: 3.0.0 not_before: type: string not_after: @@ -346,6 +358,10 @@ components: password_validation_regex: type: string description: The regular expression used perform password validation. + resource_sharing_enabled: + type: boolean + description: Indicates whether resource sharing is enabled. + x-version-added: 3.3.0 DistinguishedNames: type: object @@ -810,6 +826,8 @@ components: type: boolean is_node_certificate_request: type: boolean + is_authenticated: + type: boolean TenantInfo: type: object diff --git a/spec/schemas/security_analytics.alerts.yaml b/spec/schemas/security_analytics.alerts.yaml index 8a9314cfe..2a578605e 100644 --- a/spec/schemas/security_analytics.alerts.yaml +++ b/spec/schemas/security_analytics.alerts.yaml @@ -13,7 +13,7 @@ components: $ref: '#/components/schemas/Alerts' total_alerts: type: integer - format: int64 + format: int32 required: - alerts - total_alerts diff --git a/spec/schemas/security_analytics.findings.yaml b/spec/schemas/security_analytics.findings.yaml index 80e0152c9..8d643d1ec 100644 --- a/spec/schemas/security_analytics.findings.yaml +++ b/spec/schemas/security_analytics.findings.yaml @@ -11,7 +11,7 @@ components: properties: total_findings: type: integer - format: int64 + format: int32 findings: $ref: '#/components/schemas/Findings' required: @@ -101,7 +101,7 @@ components: type: string score: type: number - format: float + format: double rules: type: array items: diff --git a/spec/schemas/ubi._common.yaml b/spec/schemas/ubi._common.yaml index 36d9a40ff..891abd419 100644 --- a/spec/schemas/ubi._common.yaml +++ b/spec/schemas/ubi._common.yaml @@ -7,4 +7,7 @@ paths: {} components: schemas: Initialize: - type: string \ No newline at end of file + type: object + properties: + message: + type: string diff --git a/spec/schemas/wlm._common.yaml b/spec/schemas/wlm._common.yaml index a928de8b8..5b480b618 100644 --- a/spec/schemas/wlm._common.yaml +++ b/spec/schemas/wlm._common.yaml @@ -94,6 +94,109 @@ components: $ref: '#/components/schemas/ResiliencyMode' resource_limits: $ref: '#/components/schemas/ResourceLimitsSchema' + WorkloadGroupResponse: + type: object + properties: + _id: + description: The ID of the workload group, which can be used to associate query requests with the group and enforce the group's resource limits. + type: string + name: + description: The name of the workload group. + type: string + resiliency_mode: + description: The resiliency mode of the workload group. + $ref: '#/components/schemas/ResiliencyMode' + updated_at: + description: The time at which the workload group was last updated. + type: integer + format: int64 + resource_limits: + description: The resource limits for query requests in the workload group. + anyOf: + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - memory + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - cpu + settings: + type: object + additionalProperties: + type: string + description: The settings for the workload group. + x-version-added: 3.7.0 + required: + - _id + - name + - resiliency_mode + - resource_limits + - updated_at + WorkloadGroupCreate: + type: object + properties: + name: + type: string + resiliency_mode: + $ref: '#/components/schemas/ResiliencyMode' + resource_limits: + anyOf: + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - memory + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - cpu + settings: + type: object + additionalProperties: + type: string + description: The settings for the workload group. + x-version-added: 3.7.0 + required: + - name + - resiliency_mode + - resource_limits + WorkloadGroupUpdate: + type: object + properties: + resiliency_mode: + $ref: '#/components/schemas/ResiliencyMode' + resource_limits: + $ref: '#/components/schemas/ResourceLimitsSchema' + settings: + type: object + additionalProperties: + type: string + description: The settings for the workload group. + x-version-added: 3.7.0 ResourceLimitsSchema: type: object properties: