IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-01-27 16:57:14 -06:00
Code Issues Packages Projects Releases Wiki Activity

Chore: fix formating for swagger definitions (#54993)

Browse Source
This commit is contained in:
Sofia Papagiannaki 2022-09-12 10:40:35 +03:00 committed by GitHub
parent 7979463bbf
commit b157fcdd87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 97 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/api/alerting.go
View File

@ -243,7 +243,7 @@ func (hs *HTTPServer) GetAlertNotifiers(ngalertEnabled bool) func(*models.ReqCon
// swagger:route GET /alert-notifications/lookup legacy_alerts_notification_channels getAlertNotificationLookup
//
// Get all notification channels (lookup)
// Get all notification channels (lookup).
//
// Returns all notification channels, but with less detailed information. Accessible by any authenticated user and is mainly used by providing alert notification channels in Grafana UI when configuring alert rule.
//
@ -342,7 +342,7 @@ func (hs *HTTPServer) GetAlertNotificationByID(c *models.ReqContext) response.Re
// swagger:route GET /alert-notifications/uid/{notification_channel_uid} legacy_alerts_notification_channels getAlertNotificationChannelByUID
//
// Get notification channel by UID
// Get notification channel by UID.
//
// Returns the notification channel given the notification channel UID.
//

4
pkg/api/annotations.go
View File

@ -297,7 +297,7 @@ func (hs *HTTPServer) UpdateAnnotation(c *models.ReqContext) response.Response {
// swagger:route PATCH /annotations/{annotation_id} annotations patchAnnotation
//
// Patch Annotation
// Patch Annotation.
//
// Updates one or more properties of an annotation that matches the specified ID.
// This operation currently supports updating of the `text`, `tags`, `time` and `timeEnd` properties.
@ -442,7 +442,7 @@ func (hs *HTTPServer) MassDeleteAnnotations(c *models.ReqContext) response.Respo
// swagger:route GET /annotations/{annotation_id} annotations getAnnotationByID
//
// Get Annotation by Id.
// Get Annotation by ID.
//
// Responses:
// 200: getAnnotationByIDResponse

38
pkg/api/api.go
View File

@ -3,29 +3,29 @@
// The Grafana backend exposes an HTTP API, the same API is used by the frontend to do
// everything from saving dashboards, creating users and updating data sources.
//
// Schemes: http, https
// BasePath: /api
// Version: 0.0.1
// License: GNU Affero General Public License v3.0 https://www.gnu.org/licenses/agpl-3.0.en.html
// Contact: Grafana Labs<hello@grafana.com> https://grafana.com
// Schemes: http, https
// BasePath: /api
// Version: 0.0.1
// License: GNU Affero General Public License v3.0 https://www.gnu.org/licenses/agpl-3.0.en.html
// Contact: Grafana Labs<hello@grafana.com> https://grafana.com
//
// Consumes:
// - application/json
// Consumes:
// - application/json
//
// Produces:
// - application/json
// Produces:
// - application/json
//
// Security:
// - basic:
// - api_key:
// Security:
// - basic:
// - api_key:
//
// SecurityDefinitions:
// basic:
// type: basic
// api_key:
// type: apiKey
// name: Authorization
// in: header
// SecurityDefinitions:
// basic:
// type: basic
// api_key:
// type: apiKey
// name: Authorization
// in: header
//
// swagger:meta
package api

2
pkg/api/apikey.go
View File

@ -95,7 +95,7 @@ func (hs *HTTPServer) DeleteAPIKey(c *models.ReqContext) response.Response {
//
// Creates an API key.
//
// Will return details of the created API key
// Will return details of the created API key.
//
// Responses:
// 200: postAPIkeyResponse

2
pkg/api/metrics.go
View File

@ -46,7 +46,7 @@ func (hs *HTTPServer) handleQueryMetricsError(err error) *response.NormalRespons
// QueryMetricsV2 returns query metrics.
// swagger:route POST /ds/query ds queryMetricsWithExpressions
//
// DataSource query metrics with expressions
// DataSource query metrics with expressions.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `datasources:query`.

4
pkg/api/org.go
View File

@ -18,7 +18,7 @@ import (
// swagger:route GET /org org getCurrentOrg
//
// Get current Organization
// Get current Organization.
//
// Responses:
// 200: getCurrentOrgResponse
@ -301,7 +301,7 @@ func (hs *HTTPServer) DeleteOrgByID(c *models.ReqContext) response.Response {
// swagger:route GET /orgs orgs searchOrgs
//
// Search all Organizations
// Search all Organizations.
//
// Security:
// - basic:

10
pkg/api/org_users.go
View File

@ -18,7 +18,7 @@ import (
// swagger:route POST /org/users org addOrgUserToCurrentOrg
//
// Add a new user to the current organization
// Add a new user to the current organization.
//
// Adds a global user to the current organization.
//
@ -41,7 +41,7 @@ func (hs *HTTPServer) AddOrgUserToCurrentOrg(c *models.ReqContext) response.Resp
// swagger:route POST /orgs/{org_id}/users orgs addOrgUser
//
// Add a new user to the current organization
// Add a new user to the current organization.
//
// Adds a global user to the current organization.
//
@ -275,7 +275,7 @@ func (hs *HTTPServer) SearchOrgUsersWithPaging(c *models.ReqContext) response.Re
// swagger:route PATCH /org/users/{user_id} org updateOrgUserForCurrentOrg
//
// Updates the given user
// Updates the given user.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `org.users.role:update` with scope `users:*`.
@ -349,7 +349,7 @@ func (hs *HTTPServer) updateOrgUserHelper(c *models.ReqContext, cmd models.Updat
// swagger:route DELETE /org/users/{user_id} org removeOrgUserForCurrentOrg
//
// Delete user in current organization
// Delete user in current organization.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `org.users:remove` with scope `users:*`.
@ -375,7 +375,7 @@ func (hs *HTTPServer) RemoveOrgUserForCurrentOrg(c *models.ReqContext) response.
// swagger:route DELETE /orgs/{org_id}/users/{user_id} orgs removeOrgUser
//
// Delete user in current organization
// Delete user in current organization.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `org.users:remove` with scope `users:*`.

2
pkg/api/quota.go
View File

@ -19,7 +19,7 @@ func (hs *HTTPServer) GetCurrentOrgQuotas(c *models.ReqContext) response.Respons
// Fetch Organization quota.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).
//list
//
// Responses:
// 200: getQuotaResponse
// 401: unauthorisedError

2
pkg/api/search.go
View File

@ -131,7 +131,7 @@ func (hs *HTTPServer) searchHitsWithMetadata(c *models.ReqContext, hits models.H
// swagger:route GET /search/sorting search listSortOptions
//
// List search sorting options
// List search sorting options.
//
// Responses:
// 200: listSortOptionsResponse

42
public/api-merged.json
View File

@ -28,7 +28,7 @@
"paths": {
"/access-control/roles": {
"get": {
"description": "Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in.\n\nYou need to have a permission with action `roles:list` and scope `roles:*`.",
"description": "Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in.\n\nYou need to have a permission with action `roles:read` and scope `roles:*`.",
"tags": [
"access_control",
"enterprise"
@ -228,7 +228,7 @@
},
"/access-control/teams/{teamId}/roles": {
"get": {
"description": "You need to have a permission with action `teams.roles:list` and scope `teams:id:\u003cteam ID\u003e`.",
"description": "You need to have a permission with action `teams.roles:read` and scope `teams:id:\u003cteam ID\u003e`.",
"tags": [
"access_control",
"enterprise"
@ -383,7 +383,7 @@
},
"/access-control/users/{userId}/roles": {
"get": {
"description": "Lists the roles that have been directly assigned to a given user. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team.\n\nYou need to have a permission with action `users.roles:list` and scope `users:id:\u003cuser ID\u003e`.",
"description": "Lists the roles that have been directly assigned to a given user. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team.\n\nYou need to have a permission with action `users.roles:read` and scope `users:id:\u003cuser ID\u003e`.",
"tags": [
"access_control",
"enterprise"
@ -1485,7 +1485,7 @@
"tags": [
"legacy_alerts_notification_channels"
],
"summary": "Get all notification channels (lookup)",
"summary": "Get all notification channels (lookup).",
"operationId": "getAlertNotificationLookup",
"responses": {
"200": {
@ -1549,7 +1549,7 @@
"tags": [
"legacy_alerts_notification_channels"
],
"summary": "Get notification channel by UID",
"summary": "Get notification channel by UID.",
"operationId": "getAlertNotificationChannelByUID",
"parameters": [
{
@ -2238,7 +2238,7 @@
"tags": [
"annotations"
],
"summary": "Get Annotation by Id.",
"summary": "Get Annotation by ID.",
"operationId": "getAnnotationByID",
"parameters": [
{
@ -2336,7 +2336,7 @@
"tags": [
"annotations"
],
"summary": "Patch Annotation",
"summary": "Patch Annotation.",
"operationId": "patchAnnotation",
"parameters": [
{
@ -3056,7 +3056,7 @@
}
},
"post": {
"description": "Will return details of the created API key",
"description": "Will return details of the created API key.",
"tags": [
"api_keys"
],
@ -5115,7 +5115,7 @@
"tags": [
"ds"
],
"summary": "DataSource query metrics with expressions",
"summary": "DataSource query metrics with expressions.",
"operationId": "queryMetricsWithExpressions",
"parameters": [
{
@ -5975,10 +5975,10 @@
},
"/org": {
"get": {
"description": "Get current Organization",
"tags": [
"org"
],
"summary": "Get current Organization.",
"operationId": "getCurrentOrg",
"responses": {
"200": {
@ -6279,7 +6279,7 @@
"tags": [
"org"
],
"summary": "Add a new user to the current organization",
"summary": "Add a new user to the current organization.",
"operationId": "addOrgUserToCurrentOrg",
"parameters": [
{
@ -6350,7 +6350,7 @@
"tags": [
"org"
],
"summary": "Delete user in current organization",
"summary": "Delete user in current organization.",
"operationId": "removeOrgUserForCurrentOrg",
"parameters": [
{
@ -6384,7 +6384,7 @@
"tags": [
"org"
],
"summary": "Updates the given user",
"summary": "Updates the given user.",
"operationId": "updateOrgUserForCurrentOrg",
"parameters": [
{
@ -6429,10 +6429,10 @@
"basic": []
}
],
"description": "Search all Organizations",
"tags": [
"orgs"
],
"summary": "Search all Organizations.",
"operationId": "searchOrgs",
"parameters": [
{
@ -6721,7 +6721,7 @@
},
"/orgs/{org_id}/quotas": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).\nlist",
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).",
"tags": [
"orgs"
],
@ -6852,7 +6852,7 @@
"tags": [
"orgs"
],
"summary": "Add a new user to the current organization",
"summary": "Add a new user to the current organization.",
"operationId": "addOrgUser",
"parameters": [
{
@ -6893,7 +6893,7 @@
"tags": [
"orgs"
],
"summary": "Delete user in current organization",
"summary": "Delete user in current organization.",
"operationId": "removeOrgUser",
"parameters": [
{
@ -7493,11 +7493,11 @@
},
"/recording-rules": {
"get": {
"description": "Lists all rules in the database: active or deleted",
"tags": [
"recording_rules",
"enterprise"
],
"summary": "Lists all rules in the database: active or deleted.",
"operationId": "listRecordingRules",
"responses": {
"200": {
@ -7518,11 +7518,11 @@
}
},
"put": {
"description": "Update the active status of a rule",
"tags": [
"recording_rules",
"enterprise"
],
"summary": "Update the active status of a rule.",
"operationId": "updateRecordingRule",
"parameters": [
{
@ -7553,11 +7553,11 @@
}
},
"post": {
"description": "Create a recording rule that is then registered and started",
"tags": [
"recording_rules",
"enterprise"
],
"summary": "Create a recording rule that is then registered and started.",
"operationId": "createRecordingRule",
"parameters": [
{
@ -8435,10 +8435,10 @@
},
"/search/sorting": {
"get": {
"description": "List search sorting options",
"tags": [
"search"
],
"summary": "List search sorting options.",
"operationId": "listSortOptions",
"responses": {
"200": {

42
public/api-spec.json
View File

@ -28,7 +28,7 @@
"paths": {
"/access-control/roles": {
"get": {
"description": "Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in.\n\nYou need to have a permission with action `roles:list` and scope `roles:*`.",
"description": "Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in.\n\nYou need to have a permission with action `roles:read` and scope `roles:*`.",
"tags": [
"access_control",
"enterprise"
@ -228,7 +228,7 @@
},
"/access-control/teams/{teamId}/roles": {
"get": {
"description": "You need to have a permission with action `teams.roles:list` and scope `teams:id:\u003cteam ID\u003e`.",
"description": "You need to have a permission with action `teams.roles:read` and scope `teams:id:\u003cteam ID\u003e`.",
"tags": [
"access_control",
"enterprise"
@ -383,7 +383,7 @@
},
"/access-control/users/{userId}/roles": {
"get": {
"description": "Lists the roles that have been directly assigned to a given user. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team.\n\nYou need to have a permission with action `users.roles:list` and scope `users:id:\u003cuser ID\u003e`.",
"description": "Lists the roles that have been directly assigned to a given user. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team.\n\nYou need to have a permission with action `users.roles:read` and scope `users:id:\u003cuser ID\u003e`.",
"tags": [
"access_control",
"enterprise"
@ -1485,7 +1485,7 @@
"tags": [
"legacy_alerts_notification_channels"
],
"summary": "Get all notification channels (lookup)",
"summary": "Get all notification channels (lookup).",
"operationId": "getAlertNotificationLookup",
"responses": {
"200": {
@ -1549,7 +1549,7 @@
"tags": [
"legacy_alerts_notification_channels"
],
"summary": "Get notification channel by UID",
"summary": "Get notification channel by UID.",
"operationId": "getAlertNotificationChannelByUID",
"parameters": [
{
@ -2238,7 +2238,7 @@
"tags": [
"annotations"
],
"summary": "Get Annotation by Id.",
"summary": "Get Annotation by ID.",
"operationId": "getAnnotationByID",
"parameters": [
{
@ -2336,7 +2336,7 @@
"tags": [
"annotations"
],
"summary": "Patch Annotation",
"summary": "Patch Annotation.",
"operationId": "patchAnnotation",
"parameters": [
{
@ -2409,7 +2409,7 @@
}
},
"post": {
"description": "Will return details of the created API key",
"description": "Will return details of the created API key.",
"tags": [
"api_keys"
],
@ -4468,7 +4468,7 @@
"tags": [
"ds"
],
"summary": "DataSource query metrics with expressions",
"summary": "DataSource query metrics with expressions.",
"operationId": "queryMetricsWithExpressions",
"parameters": [
{
@ -5328,10 +5328,10 @@
},
"/org": {
"get": {
"description": "Get current Organization",
"tags": [
"org"
],
"summary": "Get current Organization.",
"operationId": "getCurrentOrg",
"responses": {
"200": {
@ -5632,7 +5632,7 @@
"tags": [
"org"
],
"summary": "Add a new user to the current organization",
"summary": "Add a new user to the current organization.",
"operationId": "addOrgUserToCurrentOrg",
"parameters": [
{
@ -5703,7 +5703,7 @@
"tags": [
"org"
],
"summary": "Delete user in current organization",
"summary": "Delete user in current organization.",
"operationId": "removeOrgUserForCurrentOrg",
"parameters": [
{
@ -5737,7 +5737,7 @@
"tags": [
"org"
],
"summary": "Updates the given user",
"summary": "Updates the given user.",
"operationId": "updateOrgUserForCurrentOrg",
"parameters": [
{
@ -5782,10 +5782,10 @@
"basic": []
}
],
"description": "Search all Organizations",
"tags": [
"orgs"
],
"summary": "Search all Organizations.",
"operationId": "searchOrgs",
"parameters": [
{
@ -6074,7 +6074,7 @@
},
"/orgs/{org_id}/quotas": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).\nlist",
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).",
"tags": [
"orgs"
],
@ -6205,7 +6205,7 @@
"tags": [
"orgs"
],
"summary": "Add a new user to the current organization",
"summary": "Add a new user to the current organization.",
"operationId": "addOrgUser",
"parameters": [
{
@ -6246,7 +6246,7 @@
"tags": [
"orgs"
],
"summary": "Delete user in current organization",
"summary": "Delete user in current organization.",
"operationId": "removeOrgUser",
"parameters": [
{
@ -6846,11 +6846,11 @@
},
"/recording-rules": {
"get": {
"description": "Lists all rules in the database: active or deleted",
"tags": [
"recording_rules",
"enterprise"
],
"summary": "Lists all rules in the database: active or deleted.",
"operationId": "listRecordingRules",
"responses": {
"200": {
@ -6871,11 +6871,11 @@
}
},
"put": {
"description": "Update the active status of a rule",
"tags": [
"recording_rules",
"enterprise"
],
"summary": "Update the active status of a rule.",
"operationId": "updateRecordingRule",
"parameters": [
{
@ -6906,11 +6906,11 @@
}
},
"post": {
"description": "Create a recording rule that is then registered and started",
"tags": [
"recording_rules",
"enterprise"
],
"summary": "Create a recording rule that is then registered and started.",
"operationId": "createRecordingRule",
"parameters": [
{
@ -7788,10 +7788,10 @@
},
"/search/sorting": {
"get": {
"description": "List search sorting options",
"tags": [
"search"
],
"summary": "List search sorting options.",
"operationId": "listSortOptions",
"responses": {
"200": {

42
public/openapi3.json
View File

@ -10183,7 +10183,7 @@
"paths": {
"/access-control/roles": {
"get": {
"description": "Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in.\n\nYou need to have a permission with action `roles:list` and scope `roles:*`.",
"description": "Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in.\n\nYou need to have a permission with action `roles:read` and scope `roles:*`.",
"operationId": "listRoles",
"parameters": [
{
@ -10399,7 +10399,7 @@
},
"/access-control/teams/{teamId}/roles": {
"get": {
"description": "You need to have a permission with action `teams.roles:list` and scope `teams:id:\u003cteam ID\u003e`.",
"description": "You need to have a permission with action `teams.roles:read` and scope `teams:id:\u003cteam ID\u003e`.",
"operationId": "listTeamRoles",
"parameters": [
{
@ -10567,7 +10567,7 @@
},
"/access-control/users/{userId}/roles": {
"get": {
"description": "Lists the roles that have been directly assigned to a given user. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team.\n\nYou need to have a permission with action `users.roles:list` and scope `users:id:\u003cuser ID\u003e`.",
"description": "Lists the roles that have been directly assigned to a given user. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team.\n\nYou need to have a permission with action `users.roles:read` and scope `users:id:\u003cuser ID\u003e`.",
"operationId": "listUserRoles",
"parameters": [
{
@ -11740,7 +11740,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Get all notification channels (lookup)",
"summary": "Get all notification channels (lookup).",
"tags": [
"legacy_alerts_notification_channels"
]
@ -11853,7 +11853,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Get notification channel by UID",
"summary": "Get notification channel by UID.",
"tags": [
"legacy_alerts_notification_channels"
]
@ -12603,7 +12603,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Get Annotation by Id.",
"summary": "Get Annotation by ID.",
"tags": [
"annotations"
]
@ -12649,7 +12649,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Patch Annotation",
"summary": "Patch Annotation.",
"tags": [
"annotations"
]
@ -13512,7 +13512,7 @@
]
},
"post": {
"description": "Will return details of the created API key",
"description": "Will return details of the created API key.",
"operationId": "addAPIkey",
"requestBody": {
"content": {
@ -15747,7 +15747,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "DataSource query metrics with expressions",
"summary": "DataSource query metrics with expressions.",
"tags": [
"ds"
]
@ -16634,7 +16634,6 @@
},
"/org": {
"get": {
"description": "Get current Organization",
"operationId": "getCurrentOrg",
"responses": {
"200": {
@ -16650,6 +16649,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Get current Organization.",
"tags": [
"org"
]
@ -16968,7 +16968,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Add a new user to the current organization",
"summary": "Add a new user to the current organization.",
"tags": [
"org"
]
@ -17047,7 +17047,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Delete user in current organization",
"summary": "Delete user in current organization.",
"tags": [
"org"
]
@ -17094,7 +17094,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Updates the given user",
"summary": "Updates the given user.",
"tags": [
"org"
]
@ -17102,7 +17102,6 @@
},
"/orgs": {
"get": {
"description": "Search all Organizations",
"operationId": "searchOrgs",
"parameters": [
{
@ -17162,6 +17161,7 @@
"basic": []
}
],
"summary": "Search all Organizations.",
"tags": [
"orgs"
]
@ -17424,7 +17424,7 @@
},
"/orgs/{org_id}/quotas": {
"get": {
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).\nlist",
"description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).",
"operationId": "getOrgQuota",
"parameters": [
{
@ -17600,7 +17600,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Add a new user to the current organization",
"summary": "Add a new user to the current organization.",
"tags": [
"orgs"
]
@ -17647,7 +17647,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Delete user in current organization",
"summary": "Delete user in current organization.",
"tags": [
"orgs"
]
@ -18269,7 +18269,6 @@
},
"/recording-rules": {
"get": {
"description": "Lists all rules in the database: active or deleted",
"operationId": "listRecordingRules",
"responses": {
"200": {
@ -18288,13 +18287,13 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Lists all rules in the database: active or deleted.",
"tags": [
"recording_rules",
"enterprise"
]
},
"post": {
"description": "Create a recording rule that is then registered and started",
"operationId": "createRecordingRule",
"requestBody": {
"content": {
@ -18324,13 +18323,13 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Create a recording rule that is then registered and started.",
"tags": [
"recording_rules",
"enterprise"
]
},
"put": {
"description": "Update the active status of a rule",
"operationId": "updateRecordingRule",
"requestBody": {
"content": {
@ -18360,6 +18359,7 @@
"$ref": "#/components/responses/internalServerError"
}
},
"summary": "Update the active status of a rule.",
"tags": [
"recording_rules",
"enterprise"
@ -19269,7 +19269,6 @@
},
"/search/sorting": {
"get": {
"description": "List search sorting options",
"operationId": "listSortOptions",
"responses": {
"200": {
@ -19279,6 +19278,7 @@
"$ref": "#/components/responses/unauthorisedError"
}
},
"summary": "List search sorting options.",
"tags": [
"search"
]