From 9f96a576452547fe1c94f9b1b4bcaada78db345c Mon Sep 17 00:00:00 2001 From: Albert Zaharovits Date: Thu, 14 Mar 2024 17:55:02 +0200 Subject: [PATCH 1/3] Ok? --- .../query_api_keys/QueryApiKeysRequest.ts | 8 +- .../security/query_api_keys/types.ts | 114 +++++++++++++++++- 2 files changed, 114 insertions(+), 8 deletions(-) diff --git a/specification/security/query_api_keys/QueryApiKeysRequest.ts b/specification/security/query_api_keys/QueryApiKeysRequest.ts index aad744bc8c..df01a8c9a0 100644 --- a/specification/security/query_api_keys/QueryApiKeysRequest.ts +++ b/specification/security/query_api_keys/QueryApiKeysRequest.ts @@ -18,10 +18,12 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { APIKeyAggregationContainer } from './types' +import { + APIKeyAggregationContainer, + APIKeyQueryContainer +} from './types' import { RequestBase } from '@_types/Base' import { integer } from '@_types/Numeric' -import { QueryContainer } from '@_types/query_dsl/abstractions' import { Sort, SortResults } from '@_types/sort' /** @@ -59,7 +61,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?: QueryContainer + 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/types.ts b/specification/security/query_api_keys/types.ts index a8dcd57b10..bb0c66dabd 100644 --- a/specification/security/query_api_keys/types.ts +++ b/specification/security/query_api_keys/types.ts @@ -18,12 +18,30 @@ */ import { Dictionary } from '@spec_utils/Dictionary' -import { Metadata } from '@_types/common' -import { QueryContainer } from '@_types/query_dsl/abstractions' +import { SingleKeyDictionary } from '@spec_utils/Dictionary' import { + Metadata, + Field +} from '@_types/common' +import { BoolQuery } from '@_types/query_dsl/compound' +import { + ExistsQuery, + IdsQuery, + PrefixQuery, + RangeQuery, + TermQuery, + TermsQuery, + WildcardQuery +} from '@_types/query_dsl/term' +import { + MatchQuery, + SimpleQueryStringQuery +} from '@_types/query_dsl/fulltext' +import { MatchAllQuery } from '@_types/query_dsl/MatchAllQuery' +import { + BucketAggregationBase, CompositeAggregation, DateRangeAggregation, - FiltersAggregation, MissingAggregation, RangeAggregation, TermsAggregation @@ -33,6 +51,7 @@ import { ValueCountAggregation } from '@_types/aggregations/metric' import { + Buckets, CardinalityAggregate, ValueCountAggregate, StringTermsAggregate, @@ -83,12 +102,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?: QueryContainer + filter?: APIKeyQueryContainer /** * A multi-bucket aggregation where each bucket contains the documents that match a query. * @doc_id search-aggregations-bucket-filters-aggregation */ - filters?: FiltersAggregation + 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. @@ -125,3 +144,88 @@ export type APIKeyAggregate = | RangeAggregate | DateRangeAggregate | CompositeAggregate + +export class APIKeyQueryContainer { + /** + * matches documents matching boolean combinations of other queries. + * @doc_id query-dsl-bool-query + */ + bool?: BoolQuery + /** + * Returns documents that contain an indexed value for a field. + * @doc_id query-dsl-exists-query + */ + exists?: ExistsQuery + /** + * Returns documents based on their IDs. + * This query uses document IDs stored in the `_id` field. + * @doc_id query-dsl-ids-query + */ + ids?: IdsQuery + /** + * Returns documents that match a provided text, number, date or boolean value. + * The provided text is analyzed before matching. + * @doc_id query-dsl-match-query + */ + match?: SingleKeyDictionary + /** + * Matches all documents, giving them all a `_score` of 1.0. + * @doc_id query-dsl-match-all-query + */ + match_all?: MatchAllQuery + /** + * Returns documents that contain a specific prefix in a provided field. + * @doc_id query-dsl-prefix-query + */ + prefix?: SingleKeyDictionary + /** + * Returns documents that contain terms within a provided range. + * @doc_id query-dsl-range-query + */ + range?: SingleKeyDictionary + /** + * Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax. + * @doc_id query-dsl-simple-query-string-query + */ + simple_query_string?: SimpleQueryStringQuery + /** + * Returns documents that contain an exact term in a provided field. + * To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. + * @doc_id query-dsl-term-query + */ + term?: SingleKeyDictionary + /** + * Returns documents that contain one or more exact terms in a provided field. + * To return a document, one or more terms must exactly match a field value, including whitespace and capitalization. + * @doc_id query-dsl-terms-query + */ + terms?: TermsQuery + /** + * Returns documents that contain terms matching a wildcard pattern. + * @doc_id query-dsl-wildcard-query + */ + wildcard?: SingleKeyDictionary +} + +export class APIKeyFiltersAggregation extends BucketAggregationBase { + /** + * Collection of queries from which to build buckets. + */ + filters?: Buckets + /** + * Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + */ + other_bucket?: boolean + /** + * The key with which the other bucket is returned. + * @server_default _other_ + */ + other_bucket_key?: string + /** + * By default, the named filters aggregation returns the buckets as an object. + * Set to `false` to return the buckets as an array of objects. + * @server_default true + */ + keyed?: boolean +} + From e3ecfc888298f183b68ceb80002c7963812ddabd Mon Sep 17 00:00:00 2001 From: Albert Zaharovits Date: Thu, 14 Mar 2024 18:28:19 +0200 Subject: [PATCH 2/3] Update specification/security/query_api_keys/types.ts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Laurent Saint-Félix --- specification/security/query_api_keys/types.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/security/query_api_keys/types.ts b/specification/security/query_api_keys/types.ts index bb0c66dabd..421014d625 100644 --- a/specification/security/query_api_keys/types.ts +++ b/specification/security/query_api_keys/types.ts @@ -145,6 +145,10 @@ export type APIKeyAggregate = | DateRangeAggregate | CompositeAggregate +/** + * @variants container + * @non_exhaustive + */ export class APIKeyQueryContainer { /** * matches documents matching boolean combinations of other queries. From 28bdc53c5530c697ab843b4855814173b3e5e6de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laurent=20Saint-F=C3=A9lix?= Date: Thu, 14 Mar 2024 17:30:20 +0100 Subject: [PATCH 3/3] make contrib --- .../security/query_api_keys/QueryApiKeysRequest.ts | 5 +---- specification/security/query_api_keys/types.ts | 11 ++--------- 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/specification/security/query_api_keys/QueryApiKeysRequest.ts b/specification/security/query_api_keys/QueryApiKeysRequest.ts index df01a8c9a0..7932296838 100644 --- a/specification/security/query_api_keys/QueryApiKeysRequest.ts +++ b/specification/security/query_api_keys/QueryApiKeysRequest.ts @@ -18,10 +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' diff --git a/specification/security/query_api_keys/types.ts b/specification/security/query_api_keys/types.ts index 421014d625..0fdc887910 100644 --- a/specification/security/query_api_keys/types.ts +++ b/specification/security/query_api_keys/types.ts @@ -19,10 +19,7 @@ import { Dictionary } from '@spec_utils/Dictionary' import { SingleKeyDictionary } from '@spec_utils/Dictionary' -import { - Metadata, - Field -} from '@_types/common' +import { Metadata, Field } from '@_types/common' import { BoolQuery } from '@_types/query_dsl/compound' import { ExistsQuery, @@ -33,10 +30,7 @@ import { TermsQuery, WildcardQuery } from '@_types/query_dsl/term' -import { - MatchQuery, - SimpleQueryStringQuery -} from '@_types/query_dsl/fulltext' +import { MatchQuery, SimpleQueryStringQuery } from '@_types/query_dsl/fulltext' import { MatchAllQuery } from '@_types/query_dsl/MatchAllQuery' import { BucketAggregationBase, @@ -232,4 +226,3 @@ export class APIKeyFiltersAggregation extends BucketAggregationBase { */ keyed?: boolean } -