Skip to content
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.

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

Query API key - Rest spec and yaml tests #76238

Merged
merged 2 commits into from
Aug 17, 2021

Conversation

ywangd
Copy link
Member

@ywangd ywangd commented Aug 9, 2021

This PR adds Rest API spec and related yaml tests for the new Query API key API.

Relates: #71023

@ywangd ywangd added >enhancement :Security/Security Security issues without another label v7.15.0 v8.0.0-alpha1 labels Aug 9, 2021
@ywangd ywangd force-pushed the api-key-search-api-spec-yaml-tests branch from e124ddf to 44c7fc6 Compare August 9, 2021 22:43
@ywangd ywangd force-pushed the api-key-search-api-spec-yaml-tests branch from 44c7fc6 to 03d784d Compare August 13, 2021 23:12
@ywangd ywangd mentioned this pull request Aug 13, 2021
5 tasks
@ywangd ywangd marked this pull request as ready for review August 13, 2021 23:15
@elasticmachine elasticmachine added the Team:Security Meta label for security team label Aug 13, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

@ywangd ywangd requested a review from tvernum August 13, 2021 23:16
@ywangd ywangd added the Team:Clients Meta label for clients team label Aug 13, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/clients-team (Team:Clients)

@@ -0,0 +1,30 @@
{
"security.query_api_key":{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this API is very similar to search in that it has a top-level query object what are your thoughts on renaming to search_api_key[s]?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We discussed about the name previously and query was picked over search on purpose. This is because regular search does a lot more than just query, e.g. aggregation, highlighting etc. The name query is indicative that this API only supports the query field of the regular search API. The existing query watches API was also named "query" for the same reasons.

I am OK to use the plural form, i.e. query_api_keys, which is also more consistent with query_watches.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me! Thanks for making me aware of query_watches, hadn't used that API before. Will keep this prefix in mind for the future.

Copy link
Contributor

@tvernum tvernum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ywangd ywangd merged commit 55cd7bb into elastic:master Aug 17, 2021
ywangd added a commit to ywangd/elasticsearch that referenced this pull request Aug 17, 2021
This PR adds Rest API spec and related yaml tests for the new Query API key API.

Relates: elastic#71023
ywangd added a commit that referenced this pull request Aug 17, 2021
This PR adds Rest API spec and related yaml tests for the new Query API key API.

Relates: #71023
wjp719 added a commit to wjp719/elasticsearch that referenced this pull request Aug 17, 2021
* master: (868 commits)
  Query API key - Rest spec and yaml tests (elastic#76238)
  Delay shard reassignment from nodes which are known to be restarting (elastic#75606)
  Reenable bwc tests for elastic#76475 (elastic#76576)
  Set version to 7.15 in BWC code (elastic#76577)
  Don't remove warning headers on all failure (elastic#76434)
  Disable bwc tests for elastic#76475 (elastic#76541)
  Re-enable bwc tests (elastic#76567)
  Keep track of data recovered from snapshots in RecoveryState (elastic#76499)
  [Transform] Align transform checkpoint range with date_histogram interval for better performance (elastic#74004)
  EQL: Remove "wildcard" function (elastic#76099)
  Fix 'accept' and 'content_type' fields for search_mvt API
  Add persistent licensed feature tracking (elastic#76476)
  Add system data streams to feature state snapshots (elastic#75902)
  fix the error message for instance methods that don't exist (elastic#76512)
  ILM: Add validation of the number_of_shards parameter in Shrink Action of ILM (elastic#74219)
  remove dashboard only reserved role (elastic#76507)
  Fix Stack Overflow in UnassignedInfo in Corner Case (elastic#76480)
  Add (Extended)KeyUsage KeyUsage, CipherSuite & Protocol to SSL diagnostics (elastic#65634)
  Add recovery from snapshot to tests (elastic#76535)
  Reenable BwC Tests after elastic#76532 (elastic#76534)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>enhancement :Security/Security Security issues without another label Team:Clients Meta label for clients team Team:Security Meta label for security team v7.15.0 v8.0.0-alpha2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants