Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 27, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
648176c
Use consistent naming for API when used in a word
swallez Mar 25, 2024
efa45da
More renaming
swallez Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 11 additions & 11 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion output/schema/validation-errors.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 13 additions & 13 deletions output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions specification/security/query_api_keys/QueryApiKeysRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions specification/security/query_api_keys/QueryApiKeysResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand All @@ -40,6 +40,6 @@ export class Response {
/**
* The aggregations result, if requested.
*/
aggregations?: Dictionary<AggregateName, APIKeyAggregate>
aggregations?: Dictionary<AggregateName, ApiKeyAggregate>
}
}
16 changes: 8 additions & 8 deletions specification/security/query_api_keys/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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.
Expand All @@ -124,7 +124,7 @@ export class APIKeyAggregationContainer {
* @variants external
* @non_exhaustive
*/
export type APIKeyAggregate =
export type ApiKeyAggregate =
| CardinalityAggregate
| ValueCountAggregate
| StringTermsAggregate
Expand All @@ -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
Expand Down Expand Up @@ -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.
*/
Expand Down