Skip to content

Conversation

@ankit--sethi
Copy link
Contributor

Updating API spec for the /_security/_authenticate API to add a couple of new fields, internal and managed_by that are applicable to API Keys

export class AuthenticateApiKey {
id: Id
name?: Name
managed_by: AuthenticateApiKeyManagedBy
Copy link
Contributor Author

@ankit--sethi ankit--sethi Sep 8, 2025

Choose a reason for hiding this comment

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

slightly verbose name to avoid a naming conflict that comes up when using ManagedBy:

ManagedBy is present in multiple namespaces: indices._types and security.authenticate

Copy link
Member

Choose a reason for hiding this comment

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

Do you we have plans to add managed_by to other APIs? If yes it should be added under specification/security so that it's not specific to this API.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll raise this internally but to my knowledge, this is specific to this api currently. Will refactor if we come back here again!

Copy link
Member

@pquentin pquentin Sep 11, 2025

Choose a reason for hiding this comment

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

Right, thank you! Actually, a refactor here would be a breaking change for some clients that expose the specification hierarchy, which is why I asked.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2025

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.

@ankit--sethi ankit--sethi added the skip-backport This pull request should not be backported label Sep 8, 2025
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM.

@ankit--sethi ankit--sethi merged commit 66ddd71 into main Sep 11, 2025
9 of 10 checks passed
@ankit--sethi ankit--sethi deleted the feature/update-authenticate-specs branch September 11, 2025 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-backport This pull request should not be backported specification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants