IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

chore: update swagger spec

Browse Source
This commit is contained in:
gillesdemey
2022-03-03 18:35:39 +01:00
parent 66b91d3b50
commit ee79ec7341
4 changed files with 121 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
pkg/services/ngalert/api/tooling/post.json
View File

@@ -980,6 +980,13 @@
}, },
"type": "array", "type": "array",
"x-go-name": "Rules" "x-go-name": "Rules"
},
"source_tenants": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "SourceTenants"
} }
}, },
"type": "object", "type": "object",
@@ -2264,6 +2271,13 @@
}, },
"type": "array", "type": "array",
"x-go-name": "Rules" "x-go-name": "Rules"
},
"source_tenants": {
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "SourceTenants"
} }
}, },
"type": "object", "type": "object",
@@ -3233,12 +3247,11 @@
"type": "object" "type": "object"
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"items": { "items": {
"$ref": "#/definitions/gettableAlert" "$ref": "#/definitions/gettableAlert"
}, },
"type": "array", "type": "array"
"x-go-name": "GettableAlerts",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"gettableSilence": { "gettableSilence": {
"description": "GettableSilence gettable silence", "description": "GettableSilence gettable silence",
@@ -3430,7 +3443,6 @@
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models" "x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"postableSilence": { "postableSilence": {
"description": "PostableSilence postable silence",
"properties": { "properties": {
"comment": { "comment": {
"description": "comment", "description": "comment",
@@ -3470,10 +3482,11 @@
"matchers", "matchers",
"startsAt" "startsAt"
], ],
"type": "object" "type": "object",
"x-go-name": "PostableSilence",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"receiver": { "receiver": {
"description": "Receiver receiver",
"properties": { "properties": {
"name": { "name": {
"description": "name", "description": "name",
@@ -3484,7 +3497,9 @@
"required": [ "required": [
"name" "name"
], ],
"type": "object" "type": "object",
"x-go-name": "Receiver",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"silence": { "silence": {
"description": "Silence silence", "description": "Silence silence",

26
pkg/services/ngalert/api/tooling/spec.json
View File

@@ -2732,6 +2732,13 @@
"$ref": "#/definitions/GettableExtendedRuleNode" "$ref": "#/definitions/GettableExtendedRuleNode"
}, },
"x-go-name": "Rules" "x-go-name": "Rules"
},
"source_tenants": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "SourceTenants"
} }
}, },
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions" "x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
@@ -4017,6 +4024,13 @@
"$ref": "#/definitions/GettableExtendedRuleNode" "$ref": "#/definitions/GettableExtendedRuleNode"
}, },
"x-go-name": "Rules" "x-go-name": "Rules"
},
"source_tenants": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "SourceTenants"
} }
}, },
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions" "x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
@@ -4799,11 +4813,12 @@
"$ref": "#/definitions/alertGroup" "$ref": "#/definitions/alertGroup"
}, },
"alertGroups": { "alertGroups": {
"description": "AlertGroups alert groups",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/alertGroup" "$ref": "#/definitions/alertGroup"
}, },
"x-go-name": "AlertGroups",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models",
"$ref": "#/definitions/alertGroups" "$ref": "#/definitions/alertGroups"
}, },
"alertStatus": { "alertStatus": {
@@ -4987,12 +5002,11 @@
"$ref": "#/definitions/gettableAlert" "$ref": "#/definitions/gettableAlert"
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/gettableAlert" "$ref": "#/definitions/gettableAlert"
}, },
"x-go-name": "GettableAlerts",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models",
"$ref": "#/definitions/gettableAlerts" "$ref": "#/definitions/gettableAlerts"
}, },
"gettableSilence": { "gettableSilence": {
@@ -5187,7 +5201,6 @@
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models" "x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"postableSilence": { "postableSilence": {
"description": "PostableSilence postable silence",
"type": "object", "type": "object",
"required": [ "required": [
"comment", "comment",
@@ -5228,10 +5241,11 @@
"x-go-name": "StartsAt" "x-go-name": "StartsAt"
} }
}, },
"x-go-name": "PostableSilence",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models",
"$ref": "#/definitions/postableSilence" "$ref": "#/definitions/postableSilence"
}, },
"receiver": { "receiver": {
"description": "Receiver receiver",
"type": "object", "type": "object",
"required": [ "required": [
"name" "name"
@@ -5243,6 +5257,8 @@
"x-go-name": "Name" "x-go-name": "Name"
} }
}, },
"x-go-name": "Receiver",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models",
"$ref": "#/definitions/receiver" "$ref": "#/definitions/receiver"
}, },
"silence": { "silence": {

92
public/api-merged.json
View File

@@ -4494,15 +4494,15 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"x-go-name": "DatasourceID", "x-go-name": "PermissionID",
"name": "datasource_id", "name": "permissionId",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"x-go-name": "PermissionID", "x-go-name": "DatasourceID",
"name": "permissionId", "name": "datasource_id",
"in": "path", "in": "path",
"required": true "required": true
} }
@@ -7846,14 +7846,6 @@
"summary": "Add External Group.", "summary": "Add External Group.",
"operationId": "addTeamGroupApi", "operationId": "addTeamGroupApi",
"parameters": [ "parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
},
{ {
"x-go-name": "Body", "x-go-name": "Body",
"name": "body", "name": "body",
@@ -7862,6 +7854,14 @@
"schema": { "schema": {
"$ref": "#/definitions/TeamGroupMapping" "$ref": "#/definitions/TeamGroupMapping"
} }
},
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
} }
], ],
"responses": { "responses": {
@@ -7895,16 +7895,16 @@
{ {
"type": "integer", "type": "integer",
"format": "int64", "format": "int64",
"x-go-name": "TeamID", "x-go-name": "GroupID",
"name": "teamId", "name": "groupId",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "integer", "type": "integer",
"format": "int64", "format": "int64",
"x-go-name": "GroupID", "x-go-name": "TeamID",
"name": "groupId", "name": "teamId",
"in": "path", "in": "path",
"required": true "required": true
} }
@@ -10143,7 +10143,7 @@
}, },
"x-go-package": "github.com/prometheus/common/config" "x-go-package": "github.com/prometheus/common/config"
}, },
"BrandingOptions": { "BrandingOptionsDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
"emailFooterLink": { "emailFooterLink": {
@@ -10280,7 +10280,7 @@
"x-go-name": "Name" "x-go-name": "Name"
}, },
"options": { "options": {
"$ref": "#/definitions/ReportOptions" "$ref": "#/definitions/ReportOptionsDTO"
}, },
"orgId": { "orgId": {
"type": "integer", "type": "integer",
@@ -10296,10 +10296,11 @@
"x-go-name": "ReplyTo" "x-go-name": "ReplyTo"
}, },
"schedule": { "schedule": {
"$ref": "#/definitions/Schedule" "$ref": "#/definitions/ScheduleDTO"
}, },
"state": { "state": {
"$ref": "#/definitions/State" "type": "string",
"x-go-name": "State"
}, },
"templateVars": { "templateVars": {
"type": "object", "type": "object",
@@ -10480,7 +10481,7 @@
"x-go-name": "Name" "x-go-name": "Name"
}, },
"options": { "options": {
"$ref": "#/definitions/ReportOptions" "$ref": "#/definitions/ReportOptionsDTO"
}, },
"recipients": { "recipients": {
"type": "string", "type": "string",
@@ -10491,7 +10492,7 @@
"x-go-name": "ReplyTo" "x-go-name": "ReplyTo"
}, },
"schedule": { "schedule": {
"$ref": "#/definitions/Schedule" "$ref": "#/definitions/ScheduleDTO"
}, },
"state": { "state": {
"type": "string", "type": "string",
@@ -12068,8 +12069,8 @@
}, },
"exec_err_state": { "exec_err_state": {
"type": "string", "type": "string",
"enum": ["Alerting", "Error"], "enum": ["OK", "Alerting", "Error"],
"x-go-enum-desc": "Alerting AlertingErrState\nError ErrorErrState", "x-go-enum-desc": "OK OkErrState\nAlerting AlertingErrState\nError ErrorErrState",
"x-go-name": "ExecErrState" "x-go-name": "ExecErrState"
}, },
"id": { "id": {
@@ -12162,6 +12163,13 @@
"$ref": "#/definitions/GettableExtendedRuleNode" "$ref": "#/definitions/GettableExtendedRuleNode"
}, },
"x-go-name": "Rules" "x-go-name": "Rules"
},
"source_tenants": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "SourceTenants"
} }
}, },
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions" "x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
@@ -13906,8 +13914,8 @@
}, },
"exec_err_state": { "exec_err_state": {
"type": "string", "type": "string",
"enum": ["Alerting", "Error"], "enum": ["OK", "Alerting", "Error"],
"x-go-enum-desc": "Alerting AlertingErrState\nError ErrorErrState", "x-go-enum-desc": "OK OkErrState\nAlerting AlertingErrState\nError ErrorErrState",
"x-go-name": "ExecErrState" "x-go-name": "ExecErrState"
}, },
"no_data_state": { "no_data_state": {
@@ -14266,7 +14274,7 @@
}, },
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report" "x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
}, },
"ReportOptions": { "ReportOptionsDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
"layout": { "layout": {
@@ -14539,6 +14547,13 @@
"$ref": "#/definitions/GettableExtendedRuleNode" "$ref": "#/definitions/GettableExtendedRuleNode"
}, },
"x-go-name": "Rules" "x-go-name": "Rules"
},
"source_tenants": {
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "SourceTenants"
} }
}, },
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions" "x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
@@ -14673,7 +14688,7 @@
}, },
"x-go-package": "github.com/grafana/grafana/pkg/models" "x-go-package": "github.com/grafana/grafana/pkg/models"
}, },
"Schedule": { "ScheduleDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
"day": { "day": {
@@ -14824,7 +14839,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"branding": { "branding": {
"$ref": "#/definitions/BrandingOptions" "$ref": "#/definitions/BrandingOptionsDTO"
}, },
"id": { "id": {
"type": "integer", "type": "integer",
@@ -15054,10 +15069,6 @@
"SmtpNotEnabled": { "SmtpNotEnabled": {
"$ref": "#/definitions/ResponseDetails" "$ref": "#/definitions/ResponseDetails"
}, },
"State": {
"type": "string",
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
},
"Status": { "Status": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -16772,12 +16783,11 @@
} }
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/gettableAlert" "$ref": "#/definitions/gettableAlert"
}, }
"x-go-name": "GettableAlerts",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"gettableSilence": { "gettableSilence": {
"description": "GettableSilence gettable silence", "description": "GettableSilence gettable silence",
@@ -16951,7 +16961,6 @@
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models" "x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"postableSilence": { "postableSilence": {
"description": "PostableSilence postable silence",
"type": "object", "type": "object",
"required": ["comment", "createdBy", "endsAt", "matchers", "startsAt"], "required": ["comment", "createdBy", "endsAt", "matchers", "startsAt"],
"properties": { "properties": {
@@ -16985,10 +16994,11 @@
"format": "date-time", "format": "date-time",
"x-go-name": "StartsAt" "x-go-name": "StartsAt"
} }
} },
"x-go-name": "PostableSilence",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"receiver": { "receiver": {
"description": "Receiver receiver",
"type": "object", "type": "object",
"required": ["name"], "required": ["name"],
"properties": { "properties": {
@@ -16997,7 +17007,9 @@
"type": "string", "type": "string",
"x-go-name": "Name" "x-go-name": "Name"
} }
} },
"x-go-name": "Receiver",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
}, },
"silence": { "silence": {
"description": "Silence silence", "description": "Silence silence",

55
public/api-spec.json
View File

@@ -3544,15 +3544,15 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"x-go-name": "DatasourceID", "x-go-name": "PermissionID",
"name": "datasource_id", "name": "permissionId",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"x-go-name": "PermissionID", "x-go-name": "DatasourceID",
"name": "permissionId", "name": "datasource_id",
"in": "path", "in": "path",
"required": true "required": true
} }
@@ -6424,14 +6424,6 @@
"summary": "Add External Group.", "summary": "Add External Group.",
"operationId": "addTeamGroupApi", "operationId": "addTeamGroupApi",
"parameters": [ "parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
},
{ {
"x-go-name": "Body", "x-go-name": "Body",
"name": "body", "name": "body",
@@ -6440,6 +6432,14 @@
"schema": { "schema": {
"$ref": "#/definitions/TeamGroupMapping" "$ref": "#/definitions/TeamGroupMapping"
} }
},
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
} }
], ],
"responses": { "responses": {
@@ -6473,16 +6473,16 @@
{ {
"type": "integer", "type": "integer",
"format": "int64", "format": "int64",
"x-go-name": "TeamID", "x-go-name": "GroupID",
"name": "teamId", "name": "groupId",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "integer", "type": "integer",
"format": "int64", "format": "int64",
"x-go-name": "GroupID", "x-go-name": "TeamID",
"name": "groupId", "name": "teamId",
"in": "path", "in": "path",
"required": true "required": true
} }
@@ -8333,7 +8333,7 @@
}, },
"x-go-package": "github.com/grafana/grafana/pkg/models" "x-go-package": "github.com/grafana/grafana/pkg/models"
}, },
"BrandingOptions": { "BrandingOptionsDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
"emailFooterLink": { "emailFooterLink": {
@@ -8436,7 +8436,7 @@
"x-go-name": "Name" "x-go-name": "Name"
}, },
"options": { "options": {
"$ref": "#/definitions/ReportOptions" "$ref": "#/definitions/ReportOptionsDTO"
}, },
"orgId": { "orgId": {
"type": "integer", "type": "integer",
@@ -8452,10 +8452,11 @@
"x-go-name": "ReplyTo" "x-go-name": "ReplyTo"
}, },
"schedule": { "schedule": {
"$ref": "#/definitions/Schedule" "$ref": "#/definitions/ScheduleDTO"
}, },
"state": { "state": {
"$ref": "#/definitions/State" "type": "string",
"x-go-name": "State"
}, },
"templateVars": { "templateVars": {
"type": "object", "type": "object",
@@ -8636,7 +8637,7 @@
"x-go-name": "Name" "x-go-name": "Name"
}, },
"options": { "options": {
"$ref": "#/definitions/ReportOptions" "$ref": "#/definitions/ReportOptionsDTO"
}, },
"recipients": { "recipients": {
"type": "string", "type": "string",
@@ -8647,7 +8648,7 @@
"x-go-name": "ReplyTo" "x-go-name": "ReplyTo"
}, },
"schedule": { "schedule": {
"$ref": "#/definitions/Schedule" "$ref": "#/definitions/ScheduleDTO"
}, },
"state": { "state": {
"type": "string", "type": "string",
@@ -10839,7 +10840,7 @@
}, },
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report" "x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
}, },
"ReportOptions": { "ReportOptionsDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
"layout": { "layout": {
@@ -10971,7 +10972,7 @@
}, },
"x-go-package": "github.com/grafana/grafana/pkg/models" "x-go-package": "github.com/grafana/grafana/pkg/models"
}, },
"Schedule": { "ScheduleDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
"day": { "day": {
@@ -11113,7 +11114,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"branding": { "branding": {
"$ref": "#/definitions/BrandingOptions" "$ref": "#/definitions/BrandingOptionsDTO"
}, },
"id": { "id": {
"type": "integer", "type": "integer",
@@ -11133,10 +11134,6 @@
}, },
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report" "x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
}, },
"State": {
"type": "string",
"x-go-package": "github.com/grafana/grafana/pkg/extensions/report"
},
"Status": { "Status": {
"type": "object", "type": "object",
"properties": { "properties": {