From 32101dc6eb8881f537bad367e56a77a04efc9237 Mon Sep 17 00:00:00 2001 From: Florian Bernd Date: Thu, 14 Mar 2024 13:02:22 +0100 Subject: [PATCH 1/2] Add missing `codegen_name` annotations to all value bodied responses --- specification/_global/get_source/SourceResponse.ts | 1 + specification/esql/query/QueryResponse.ts | 1 + specification/indices/get/IndicesGetResponse.ts | 1 + specification/indices/get_alias/IndicesGetAliasResponse.ts | 1 + .../indices/get_field_mapping/IndicesGetFieldMappingResponse.ts | 1 + specification/indices/get_mapping/IndicesGetMappingResponse.ts | 1 + specification/indices/get_template/IndicesGetTemplateResponse.ts | 1 + 7 files changed, 7 insertions(+) diff --git a/specification/_global/get_source/SourceResponse.ts b/specification/_global/get_source/SourceResponse.ts index 5c473eff5e..2c23f3c82e 100644 --- a/specification/_global/get_source/SourceResponse.ts +++ b/specification/_global/get_source/SourceResponse.ts @@ -18,5 +18,6 @@ */ export class Response { + /** @codegen_name source */ body: TDocument } diff --git a/specification/esql/query/QueryResponse.ts b/specification/esql/query/QueryResponse.ts index 25f71b15be..0c44745c6b 100644 --- a/specification/esql/query/QueryResponse.ts +++ b/specification/esql/query/QueryResponse.ts @@ -20,5 +20,6 @@ import { EsqlColumns } from '@_types/Binary' export class Response { + /** @codegen_name data */ body: EsqlColumns } diff --git a/specification/indices/get/IndicesGetResponse.ts b/specification/indices/get/IndicesGetResponse.ts index f239a4f3a3..1ed5c38c7d 100644 --- a/specification/indices/get/IndicesGetResponse.ts +++ b/specification/indices/get/IndicesGetResponse.ts @@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { IndexName } from '@_types/common' export class Response { + /** @codegen_name indices */ body: Dictionary } diff --git a/specification/indices/get_alias/IndicesGetAliasResponse.ts b/specification/indices/get_alias/IndicesGetAliasResponse.ts index 70e38996e6..21ebed7999 100644 --- a/specification/indices/get_alias/IndicesGetAliasResponse.ts +++ b/specification/indices/get_alias/IndicesGetAliasResponse.ts @@ -24,6 +24,7 @@ import { ErrorResponseBase } from '@_types/Base' import { IndexName } from '@_types/common' export class Response { + /** @codegen_name aliases */ body: Dictionary exceptions: [ { diff --git a/specification/indices/get_field_mapping/IndicesGetFieldMappingResponse.ts b/specification/indices/get_field_mapping/IndicesGetFieldMappingResponse.ts index eebb1aac55..2269252894 100644 --- a/specification/indices/get_field_mapping/IndicesGetFieldMappingResponse.ts +++ b/specification/indices/get_field_mapping/IndicesGetFieldMappingResponse.ts @@ -22,5 +22,6 @@ import { IndexName } from '@_types/common' import { TypeFieldMappings } from './types' export class Response { + /** @codegen_name field_mappings */ body: Dictionary } diff --git a/specification/indices/get_mapping/IndicesGetMappingResponse.ts b/specification/indices/get_mapping/IndicesGetMappingResponse.ts index a3b14f54c7..86be261e3d 100644 --- a/specification/indices/get_mapping/IndicesGetMappingResponse.ts +++ b/specification/indices/get_mapping/IndicesGetMappingResponse.ts @@ -22,6 +22,7 @@ import { IndexName } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' export class Response { + /** @codegen_name index_mappings */ body: Dictionary } diff --git a/specification/indices/get_template/IndicesGetTemplateResponse.ts b/specification/indices/get_template/IndicesGetTemplateResponse.ts index af113bd3e9..14be5ebaff 100644 --- a/specification/indices/get_template/IndicesGetTemplateResponse.ts +++ b/specification/indices/get_template/IndicesGetTemplateResponse.ts @@ -21,5 +21,6 @@ import { TemplateMapping } from '@indices/_types/TemplateMapping' import { Dictionary } from '@spec_utils/Dictionary' export class Response { + /** @codegen_name template_mappings */ body: Dictionary } From 86006e34836fb12823bf7a4f3de990e21da9274b Mon Sep 17 00:00:00 2001 From: Florian Bernd Date: Fri, 22 Mar 2024 15:53:39 +0100 Subject: [PATCH 2/2] Annotate missing bodies --- specification/_global/search_mvt/SearchMvtResponse.ts | 1 + specification/cluster/remote_info/ClusterRemoteInfoResponse.ts | 1 + specification/ilm/get_lifecycle/GetLifecycleResponse.ts | 1 + specification/indices/disk_usage/IndicesDiskUsageResponse.ts | 1 + specification/indices/downsample/Response.ts | 1 + specification/indices/get_mapping/IndicesGetMappingResponse.ts | 2 +- .../indices/get_settings/IndicesGetSettingsResponse.ts | 1 + .../indices/get_template/IndicesGetTemplateResponse.ts | 2 +- .../promote_data_stream/IndicesPromoteDataStreamResponse.ts | 1 + specification/indices/recovery/IndicesRecoveryResponse.ts | 1 + specification/indices/resolve_cluster/ResolveClusterResponse.ts | 1 + specification/ingest/get_pipeline/GetPipelineResponse.ts | 1 + .../logstash/get_pipeline/LogstashGetPipelineResponse.ts | 1 + specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts | 1 + .../rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts | 1 + .../get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts | 1 + .../get_behavioral_analytics/BehavioralAnalyticsGetResponse.ts | 1 + .../clear_cache/SearchableSnapshotsClearCacheResponse.ts | 1 + .../delete_privileges/SecurityDeletePrivilegesResponse.ts | 1 + .../security/get_privileges/SecurityGetPrivilegesResponse.ts | 1 + specification/security/get_role/SecurityGetRoleResponse.ts | 1 + .../security/get_role_mapping/SecurityGetRoleMappingResponse.ts | 1 + .../security/get_service_accounts/GetServiceAccountsResponse.ts | 1 + specification/security/get_user/SecurityGetUserResponse.ts | 1 + .../security/put_privileges/SecurityPutPrivilegesResponse.ts | 1 + specification/slm/get_lifecycle/GetSnapshotLifecycleResponse.ts | 1 + 26 files changed, 26 insertions(+), 2 deletions(-) diff --git a/specification/_global/search_mvt/SearchMvtResponse.ts b/specification/_global/search_mvt/SearchMvtResponse.ts index 691bf7d06c..83379eb334 100644 --- a/specification/_global/search_mvt/SearchMvtResponse.ts +++ b/specification/_global/search_mvt/SearchMvtResponse.ts @@ -20,5 +20,6 @@ import { MapboxVectorTiles } from '@_types/Binary' export class Response { + /** @codegen_name vector_tiles */ body: MapboxVectorTiles } diff --git a/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts b/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts index 1b38ee1dc6..583dc6c499 100644 --- a/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts +++ b/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts @@ -22,6 +22,7 @@ import { integer, long } from '@_types/Numeric' import { Duration } from '@_types/Time' export class Response { + /** @codegen_name infos */ body: Dictionary } diff --git a/specification/ilm/get_lifecycle/GetLifecycleResponse.ts b/specification/ilm/get_lifecycle/GetLifecycleResponse.ts index 80e5ee99f3..a31e5bb104 100644 --- a/specification/ilm/get_lifecycle/GetLifecycleResponse.ts +++ b/specification/ilm/get_lifecycle/GetLifecycleResponse.ts @@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Lifecycle } from './types' export class Response { + /** @codegen_name lifecycles */ body: Dictionary } diff --git a/specification/indices/disk_usage/IndicesDiskUsageResponse.ts b/specification/indices/disk_usage/IndicesDiskUsageResponse.ts index f4ed729ed2..5353940902 100644 --- a/specification/indices/disk_usage/IndicesDiskUsageResponse.ts +++ b/specification/indices/disk_usage/IndicesDiskUsageResponse.ts @@ -20,5 +20,6 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { + /** @codegen_name disk_usage */ body: UserDefinedValue } diff --git a/specification/indices/downsample/Response.ts b/specification/indices/downsample/Response.ts index 9e71df5410..634d3d0e5e 100644 --- a/specification/indices/downsample/Response.ts +++ b/specification/indices/downsample/Response.ts @@ -20,5 +20,6 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { + /** @codegen_name result */ body: UserDefinedValue // TODO: This API is experimental and no docs exist describing it. Requires reverse engineering if made stable } diff --git a/specification/indices/get_mapping/IndicesGetMappingResponse.ts b/specification/indices/get_mapping/IndicesGetMappingResponse.ts index 86be261e3d..e2e69a801f 100644 --- a/specification/indices/get_mapping/IndicesGetMappingResponse.ts +++ b/specification/indices/get_mapping/IndicesGetMappingResponse.ts @@ -22,7 +22,7 @@ import { IndexName } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' export class Response { - /** @codegen_name index_mappings */ + /** @codegen_name mappings */ body: Dictionary } diff --git a/specification/indices/get_settings/IndicesGetSettingsResponse.ts b/specification/indices/get_settings/IndicesGetSettingsResponse.ts index f239a4f3a3..bdd6cd6684 100644 --- a/specification/indices/get_settings/IndicesGetSettingsResponse.ts +++ b/specification/indices/get_settings/IndicesGetSettingsResponse.ts @@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { IndexName } from '@_types/common' export class Response { + /** @codegen_name settings */ body: Dictionary } diff --git a/specification/indices/get_template/IndicesGetTemplateResponse.ts b/specification/indices/get_template/IndicesGetTemplateResponse.ts index 14be5ebaff..ca05d4c586 100644 --- a/specification/indices/get_template/IndicesGetTemplateResponse.ts +++ b/specification/indices/get_template/IndicesGetTemplateResponse.ts @@ -21,6 +21,6 @@ import { TemplateMapping } from '@indices/_types/TemplateMapping' import { Dictionary } from '@spec_utils/Dictionary' export class Response { - /** @codegen_name template_mappings */ + /** @codegen_name templates */ body: Dictionary } diff --git a/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts b/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts index f4ed729ed2..6a01ac73d6 100644 --- a/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts +++ b/specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts @@ -20,5 +20,6 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { + /** @codegen_name result */ body: UserDefinedValue } diff --git a/specification/indices/recovery/IndicesRecoveryResponse.ts b/specification/indices/recovery/IndicesRecoveryResponse.ts index 41a96e1b7f..8bb90bd739 100644 --- a/specification/indices/recovery/IndicesRecoveryResponse.ts +++ b/specification/indices/recovery/IndicesRecoveryResponse.ts @@ -22,5 +22,6 @@ import { IndexName } from '@_types/common' import { RecoveryStatus } from './types' export class Response { + /** @codegen_name statuses */ body: Dictionary } diff --git a/specification/indices/resolve_cluster/ResolveClusterResponse.ts b/specification/indices/resolve_cluster/ResolveClusterResponse.ts index 02a8d6b5c6..f56f769877 100644 --- a/specification/indices/resolve_cluster/ResolveClusterResponse.ts +++ b/specification/indices/resolve_cluster/ResolveClusterResponse.ts @@ -22,6 +22,7 @@ import { Dictionary } from '@spec_utils/Dictionary' import { ElasticsearchVersionMinInfo } from '@_types/Base' export class Response { + /** @codegen_name infos */ body: Dictionary } diff --git a/specification/ingest/get_pipeline/GetPipelineResponse.ts b/specification/ingest/get_pipeline/GetPipelineResponse.ts index fd7e39c492..d8754f4af3 100644 --- a/specification/ingest/get_pipeline/GetPipelineResponse.ts +++ b/specification/ingest/get_pipeline/GetPipelineResponse.ts @@ -21,5 +21,6 @@ import { Pipeline } from '@ingest/_types/Pipeline' import { Dictionary } from '@spec_utils/Dictionary' export class Response { + /** @codegen_name pipelines */ body: Dictionary } diff --git a/specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts b/specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts index 31565a44f7..aff10ff475 100644 --- a/specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts +++ b/specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts @@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Id } from '@_types/common' export class Response { + /** @codegen_name pipelines */ body: Dictionary } diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts index 87d7400ddb..d456dbec47 100644 --- a/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts +++ b/specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts @@ -18,5 +18,6 @@ */ export class Response { + /** @codegen_name documents */ body: Array } diff --git a/specification/rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts index 82055ceabf..8c6d239f21 100644 --- a/specification/rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts +++ b/specification/rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts @@ -22,5 +22,6 @@ import { IndexName } from '@_types/common' import { RollupCapabilities } from './types' export class Response { + /** @codegen_name capabilities */ body: Dictionary } diff --git a/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts index 96e919aee3..89ccd3543b 100644 --- a/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts +++ b/specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts @@ -22,5 +22,6 @@ import { IndexName } from '@_types/common' import { IndexCapabilities } from './types' export class Response { + /** @codegen_name capabilities */ body: Dictionary } diff --git a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponse.ts b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponse.ts index ef6d9ab675..2e851cdae5 100644 --- a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponse.ts +++ b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponse.ts @@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Name } from '@_types/common' export class Response { + /** @codegen_name analytics */ body: Dictionary } diff --git a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts index f4ed729ed2..6a01ac73d6 100644 --- a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts +++ b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts @@ -20,5 +20,6 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class Response { + /** @codegen_name result */ body: UserDefinedValue } diff --git a/specification/security/delete_privileges/SecurityDeletePrivilegesResponse.ts b/specification/security/delete_privileges/SecurityDeletePrivilegesResponse.ts index 3d74ffb330..0e9a03db8c 100644 --- a/specification/security/delete_privileges/SecurityDeletePrivilegesResponse.ts +++ b/specification/security/delete_privileges/SecurityDeletePrivilegesResponse.ts @@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { FoundStatus } from './types' export class Response { + /** @codegen_name result */ body: Dictionary> } diff --git a/specification/security/get_privileges/SecurityGetPrivilegesResponse.ts b/specification/security/get_privileges/SecurityGetPrivilegesResponse.ts index 1790b4e85a..eb1370188b 100644 --- a/specification/security/get_privileges/SecurityGetPrivilegesResponse.ts +++ b/specification/security/get_privileges/SecurityGetPrivilegesResponse.ts @@ -21,5 +21,6 @@ import { Actions } from '@security/put_privileges/types' import { Dictionary } from '@spec_utils/Dictionary' export class Response { + /** @codegen_name privileges */ body: Dictionary> } diff --git a/specification/security/get_role/SecurityGetRoleResponse.ts b/specification/security/get_role/SecurityGetRoleResponse.ts index 45da953721..da2520f6ce 100644 --- a/specification/security/get_role/SecurityGetRoleResponse.ts +++ b/specification/security/get_role/SecurityGetRoleResponse.ts @@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Role } from './types' export class Response { + /** @codegen_name roles */ body: Dictionary } diff --git a/specification/security/get_role_mapping/SecurityGetRoleMappingResponse.ts b/specification/security/get_role_mapping/SecurityGetRoleMappingResponse.ts index 5ea800a3dd..628a94bc7a 100644 --- a/specification/security/get_role_mapping/SecurityGetRoleMappingResponse.ts +++ b/specification/security/get_role_mapping/SecurityGetRoleMappingResponse.ts @@ -21,5 +21,6 @@ import { RoleMapping } from '@security/_types/RoleMapping' import { Dictionary } from '@spec_utils/Dictionary' export class Response { + /** @codegen_name role_mappings */ body: Dictionary } diff --git a/specification/security/get_service_accounts/GetServiceAccountsResponse.ts b/specification/security/get_service_accounts/GetServiceAccountsResponse.ts index 0d003b88ae..1f6adaad96 100644 --- a/specification/security/get_service_accounts/GetServiceAccountsResponse.ts +++ b/specification/security/get_service_accounts/GetServiceAccountsResponse.ts @@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { RoleDescriptorWrapper } from './types' export class Response { + /** @codegen_name service_accoutns */ body: Dictionary } diff --git a/specification/security/get_user/SecurityGetUserResponse.ts b/specification/security/get_user/SecurityGetUserResponse.ts index 66276fcdb5..46bdc603f9 100644 --- a/specification/security/get_user/SecurityGetUserResponse.ts +++ b/specification/security/get_user/SecurityGetUserResponse.ts @@ -21,5 +21,6 @@ import { User } from '@security/_types/User' import { Dictionary } from '@spec_utils/Dictionary' export class Response { + /** @codegen_name users */ body: Dictionary } diff --git a/specification/security/put_privileges/SecurityPutPrivilegesResponse.ts b/specification/security/put_privileges/SecurityPutPrivilegesResponse.ts index 7f9b1f029d..c84a510cca 100644 --- a/specification/security/put_privileges/SecurityPutPrivilegesResponse.ts +++ b/specification/security/put_privileges/SecurityPutPrivilegesResponse.ts @@ -21,5 +21,6 @@ import { CreatedStatus } from '@security/_types/CreatedStatus' import { Dictionary } from '@spec_utils/Dictionary' export class Response { + /** @codegen_name result */ body: Dictionary> } diff --git a/specification/slm/get_lifecycle/GetSnapshotLifecycleResponse.ts b/specification/slm/get_lifecycle/GetSnapshotLifecycleResponse.ts index 9a4226583e..142d57053f 100644 --- a/specification/slm/get_lifecycle/GetSnapshotLifecycleResponse.ts +++ b/specification/slm/get_lifecycle/GetSnapshotLifecycleResponse.ts @@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary' import { Id } from '@_types/common' export class Response { + /** @codegen_name lifecycles */ body: Dictionary }