Skip to content

Commit b3539b8

Browse files
authored
Add missing codegen_name annotations to all value bodied responses (elastic#2457)
1 parent accc266 commit b3539b8

31 files changed

+31
-0
lines changed

specification/_global/get_source/SourceResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@
1818
*/
1919

2020
export class Response<TDocument> {
21+
/** @codegen_name source */
2122
body: TDocument
2223
}

specification/_global/search_mvt/SearchMvtResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
import { MapboxVectorTiles } from '@_types/Binary'
2121

2222
export class Response {
23+
/** @codegen_name vector_tiles */
2324
body: MapboxVectorTiles
2425
}

specification/cluster/remote_info/ClusterRemoteInfoResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { integer, long } from '@_types/Numeric'
2222
import { Duration } from '@_types/Time'
2323

2424
export class Response {
25+
/** @codegen_name infos */
2526
body: Dictionary<string, ClusterRemoteInfo>
2627
}
2728

specification/esql/query/QueryResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
import { EsqlColumns } from '@_types/Binary'
2121

2222
export class Response {
23+
/** @codegen_name data */
2324
body: EsqlColumns
2425
}

specification/ilm/get_lifecycle/GetLifecycleResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2121
import { Lifecycle } from './types'
2222

2323
export class Response {
24+
/** @codegen_name lifecycles */
2425
body: Dictionary<string, Lifecycle>
2526
}

specification/indices/disk_usage/IndicesDiskUsageResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
2121

2222
export class Response {
23+
/** @codegen_name disk_usage */
2324
body: UserDefinedValue
2425
}

specification/indices/downsample/Response.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
2121

2222
export class Response {
23+
/** @codegen_name result */
2324
body: UserDefinedValue // TODO: This API is experimental and no docs exist describing it. Requires reverse engineering if made stable
2425
}

specification/indices/get/IndicesGetResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2222
import { IndexName } from '@_types/common'
2323

2424
export class Response {
25+
/** @codegen_name indices */
2526
body: Dictionary<IndexName, IndexState>
2627
}

specification/indices/get_alias/IndicesGetAliasResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import { ErrorResponseBase } from '@_types/Base'
2424
import { IndexName } from '@_types/common'
2525

2626
export class Response {
27+
/** @codegen_name aliases */
2728
body: Dictionary<IndexName, IndexAliases>
2829
exceptions: [
2930
{

specification/indices/get_field_mapping/IndicesGetFieldMappingResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { IndexName } from '@_types/common'
2222
import { TypeFieldMappings } from './types'
2323

2424
export class Response {
25+
/** @codegen_name field_mappings */
2526
body: Dictionary<IndexName, TypeFieldMappings>
2627
}

specification/indices/get_mapping/IndicesGetMappingResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { IndexName } from '@_types/common'
2222
import { TypeMapping } from '@_types/mapping/TypeMapping'
2323

2424
export class Response {
25+
/** @codegen_name mappings */
2526
body: Dictionary<IndexName, IndexMappingRecord>
2627
}
2728

specification/indices/get_settings/IndicesGetSettingsResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2222
import { IndexName } from '@_types/common'
2323

2424
export class Response {
25+
/** @codegen_name settings */
2526
body: Dictionary<IndexName, IndexState>
2627
}

specification/indices/get_template/IndicesGetTemplateResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { TemplateMapping } from '@indices/_types/TemplateMapping'
2121
import { Dictionary } from '@spec_utils/Dictionary'
2222

2323
export class Response {
24+
/** @codegen_name templates */
2425
body: Dictionary<string, TemplateMapping>
2526
}

specification/indices/promote_data_stream/IndicesPromoteDataStreamResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
2121

2222
export class Response {
23+
/** @codegen_name result */
2324
body: UserDefinedValue
2425
}

specification/indices/recovery/IndicesRecoveryResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { IndexName } from '@_types/common'
2222
import { RecoveryStatus } from './types'
2323

2424
export class Response {
25+
/** @codegen_name statuses */
2526
body: Dictionary<IndexName, RecoveryStatus>
2627
}

specification/indices/resolve_cluster/ResolveClusterResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { Dictionary } from '@spec_utils/Dictionary'
2222
import { ElasticsearchVersionMinInfo } from '@_types/Base'
2323

2424
export class Response {
25+
/** @codegen_name infos */
2526
body: Dictionary<ClusterAlias, ResolveClusterInfo>
2627
}
2728

specification/ingest/get_pipeline/GetPipelineResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { Pipeline } from '@ingest/_types/Pipeline'
2121
import { Dictionary } from '@spec_utils/Dictionary'
2222

2323
export class Response {
24+
/** @codegen_name pipelines */
2425
body: Dictionary<string, Pipeline>
2526
}

specification/logstash/get_pipeline/LogstashGetPipelineResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2222
import { Id } from '@_types/common'
2323

2424
export class Response {
25+
/** @codegen_name pipelines */
2526
body: Dictionary<Id, Pipeline>
2627
}

specification/ml/preview_datafeed/MlPreviewDatafeedResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@
1818
*/
1919

2020
export class Response<TDocument> {
21+
/** @codegen_name documents */
2122
body: Array<TDocument>
2223
}

specification/rollup/get_rollup_caps/GetRollupCapabilitiesResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { IndexName } from '@_types/common'
2222
import { RollupCapabilities } from './types'
2323

2424
export class Response {
25+
/** @codegen_name capabilities */
2526
body: Dictionary<IndexName, RollupCapabilities>
2627
}

specification/rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { IndexName } from '@_types/common'
2222
import { IndexCapabilities } from './types'
2323

2424
export class Response {
25+
/** @codegen_name capabilities */
2526
body: Dictionary<IndexName, IndexCapabilities>
2627
}

specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2222
import { Name } from '@_types/common'
2323

2424
export class Response {
25+
/** @codegen_name analytics */
2526
body: Dictionary<Name, AnalyticsCollection>
2627
}

specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
2121

2222
export class Response {
23+
/** @codegen_name result */
2324
body: UserDefinedValue
2425
}

specification/security/delete_privileges/SecurityDeletePrivilegesResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2121
import { FoundStatus } from './types'
2222

2323
export class Response {
24+
/** @codegen_name result */
2425
body: Dictionary<string, Dictionary<string, FoundStatus>>
2526
}

specification/security/get_privileges/SecurityGetPrivilegesResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { Actions } from '@security/put_privileges/types'
2121
import { Dictionary } from '@spec_utils/Dictionary'
2222

2323
export class Response {
24+
/** @codegen_name privileges */
2425
body: Dictionary<string, Dictionary<string, Actions>>
2526
}

specification/security/get_role/SecurityGetRoleResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2121
import { Role } from './types'
2222

2323
export class Response {
24+
/** @codegen_name roles */
2425
body: Dictionary<string, Role>
2526
}

specification/security/get_role_mapping/SecurityGetRoleMappingResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { RoleMapping } from '@security/_types/RoleMapping'
2121
import { Dictionary } from '@spec_utils/Dictionary'
2222

2323
export class Response {
24+
/** @codegen_name role_mappings */
2425
body: Dictionary<string, RoleMapping>
2526
}

specification/security/get_service_accounts/GetServiceAccountsResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2121
import { RoleDescriptorWrapper } from './types'
2222

2323
export class Response {
24+
/** @codegen_name service_accoutns */
2425
body: Dictionary<string, RoleDescriptorWrapper>
2526
}

specification/security/get_user/SecurityGetUserResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { User } from '@security/_types/User'
2121
import { Dictionary } from '@spec_utils/Dictionary'
2222

2323
export class Response {
24+
/** @codegen_name users */
2425
body: Dictionary<string, User>
2526
}

specification/security/put_privileges/SecurityPutPrivilegesResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ import { CreatedStatus } from '@security/_types/CreatedStatus'
2121
import { Dictionary } from '@spec_utils/Dictionary'
2222

2323
export class Response {
24+
/** @codegen_name result */
2425
body: Dictionary<string, Dictionary<string, CreatedStatus>>
2526
}

specification/slm/get_lifecycle/GetSnapshotLifecycleResponse.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ import { Dictionary } from '@spec_utils/Dictionary'
2222
import { Id } from '@_types/common'
2323

2424
export class Response {
25+
/** @codegen_name lifecycles */
2526
body: Dictionary<Id, SnapshotLifecycle>
2627
}

0 commit comments

Comments
 (0)