Skip to content

Commit

Permalink
[RAM] update api key to become public (#164883)
Browse files Browse the repository at this point in the history 
## Summary

[Summarize your PR. If it involves visual changes include a screenshot
or gif.](elastic/enhancements#17998)


### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

---------

Co-authored-by: lcawl <[email protected]>
  • Loading branch information
@XavierM @lcawl
XavierM and lcawl authored Aug 28, 2023
1 parent 68a6a56 commit cb97975
Show file tree
Hide file tree
Showing 13 changed files with 262 additions and 43 deletions.
63 changes: 63 additions & 0 deletions docs/api-generated/rules/rule-apis-passthru.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#unmuteAlert"><code><span class="http-method">post</span> /s/{spaceId}/api/alerting/rule/{ruleId}/alert/{alertId}/_unmute</code></a></li>
<li><a href="#unmuteAllAlerts"><code><span class="http-method">post</span> /s/{spaceId}/api/alerting/rule/{ruleId}/_unmute_all</code></a></li>
<li><a href="#updateRule"><code><span class="http-method">put</span> /s/{spaceId}/api/alerting/rule/{ruleId}</code></a></li>
<li><a href="#updateRuleAPIKey"><code><span class="http-method">post</span> /s/{spaceId}/api/alerting/rule/{ruleId}/_update_api_key</code></a></li>
</ul>
<h1><a name="Alerting">Alerting</a></h1>
Expand Down Expand Up @@ -2827,12 +2828,61 @@ Any modifications made to this file will be overwritten.
<a href="#404_response">404_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="updateRuleAPIKey"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /s/{spaceId}/api/alerting/rule/{ruleId}/_update_api_key</code></pre></div>
<div class="method-summary">Updates the API key for a rule. (<span class="nickname">updateRuleAPIKey</span>)</div>
<div class="method-notes">The new API key has the credentials of the user that submits the request.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">ruleId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the rule. default: null </div><div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Request headers</h3>
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#"></a>
<h4 class="field-label">400</h4>
Bad request
<a href="#400_response">400_response</a>
</div> <!-- method -->
<hr/>
<h2><a name="__Models">Models</a></h2>
[ Jump to <a href="#__Methods">Methods</a> ]
<h3>Table of Contents</h3>
<ol>
<li><a href="#400_response"><code>400_response</code> - Bad request</a></li>
<li><a href="#401_response"><code>401_response</code> - Unsuccessful rule API response</a></li>
<li><a href="#404_response"><code>404_response</code> - </a></li>
<li><a href="#Count"><code>Count</code> - Count</a></li>
Expand Down Expand Up @@ -2969,6 +3019,19 @@ Any modifications made to this file will be overwritten.
<li><a href="#update_rule_request"><code>update_rule_request</code> - Update rule request</a></li>
</ol>
<div class="model">
<h3><a name="400_response"><code>400_response</code> - Bad request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">error </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">Bad Request</div>
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">statusCode </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">400</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="401_response"><code>401_response</code> - Unsuccessful rule API response</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
Expand Down
26 changes: 13 additions & 13 deletions x-pack/plugins/alerting/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Table of Contents
- [Internal HTTP APIs](#internal-http-apis)
- [`GET /internal/alerting/rule/{id}/state`: Get rule state](#get-internalalertingruleidstate-get-rule-state)
- [`GET /internal/alerting/rule/{id}/_alert_summary`: Get rule alert summary](#get-internalalertingruleidalertsummary-get-rule-alert-summary)
- [`POST /internal/alerting/rule/{id}/_update_api_key`: Update rule API key](#post-internalalertingruleidupdateapikey-update-rule-api-key)
- [`POST /api/alerting/rule/{id}/_update_api_key`: Update rule API key](#post-internalalertingruleidupdateapikey-update-rule-api-key)
- [Alert Factory](#alert-factory)
- [Templating Actions](#templating-actions)
- [Examples](#examples)
Expand Down Expand Up @@ -306,7 +306,7 @@ interface MyRuleTypeAlertContext extends AlertInstanceContext {
}

type MyRuleTypeActionGroups = 'default' | 'warning';

const myRuleType: RuleType<
MyRuleTypeParams,
MyRuleTypeExtractedParams,
Expand Down Expand Up @@ -380,9 +380,9 @@ const myRuleType: RuleType<

// Only execute if CPU usage is greater than threshold
if (currentCpuUsage > threshold) {
// The first argument is a unique identifier for the alert. In this
// scenario the provided server will be used. Also, this ID will be
// used to make `getState()` return previous state, if any, on
// The first argument is a unique identifier for the alert. In this
// scenario the provided server will be used. Also, this ID will be
// used to make `getState()` return previous state, if any, on
// matching identifiers.
const alert = services.alertFactory.create(server);

Expand All @@ -395,7 +395,7 @@ const myRuleType: RuleType<
cpuUsage: currentCpuUsage,
});

// 'default' refers to the id of a group of actions to be scheduled
// 'default' refers to the id of a group of actions to be scheduled
// for execution, see 'actions' in create rule section
alert.scheduleActions('default', {
server,
Expand All @@ -406,8 +406,8 @@ const myRuleType: RuleType<
// Returning updated rule type level state, this will become available
// within the `state` function parameter at the next execution
return {
// This is an example attribute you could set, it makes more sense
// to use this state when the rule type executes multiple
// This is an example attribute you could set, it makes more sense
// to use this state when the rule type executes multiple
// alerts but wants a single place to track certain values.
lastChecked: new Date(),
};
Expand Down Expand Up @@ -497,7 +497,7 @@ features.registerKibanaFeature({
// grant `read` over our own type
'my-application-id.my-alert-type',
// grant `read` over the built-in IndexThreshold
'.index-threshold',
'.index-threshold',
// grant `read` over Uptime's TLS RuleType
'xpack.uptime.alerts.actionGroups.tls'
],
Expand All @@ -507,7 +507,7 @@ features.registerKibanaFeature({
// grant `read` over our own type
'my-application-id.my-alert-type',
// grant `read` over the built-in IndexThreshold
'.index-threshold',
'.index-threshold',
// grant `read` over Uptime's TLS RuleType
'xpack.uptime.alerts.actionGroups.tls'
],
Expand Down Expand Up @@ -555,15 +555,15 @@ features.registerKibanaFeature({
read: [
'my-application-id.my-restricted-rule-type'
],
},
},
alert: {
all: [
'my-application-id.my-rule-type'
],
read: [
'my-application-id.my-restricted-rule-type'
],
},
},
},
savedObject: {
all: [],
Expand Down Expand Up @@ -798,7 +798,7 @@ Query:
|---|---|---|
|dateStart|The date to start looking for alert events in the event log. Either an ISO date string, or a duration string indicating time since now.|string|

### `POST /internal/alerting/rule/{id}/_update_api_key`: Update rule API key
### `POST /api/alerting/rule/{id}/_update_api_key`: Update rule API key

|Property|Description|Type|
|---|---|---|
Expand Down
102 changes: 87 additions & 15 deletions x-pack/plugins/alerting/docs/openapi/bundled.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,26 @@
"url": "https://www.elastic.co/licensing/elastic-license"
}
},
"tags": [
{
"name": "alerting",
"description": "Alerting APIs enable you to create and manage rules and alerts."
}
],
"servers": [
{
"url": "http://localhost:5601",
"description": "local"
}
],
"security": [
{
"basicAuth": []
},
{
"apiKeyAuth": []
}
],
"tags": [
{
"name": "alerting",
"description": "Alerting APIs enable you to create and manage rules and alerts."
}
],
"paths": {
"/s/{spaceId}/api/alerting/rule": {
"post": {
Expand Down Expand Up @@ -1188,6 +1196,52 @@
}
]
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/_update_api_key": {
"post": {
"summary": "Updates the API key for a rule.",
"operationId": "updateRuleAPIKey",
"description": "The new API key has the credentials of the user that submits the request.",
"tags": [
"alerting"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/rule_id"
},
{
"$ref": "#/components/parameters/space_id"
}
],
"responses": {
"200": {
"description": "Indicates a successful call."
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/alert/{alertId}/_mute": {
"post": {
"summary": "Mutes an alert.",
Expand Down Expand Up @@ -6595,6 +6649,32 @@
}
}
},
"400_response": {
"title": "Bad request",
"type": "object",
"required": [
"error",
"message",
"statusCode"
],
"properties": {
"error": {
"type": "string",
"enum": [
"Bad Request"
]
},
"message": {
"type": "string"
},
"statusCode": {
"type": "integer",
"enum": [
400
]
}
}
},
"alert_response_properties": {
"title": "Legacy alert response properties",
"type": "object",
Expand Down Expand Up @@ -7504,13 +7584,5 @@
]
}
}
},
"security": [
{
"basicAuth": []
},
{
"apiKeyAuth": []
}
]
}
}
Loading

0 comments on commit cb97975

Please sign in to comment.