Use consistent naming for API when used in a word (#2465) (#2470)

* Use consistent naming for API when used in a word * More renaming (cherry picked from commit 071b2f7) Co-authored-by: Sylvain Wallez <[email protected]>
elastic · Mar 27, 2024 · b2c13a0 · b2c13a0
1 parent d58b58f
commit b2c13a0
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 52 deletions.
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/security/query_api_keys/QueryApiKeysRequest.ts b/specification/security/query_api_keys/QueryApiKeysRequest.ts
@@ -18,7 +18,7 @@
  */
 
 import { Dictionary } from '@spec_utils/Dictionary'
-import { APIKeyAggregationContainer, APIKeyQueryContainer } from './types'
+import { ApiKeyAggregationContainer, ApiKeyQueryContainer } from './types'
 import { RequestBase } from '@_types/Base'
 import { integer } from '@_types/Numeric'
 import { Sort, SortResults } from '@_types/sort'
@@ -49,7 +49,7 @@ export interface Request extends RequestBase {
      * `cardinality`, `value_count`, `composite`, `filter`, and `filters`.
      * Additionally, aggregations only run over the same subset of fields that query works with.
      * @aliases aggs */
-    aggregations?: Dictionary<string, APIKeyAggregationContainer>
+    aggregations?: Dictionary<string, ApiKeyAggregationContainer>
     /**
      * A query to filter which API keys to return.
      * If the query parameter is missing, it is equivalent to a `match_all` query.
@@ -58,7 +58,7 @@ export interface Request extends RequestBase {
      * You can query the following public information associated with an API key: `id`, `type`, `name`,
      * `creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`.
      */
-    query?: APIKeyQueryContainer
+    query?: ApiKeyQueryContainer
     /**
      * Starting document offset.
      * By default, you cannot page through more than 10,000 hits using the from and size parameters.

diff --git a/specification/security/query_api_keys/QueryApiKeysResponse.ts b/specification/security/query_api_keys/QueryApiKeysResponse.ts
@@ -21,7 +21,7 @@ import { ApiKey } from '@security/_types/ApiKey'
 import { integer } from '@_types/Numeric'
 import { Dictionary } from '@spec_utils/Dictionary'
 import { AggregateName } from '@_types/common'
-import { APIKeyAggregate } from './types'
+import { ApiKeyAggregate } from './types'
 
 export class Response {
   body: {
@@ -40,6 +40,6 @@ export class Response {
     /**
      * The aggregations result, if requested.
      */
-    aggregations?: Dictionary<AggregateName, APIKeyAggregate>
+    aggregations?: Dictionary<AggregateName, ApiKeyAggregate>
   }
 }
diff --git a/specification/security/query_api_keys/types.ts b/specification/security/query_api_keys/types.ts
@@ -65,14 +65,14 @@ import {
  * @variants container
  * @non_exhaustive
  */
-export class APIKeyAggregationContainer {
+export class ApiKeyAggregationContainer {
   /**
    * Sub-aggregations for this aggregation.
    * Only applies to bucket aggregations.
    * @variant container_property
    * @aliases aggs
    */
-  aggregations?: Dictionary<string, APIKeyAggregationContainer>
+  aggregations?: Dictionary<string, ApiKeyAggregationContainer>
   /**
    * @variant container_property
    */
@@ -96,12 +96,12 @@ export class APIKeyAggregationContainer {
    * A single bucket aggregation that narrows the set of documents to those that match a query.
    * @doc_id search-aggregations-bucket-filter-aggregation
    */
-  filter?: APIKeyQueryContainer
+  filter?: ApiKeyQueryContainer
   /**
    * A multi-bucket aggregation where each bucket contains the documents that match a query.
    * @doc_id search-aggregations-bucket-filters-aggregation
    */
-  filters?: APIKeyFiltersAggregation
+  filters?: ApiKeyFiltersAggregation
   missing?: MissingAggregation
   /**
    * A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.
@@ -124,7 +124,7 @@ export class APIKeyAggregationContainer {
  * @variants external
  * @non_exhaustive
  */
-export type APIKeyAggregate =
+export type ApiKeyAggregate =
   | CardinalityAggregate
   | ValueCountAggregate
   | StringTermsAggregate
@@ -143,7 +143,7 @@ export type APIKeyAggregate =
  * @variants container
  * @non_exhaustive
  */
-export class APIKeyQueryContainer {
+export class ApiKeyQueryContainer {
   /**
    * matches documents matching boolean combinations of other queries.
    * @doc_id query-dsl-bool-query
@@ -205,11 +205,11 @@ export class APIKeyQueryContainer {
   wildcard?: SingleKeyDictionary<Field, WildcardQuery>
 }
 
-export class APIKeyFiltersAggregation extends BucketAggregationBase {
+export class ApiKeyFiltersAggregation extends BucketAggregationBase {
   /**
    * Collection of queries from which to build buckets.
    */
-  filters?: Buckets<APIKeyQueryContainer>
+  filters?: Buckets<ApiKeyQueryContainer>
   /**
    * Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.
    */