forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
REST spec and YAML tests for cross-cluster API key APIs (elastic#96339)
This PR adds REST spec files and YAML tests for the new create and update cross-cluster API key APIs. Relates: elastic#95714, elastic#96085
- Loading branch information
Showing
7 changed files
with
464 additions
and
0 deletions.
There are no files selected for viewing
34 changes: 34 additions & 0 deletions
34
...-api-spec/src/main/resources/rest-api-spec/api/security.create_cross_cluster_api_key.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"security.create_cross_cluster_api_key": { | ||
"documentation": { | ||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", | ||
"description": "Creates a cross-cluster API key for API key based remote cluster access." | ||
}, | ||
"stability": "experimental", | ||
"visibility": "feature_flag", | ||
"feature_flag": "es.untrusted_remote_cluster_feature_flag_registered", | ||
"headers": { | ||
"accept": [ | ||
"application/json" | ||
], | ||
"content_type": [ | ||
"application/json" | ||
] | ||
}, | ||
"url": { | ||
"paths": [ | ||
{ | ||
"path": "/_security/cross_cluster/api_key", | ||
"methods": [ | ||
"POST" | ||
] | ||
} | ||
] | ||
}, | ||
"params": {}, | ||
"body": { | ||
"description": "The request to create a cross-cluster API key", | ||
"required": true | ||
} | ||
} | ||
} |
39 changes: 39 additions & 0 deletions
39
...-api-spec/src/main/resources/rest-api-spec/api/security.update_cross_cluster_api_key.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{ | ||
"security.update_cross_cluster_api_key": { | ||
"documentation": { | ||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", | ||
"description": "Updates attributes of an existing cross-cluster API key." | ||
}, | ||
"stability": "experimental", | ||
"visibility": "feature_flag", | ||
"feature_flag": "es.untrusted_remote_cluster_feature_flag_registered", | ||
"headers": { | ||
"accept": [ | ||
"application/json" | ||
], | ||
"content_type": [ | ||
"application/json" | ||
] | ||
}, | ||
"url": { | ||
"paths": [ | ||
{ | ||
"path": "/_security/cross_cluster/api_key/{id}", | ||
"methods": [ | ||
"PUT" | ||
], | ||
"parts": { | ||
"id": { | ||
"type": "string", | ||
"description": "The ID of the cross-cluster API key to update" | ||
} | ||
} | ||
} | ||
] | ||
}, | ||
"body": { | ||
"description": "The request to update attributes of a cross-cluster API key.", | ||
"required": true | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[role="xpack"] | ||
[[security-api-create-cross-cluster-api-key]] | ||
=== Create Cross-Cluster API key API | ||
|
||
++++ | ||
<titleabbrev>Create Cross-Cluster API key</titleabbrev> | ||
++++ | ||
|
||
TODO: Placeholder |
9 changes: 9 additions & 0 deletions
9
x-pack/docs/en/rest-api/security/update-cross-cluster-api-key.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[role="xpack"] | ||
[[security-api-update-cross-cluster-api-key]] | ||
=== Update Cross-Cluster API key API | ||
|
||
++++ | ||
<titleabbrev>Update Cross-Cluster API key</titleabbrev> | ||
++++ | ||
|
||
TODO: Placeholder |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.