diff --git a/dist/go.mod b/dist/go.mod
index b2bc12088..ca80469a1 100755
--- a/dist/go.mod
+++ b/dist/go.mod
@@ -7,7 +7,7 @@ replace github.com/cloudforet-io/api => ./
require (
github.com/golang/protobuf v1.5.4
github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0
- google.golang.org/genproto/googleapis/api v0.0.0-20240722135656-d784300faade
+ google.golang.org/genproto/googleapis/api v0.0.0-20240723171418-e6d459c13d2a
google.golang.org/grpc v1.65.0
google.golang.org/protobuf v1.34.2
)
@@ -16,5 +16,5 @@ require (
golang.org/x/net v0.26.0 // indirect
golang.org/x/sys v0.21.0 // indirect
golang.org/x/text v0.16.0 // indirect
- google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 // indirect
+ google.golang.org/genproto/googleapis/rpc v0.0.0-20240722135656-d784300faade // indirect
)
diff --git a/dist/go.sum b/dist/go.sum
index b631847fa..2a209a410 100755
--- a/dist/go.sum
+++ b/dist/go.sum
@@ -10,10 +10,10 @@ golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
-google.golang.org/genproto/googleapis/api v0.0.0-20240722135656-d784300faade h1:WxZOF2yayUHpHSbUE6NMzumUzBxYc3YGwo0YHnbzsJY=
-google.golang.org/genproto/googleapis/api v0.0.0-20240722135656-d784300faade/go.mod h1:mw8MG/Qz5wfgYr6VqVCiZcHe/GJEfI+oGGDCohaVgB0=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 h1:BwIjyKYGsK9dMCBOorzRri8MQwmi7mT9rGHsCEinZkA=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094/go.mod h1:Ue6ibwXGpU+dqIcODieyLOcgj7z8+IcskoNIgZxtrFY=
+google.golang.org/genproto/googleapis/api v0.0.0-20240723171418-e6d459c13d2a h1:YIa/rzVqMEokBkPtydCkx1VLmv3An1Uw7w1P1m6EhOY=
+google.golang.org/genproto/googleapis/api v0.0.0-20240723171418-e6d459c13d2a/go.mod h1:AHT0dDg3SoMOgZGnZk29b5xTbPHMoEC8qthmBLJCpys=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20240722135656-d784300faade h1:oCRSWfwGXQsqlVdErcyTt4A93Y8fo0/9D4b1gnI++qo=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20240722135656-d784300faade/go.mod h1:Ue6ibwXGpU+dqIcODieyLOcgj7z8+IcskoNIgZxtrFY=
google.golang.org/grpc v1.65.0 h1:bs/cUb4lp1G5iImFFd3u5ixQzweKizoZJAwBNLR42lc=
google.golang.org/grpc v1.65.0/go.mod h1:WgYC2ypjlB0EiQi6wdKixMqukr6lBc0Vo+oOgjrM5ZQ=
google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
diff --git a/dist/go/spaceone/api/repository/v1/plugin.pb.go b/dist/go/spaceone/api/repository/v1/plugin.pb.go
index 8cc0ffc84..adaf8638d 100755
--- a/dist/go/spaceone/api/repository/v1/plugin.pb.go
+++ b/dist/go/spaceone/api/repository/v1/plugin.pb.go
@@ -224,6 +224,9 @@ type RegisterPluginRequest struct {
// if plugin_id is not provided, it will be generated by image name
// +optional
PluginId string `protobuf:"bytes,10,opt,name=plugin_id,json=pluginId,proto3" json:"plugin_id,omitempty"`
+ // +optional
+ // {"en": {}, "ko": {}, "ja":{}}
+ Docs *_struct.Struct `protobuf:"bytes,11,opt,name=docs,proto3" json:"docs,omitempty"`
}
func (x *RegisterPluginRequest) Reset() {
@@ -328,6 +331,13 @@ func (x *RegisterPluginRequest) GetPluginId() string {
return ""
}
+func (x *RegisterPluginRequest) GetDocs() *_struct.Struct {
+ if x != nil {
+ return x.Docs
+ }
+ return nil
+}
+
// {
// "name": "JIRA Software Collector",
// "capability": {
@@ -359,6 +369,8 @@ type UpdatePluginRequest struct {
Labels *_struct.ListValue `protobuf:"bytes,4,opt,name=labels,proto3" json:"labels,omitempty"`
// +optional
Tags *_struct.Struct `protobuf:"bytes,5,opt,name=tags,proto3" json:"tags,omitempty"`
+ // +optional
+ Docs *_struct.Struct `protobuf:"bytes,6,opt,name=docs,proto3" json:"docs,omitempty"`
}
func (x *UpdatePluginRequest) Reset() {
@@ -428,6 +440,13 @@ func (x *UpdatePluginRequest) GetTags() *_struct.Struct {
return nil
}
+func (x *UpdatePluginRequest) GetDocs() *_struct.Struct {
+ if x != nil {
+ return x.Docs
+ }
+ return nil
+}
+
// {
// "plugin_id": "plugin-aws-sns-mon-webhook",
// }
@@ -722,6 +741,7 @@ type PluginInfo struct {
Capability *_struct.Struct `protobuf:"bytes,10,opt,name=capability,proto3" json:"capability,omitempty"`
Labels *_struct.ListValue `protobuf:"bytes,11,opt,name=labels,proto3" json:"labels,omitempty"`
Tags *_struct.Struct `protobuf:"bytes,12,opt,name=tags,proto3" json:"tags,omitempty"`
+ Docs *_struct.Struct `protobuf:"bytes,13,opt,name=docs,proto3" json:"docs,omitempty"`
DomainId string `protobuf:"bytes,21,opt,name=domain_id,json=domainId,proto3" json:"domain_id,omitempty"`
RepositoryInfo *RepositoryInfo `protobuf:"bytes,22,opt,name=repository_info,json=repositoryInfo,proto3" json:"repository_info,omitempty"`
CreatedAt string `protobuf:"bytes,31,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
@@ -844,6 +864,13 @@ func (x *PluginInfo) GetTags() *_struct.Struct {
return nil
}
+func (x *PluginInfo) GetDocs() *_struct.Struct {
+ if x != nil {
+ return x.Docs
+ }
+ return nil
+}
+
func (x *PluginInfo) GetDomainId() string {
if x != nil {
return x.DomainId
@@ -1069,7 +1096,7 @@ var file_spaceone_api_repository_v1_plugin_proto_rawDesc = []byte{
0x65, 0x2f, 0x76, 0x32, 0x2f, 0x71, 0x75, 0x65, 0x72, 0x79, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f,
0x1a, 0x2b, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x72,
0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x72, 0x65, 0x70,
- 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x22, 0xd0, 0x03,
+ 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x22, 0xfd, 0x03,
0x0a, 0x15, 0x52, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e,
0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18,
0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x23, 0x0a, 0x0d, 0x72,
@@ -1099,199 +1126,208 @@ var file_spaceone_api_repository_v1_plugin_proto_rawDesc = []byte{
0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x04, 0x74,
0x61, 0x67, 0x73, 0x12, 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f, 0x69, 0x64,
0x18, 0x0a, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x64,
- 0x22, 0xe0, 0x01, 0x0a, 0x13, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x50, 0x6c, 0x75, 0x67, 0x69,
- 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67,
- 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75,
- 0x67, 0x69, 0x6e, 0x49, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x02, 0x20,
- 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x37, 0x0a, 0x0a, 0x63, 0x61, 0x70,
- 0x61, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x79, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e,
- 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e,
- 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x0a, 0x63, 0x61, 0x70, 0x61, 0x62, 0x69, 0x6c, 0x69,
- 0x74, 0x79, 0x12, 0x32, 0x0a, 0x06, 0x6c, 0x61, 0x62, 0x65, 0x6c, 0x73, 0x18, 0x04, 0x20, 0x01,
- 0x28, 0x0b, 0x32, 0x1a, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74,
- 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06,
- 0x6c, 0x61, 0x62, 0x65, 0x6c, 0x73, 0x12, 0x2b, 0x0a, 0x04, 0x74, 0x61, 0x67, 0x73, 0x18, 0x05,
- 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72,
- 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x04, 0x74,
- 0x61, 0x67, 0x73, 0x22, 0x2c, 0x0a, 0x0d, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71,
- 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f, 0x69,
- 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49,
- 0x64, 0x22, 0x5b, 0x0a, 0x17, 0x52, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x50,
- 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09,
- 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52,
- 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x64, 0x12, 0x23, 0x0a, 0x0d, 0x72, 0x65, 0x70,
- 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x5f, 0x69, 0x64, 0x18, 0x15, 0x20, 0x01, 0x28, 0x09,
- 0x52, 0x0c, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x49, 0x64, 0x22, 0x9f,
- 0x03, 0x0a, 0x0b, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x51, 0x75, 0x65, 0x72, 0x79, 0x12, 0x31,
- 0x0a, 0x05, 0x71, 0x75, 0x65, 0x72, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x1b, 0x2e,
- 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x63, 0x6f, 0x72,
- 0x65, 0x2e, 0x76, 0x32, 0x2e, 0x51, 0x75, 0x65, 0x72, 0x79, 0x52, 0x05, 0x71, 0x75, 0x65, 0x72,
- 0x79, 0x12, 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x02,
- 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x64, 0x12, 0x12,
- 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61,
- 0x6d, 0x65, 0x12, 0x43, 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x04, 0x20, 0x01, 0x28,
- 0x0e, 0x32, 0x2d, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69,
+ 0x12, 0x2b, 0x0a, 0x04, 0x64, 0x6f, 0x63, 0x73, 0x18, 0x0b, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17,
+ 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66,
+ 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x04, 0x64, 0x6f, 0x63, 0x73, 0x22, 0x8d, 0x02,
+ 0x0a, 0x13, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65,
+ 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f,
+ 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e,
+ 0x49, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09,
+ 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x37, 0x0a, 0x0a, 0x63, 0x61, 0x70, 0x61, 0x62, 0x69,
+ 0x6c, 0x69, 0x74, 0x79, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f,
+ 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72,
+ 0x75, 0x63, 0x74, 0x52, 0x0a, 0x63, 0x61, 0x70, 0x61, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x79, 0x12,
+ 0x32, 0x0a, 0x06, 0x6c, 0x61, 0x62, 0x65, 0x6c, 0x73, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, 0x32,
+ 0x1a, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75,
+ 0x66, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x6c, 0x61, 0x62,
+ 0x65, 0x6c, 0x73, 0x12, 0x2b, 0x0a, 0x04, 0x74, 0x61, 0x67, 0x73, 0x18, 0x05, 0x20, 0x01, 0x28,
+ 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f,
+ 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x04, 0x74, 0x61, 0x67, 0x73,
+ 0x12, 0x2b, 0x0a, 0x04, 0x64, 0x6f, 0x63, 0x73, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17,
+ 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66,
+ 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x04, 0x64, 0x6f, 0x63, 0x73, 0x22, 0x2c, 0x0a,
+ 0x0d, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b,
+ 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28,
+ 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x64, 0x22, 0x5b, 0x0a, 0x17, 0x52,
+ 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52,
+ 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e,
+ 0x5f, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69,
+ 0x6e, 0x49, 0x64, 0x12, 0x23, 0x0a, 0x0d, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72,
+ 0x79, 0x5f, 0x69, 0x64, 0x18, 0x15, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0c, 0x72, 0x65, 0x70, 0x6f,
+ 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x49, 0x64, 0x22, 0x9f, 0x03, 0x0a, 0x0b, 0x50, 0x6c, 0x75,
+ 0x67, 0x69, 0x6e, 0x51, 0x75, 0x65, 0x72, 0x79, 0x12, 0x31, 0x0a, 0x05, 0x71, 0x75, 0x65, 0x72,
+ 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x1b, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f,
+ 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x63, 0x6f, 0x72, 0x65, 0x2e, 0x76, 0x32, 0x2e, 0x51,
+ 0x75, 0x65, 0x72, 0x79, 0x52, 0x05, 0x71, 0x75, 0x65, 0x72, 0x79, 0x12, 0x1b, 0x0a, 0x09, 0x70,
+ 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08,
+ 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65,
+ 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x43, 0x0a, 0x05,
+ 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x2d, 0x2e, 0x73, 0x70,
+ 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73,
+ 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x51,
+ 0x75, 0x65, 0x72, 0x79, 0x2e, 0x53, 0x74, 0x61, 0x74, 0x65, 0x52, 0x05, 0x73, 0x74, 0x61, 0x74,
+ 0x65, 0x12, 0x23, 0x0a, 0x0d, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x5f, 0x74, 0x79,
+ 0x70, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0c, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72,
+ 0x63, 0x65, 0x54, 0x79, 0x70, 0x65, 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64,
+ 0x65, 0x72, 0x18, 0x06, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64,
+ 0x65, 0x72, 0x12, 0x53, 0x0a, 0x0d, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x5f, 0x74,
+ 0x79, 0x70, 0x65, 0x18, 0x07, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x2e, 0x2e, 0x73, 0x70, 0x61, 0x63,
+ 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74,
+ 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x75, 0x62, 0x6c, 0x69, 0x63, 0x52, 0x65, 0x67,
+ 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65, 0x52, 0x0c, 0x72, 0x65, 0x67, 0x69, 0x73,
+ 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65, 0x12, 0x23, 0x0a, 0x0d, 0x72, 0x65, 0x70, 0x6f, 0x73,
+ 0x69, 0x74, 0x6f, 0x72, 0x79, 0x5f, 0x69, 0x64, 0x18, 0x15, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0c,
+ 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x49, 0x64, 0x22, 0x2c, 0x0a, 0x05,
+ 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12,
+ 0x0b, 0x0a, 0x07, 0x45, 0x4e, 0x41, 0x42, 0x4c, 0x45, 0x44, 0x10, 0x01, 0x12, 0x0c, 0x0a, 0x08,
+ 0x44, 0x49, 0x53, 0x41, 0x42, 0x4c, 0x45, 0x44, 0x10, 0x02, 0x22, 0xb7, 0x06, 0x0a, 0x0a, 0x50,
+ 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x12, 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75,
+ 0x67, 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c,
+ 0x75, 0x67, 0x69, 0x6e, 0x49, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x02,
+ 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x42, 0x0a, 0x05, 0x73, 0x74,
+ 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x2c, 0x2e, 0x73, 0x70, 0x61, 0x63,
+ 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74,
+ 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66,
+ 0x6f, 0x2e, 0x53, 0x74, 0x61, 0x74, 0x65, 0x52, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, 0x23,
+ 0x0a, 0x0d, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18,
+ 0x04, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0c, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x54,
+ 0x79, 0x70, 0x65, 0x12, 0x14, 0x0a, 0x05, 0x69, 0x6d, 0x61, 0x67, 0x65, 0x18, 0x05, 0x20, 0x01,
+ 0x28, 0x09, 0x52, 0x05, 0x69, 0x6d, 0x61, 0x67, 0x65, 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x72, 0x6f,
+ 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x06, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x72, 0x6f,
+ 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x53, 0x0a, 0x0d, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72,
+ 0x79, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18, 0x07, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x2e, 0x2e, 0x73,
+ 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f,
+ 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x75, 0x62, 0x6c, 0x69, 0x63,
+ 0x52, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65, 0x52, 0x0c, 0x72, 0x65,
+ 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65, 0x12, 0x21, 0x0a, 0x0c, 0x72, 0x65,
+ 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x5f, 0x75, 0x72, 0x6c, 0x18, 0x08, 0x20, 0x01, 0x28, 0x09,
+ 0x52, 0x0b, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x55, 0x72, 0x6c, 0x12, 0x40, 0x0a,
+ 0x0f, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x5f, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67,
+ 0x18, 0x09, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e,
+ 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52,
+ 0x0e, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12,
+ 0x37, 0x0a, 0x0a, 0x63, 0x61, 0x70, 0x61, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x79, 0x18, 0x0a, 0x20,
+ 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f,
+ 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x0a, 0x63, 0x61,
+ 0x70, 0x61, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x79, 0x12, 0x32, 0x0a, 0x06, 0x6c, 0x61, 0x62, 0x65,
+ 0x6c, 0x73, 0x18, 0x0b, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x1a, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c,
+ 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x56,
+ 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x6c, 0x61, 0x62, 0x65, 0x6c, 0x73, 0x12, 0x2b, 0x0a, 0x04,
+ 0x74, 0x61, 0x67, 0x73, 0x18, 0x0c, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f,
+ 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72,
+ 0x75, 0x63, 0x74, 0x52, 0x04, 0x74, 0x61, 0x67, 0x73, 0x12, 0x2b, 0x0a, 0x04, 0x64, 0x6f, 0x63,
+ 0x73, 0x18, 0x0d, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65,
+ 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74,
+ 0x52, 0x04, 0x64, 0x6f, 0x63, 0x73, 0x12, 0x1b, 0x0a, 0x09, 0x64, 0x6f, 0x6d, 0x61, 0x69, 0x6e,
+ 0x5f, 0x69, 0x64, 0x18, 0x15, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x64, 0x6f, 0x6d, 0x61, 0x69,
+ 0x6e, 0x49, 0x64, 0x12, 0x53, 0x0a, 0x0f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72,
+ 0x79, 0x5f, 0x69, 0x6e, 0x66, 0x6f, 0x18, 0x16, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x2a, 0x2e, 0x73,
+ 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f,
+ 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x52, 0x65, 0x70, 0x6f, 0x73, 0x69,
+ 0x74, 0x6f, 0x72, 0x79, 0x49, 0x6e, 0x66, 0x6f, 0x52, 0x0e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69,
+ 0x74, 0x6f, 0x72, 0x79, 0x49, 0x6e, 0x66, 0x6f, 0x12, 0x1d, 0x0a, 0x0a, 0x63, 0x72, 0x65, 0x61,
+ 0x74, 0x65, 0x64, 0x5f, 0x61, 0x74, 0x18, 0x1f, 0x20, 0x01, 0x28, 0x09, 0x52, 0x09, 0x63, 0x72,
+ 0x65, 0x61, 0x74, 0x65, 0x64, 0x41, 0x74, 0x12, 0x1d, 0x0a, 0x0a, 0x75, 0x70, 0x64, 0x61, 0x74,
+ 0x65, 0x64, 0x5f, 0x61, 0x74, 0x18, 0x20, 0x20, 0x01, 0x28, 0x09, 0x52, 0x09, 0x75, 0x70, 0x64,
+ 0x61, 0x74, 0x65, 0x64, 0x41, 0x74, 0x22, 0x2c, 0x0a, 0x05, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12,
+ 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12, 0x0b, 0x0a, 0x07, 0x45, 0x4e, 0x41,
+ 0x42, 0x4c, 0x45, 0x44, 0x10, 0x01, 0x12, 0x0c, 0x0a, 0x08, 0x44, 0x49, 0x53, 0x41, 0x42, 0x4c,
+ 0x45, 0x44, 0x10, 0x02, 0x22, 0x70, 0x0a, 0x0b, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x73, 0x49,
+ 0x6e, 0x66, 0x6f, 0x12, 0x40, 0x0a, 0x07, 0x72, 0x65, 0x73, 0x75, 0x6c, 0x74, 0x73, 0x18, 0x01,
+ 0x20, 0x03, 0x28, 0x0b, 0x32, 0x26, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e,
+ 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76,
+ 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x52, 0x07, 0x72, 0x65,
+ 0x73, 0x75, 0x6c, 0x74, 0x73, 0x12, 0x1f, 0x0a, 0x0b, 0x74, 0x6f, 0x74, 0x61, 0x6c, 0x5f, 0x63,
+ 0x6f, 0x75, 0x6e, 0x74, 0x18, 0x02, 0x20, 0x01, 0x28, 0x05, 0x52, 0x0a, 0x74, 0x6f, 0x74, 0x61,
+ 0x6c, 0x43, 0x6f, 0x75, 0x6e, 0x74, 0x22, 0x63, 0x0a, 0x0c, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f,
+ 0x6e, 0x73, 0x49, 0x6e, 0x66, 0x6f, 0x12, 0x18, 0x0a, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f,
+ 0x6e, 0x18, 0x01, 0x20, 0x03, 0x28, 0x09, 0x52, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e,
+ 0x12, 0x1f, 0x0a, 0x0b, 0x74, 0x6f, 0x74, 0x61, 0x6c, 0x5f, 0x63, 0x6f, 0x75, 0x6e, 0x74, 0x18,
+ 0x02, 0x20, 0x01, 0x28, 0x05, 0x52, 0x0a, 0x74, 0x6f, 0x74, 0x61, 0x6c, 0x43, 0x6f, 0x75, 0x6e,
+ 0x74, 0x12, 0x18, 0x0a, 0x07, 0x72, 0x65, 0x73, 0x75, 0x6c, 0x74, 0x73, 0x18, 0x03, 0x20, 0x03,
+ 0x28, 0x09, 0x52, 0x07, 0x72, 0x65, 0x73, 0x75, 0x6c, 0x74, 0x73, 0x2a, 0x69, 0x0a, 0x12, 0x50,
+ 0x75, 0x62, 0x6c, 0x69, 0x63, 0x52, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70,
+ 0x65, 0x12, 0x16, 0x0a, 0x12, 0x4e, 0x4f, 0x4e, 0x45, 0x5f, 0x52, 0x45, 0x47, 0x49, 0x53, 0x54,
+ 0x52, 0x59, 0x5f, 0x54, 0x59, 0x50, 0x45, 0x10, 0x00, 0x12, 0x0e, 0x0a, 0x0a, 0x44, 0x4f, 0x43,
+ 0x4b, 0x45, 0x52, 0x5f, 0x48, 0x55, 0x42, 0x10, 0x01, 0x12, 0x13, 0x0a, 0x0f, 0x41, 0x57, 0x53,
+ 0x5f, 0x50, 0x52, 0x49, 0x56, 0x41, 0x54, 0x45, 0x5f, 0x45, 0x43, 0x52, 0x10, 0x02, 0x12, 0x0a,
+ 0x0a, 0x06, 0x48, 0x41, 0x52, 0x42, 0x4f, 0x52, 0x10, 0x03, 0x12, 0x0a, 0x0a, 0x06, 0x47, 0x49,
+ 0x54, 0x48, 0x55, 0x42, 0x10, 0x04, 0x32, 0xe1, 0x08, 0x0a, 0x06, 0x50, 0x6c, 0x75, 0x67, 0x69,
+ 0x6e, 0x12, 0x90, 0x01, 0x0a, 0x08, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12, 0x31,
+ 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65,
+ 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x52, 0x65, 0x67, 0x69,
+ 0x73, 0x74, 0x65, 0x72, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73,
+ 0x74, 0x1a, 0x26, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69,
0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50,
- 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x51, 0x75, 0x65, 0x72, 0x79, 0x2e, 0x53, 0x74, 0x61, 0x74, 0x65,
- 0x52, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, 0x23, 0x0a, 0x0d, 0x72, 0x65, 0x73, 0x6f, 0x75,
- 0x72, 0x63, 0x65, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0c,
- 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x54, 0x79, 0x70, 0x65, 0x12, 0x1a, 0x0a, 0x08,
- 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x06, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08,
- 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x53, 0x0a, 0x0d, 0x72, 0x65, 0x67, 0x69,
- 0x73, 0x74, 0x72, 0x79, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18, 0x07, 0x20, 0x01, 0x28, 0x0e, 0x32,
- 0x2e, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72,
- 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x75, 0x62,
- 0x6c, 0x69, 0x63, 0x52, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65, 0x52,
- 0x0c, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65, 0x12, 0x23, 0x0a,
- 0x0d, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x5f, 0x69, 0x64, 0x18, 0x15,
- 0x20, 0x01, 0x28, 0x09, 0x52, 0x0c, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79,
- 0x49, 0x64, 0x22, 0x2c, 0x0a, 0x05, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x08, 0x0a, 0x04, 0x4e,
- 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12, 0x0b, 0x0a, 0x07, 0x45, 0x4e, 0x41, 0x42, 0x4c, 0x45, 0x44,
- 0x10, 0x01, 0x12, 0x0c, 0x0a, 0x08, 0x44, 0x49, 0x53, 0x41, 0x42, 0x4c, 0x45, 0x44, 0x10, 0x02,
- 0x22, 0x8a, 0x06, 0x0a, 0x0a, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x12,
- 0x1b, 0x0a, 0x09, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01,
- 0x28, 0x09, 0x52, 0x08, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x64, 0x12, 0x12, 0x0a, 0x04,
- 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65,
- 0x12, 0x42, 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0e, 0x32,
- 0x2c, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72,
+ 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x29, 0x82, 0xd3, 0xe4, 0x93, 0x02,
+ 0x23, 0x3a, 0x01, 0x2a, 0x22, 0x1e, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72,
+ 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x72, 0x65, 0x67, 0x69,
+ 0x73, 0x74, 0x65, 0x72, 0x12, 0x8a, 0x01, 0x0a, 0x06, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x12,
+ 0x2f, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72,
+ 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x55, 0x70, 0x64,
+ 0x61, 0x74, 0x65, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74,
+ 0x1a, 0x26, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e,
+ 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c,
+ 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x27, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x21,
+ 0x3a, 0x01, 0x2a, 0x22, 0x1c, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79,
+ 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x75, 0x70, 0x64, 0x61, 0x74,
+ 0x65, 0x12, 0x7c, 0x0a, 0x0a, 0x64, 0x65, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12,
+ 0x29, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72,
0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75,
- 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x2e, 0x53, 0x74, 0x61, 0x74, 0x65, 0x52, 0x05, 0x73,
- 0x74, 0x61, 0x74, 0x65, 0x12, 0x23, 0x0a, 0x0d, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65,
- 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18, 0x04, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0c, 0x72, 0x65, 0x73,
- 0x6f, 0x75, 0x72, 0x63, 0x65, 0x54, 0x79, 0x70, 0x65, 0x12, 0x14, 0x0a, 0x05, 0x69, 0x6d, 0x61,
- 0x67, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x09, 0x52, 0x05, 0x69, 0x6d, 0x61, 0x67, 0x65, 0x12,
- 0x1a, 0x0a, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x06, 0x20, 0x01, 0x28,
- 0x09, 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x53, 0x0a, 0x0d, 0x72,
- 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x18, 0x07, 0x20, 0x01,
- 0x28, 0x0e, 0x32, 0x2e, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70,
- 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e,
- 0x50, 0x75, 0x62, 0x6c, 0x69, 0x63, 0x52, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79,
- 0x70, 0x65, 0x52, 0x0c, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65,
- 0x12, 0x21, 0x0a, 0x0c, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x5f, 0x75, 0x72, 0x6c,
- 0x18, 0x08, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0b, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79,
- 0x55, 0x72, 0x6c, 0x12, 0x40, 0x0a, 0x0f, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x5f,
- 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x09, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67,
- 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53,
- 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x0e, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x43,
- 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x37, 0x0a, 0x0a, 0x63, 0x61, 0x70, 0x61, 0x62, 0x69, 0x6c,
- 0x69, 0x74, 0x79, 0x18, 0x0a, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f, 0x67,
- 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75,
- 0x63, 0x74, 0x52, 0x0a, 0x63, 0x61, 0x70, 0x61, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x79, 0x12, 0x32,
- 0x0a, 0x06, 0x6c, 0x61, 0x62, 0x65, 0x6c, 0x73, 0x18, 0x0b, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x1a,
- 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66,
- 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x6c, 0x61, 0x62, 0x65,
- 0x6c, 0x73, 0x12, 0x2b, 0x0a, 0x04, 0x74, 0x61, 0x67, 0x73, 0x18, 0x0c, 0x20, 0x01, 0x28, 0x0b,
- 0x32, 0x17, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62,
- 0x75, 0x66, 0x2e, 0x53, 0x74, 0x72, 0x75, 0x63, 0x74, 0x52, 0x04, 0x74, 0x61, 0x67, 0x73, 0x12,
- 0x1b, 0x0a, 0x09, 0x64, 0x6f, 0x6d, 0x61, 0x69, 0x6e, 0x5f, 0x69, 0x64, 0x18, 0x15, 0x20, 0x01,
- 0x28, 0x09, 0x52, 0x08, 0x64, 0x6f, 0x6d, 0x61, 0x69, 0x6e, 0x49, 0x64, 0x12, 0x53, 0x0a, 0x0f,
- 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x5f, 0x69, 0x6e, 0x66, 0x6f, 0x18,
- 0x16, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x2a, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65,
+ 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x16, 0x2e, 0x67, 0x6f, 0x6f,
+ 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x45, 0x6d, 0x70,
+ 0x74, 0x79, 0x22, 0x2b, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x25, 0x3a, 0x01, 0x2a, 0x22, 0x20, 0x2f,
+ 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c,
+ 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x64, 0x65, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12,
+ 0x84, 0x01, 0x0a, 0x06, 0x65, 0x6e, 0x61, 0x62, 0x6c, 0x65, 0x12, 0x29, 0x2e, 0x73, 0x70, 0x61,
+ 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69,
+ 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65,
+ 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65,
0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e,
- 0x76, 0x31, 0x2e, 0x52, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x49, 0x6e, 0x66,
- 0x6f, 0x52, 0x0e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x49, 0x6e, 0x66,
- 0x6f, 0x12, 0x1d, 0x0a, 0x0a, 0x63, 0x72, 0x65, 0x61, 0x74, 0x65, 0x64, 0x5f, 0x61, 0x74, 0x18,
- 0x1f, 0x20, 0x01, 0x28, 0x09, 0x52, 0x09, 0x63, 0x72, 0x65, 0x61, 0x74, 0x65, 0x64, 0x41, 0x74,
- 0x12, 0x1d, 0x0a, 0x0a, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x64, 0x5f, 0x61, 0x74, 0x18, 0x20,
- 0x20, 0x01, 0x28, 0x09, 0x52, 0x09, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x64, 0x41, 0x74, 0x22,
- 0x2c, 0x0a, 0x05, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4e, 0x45,
- 0x10, 0x00, 0x12, 0x0b, 0x0a, 0x07, 0x45, 0x4e, 0x41, 0x42, 0x4c, 0x45, 0x44, 0x10, 0x01, 0x12,
- 0x0c, 0x0a, 0x08, 0x44, 0x49, 0x53, 0x41, 0x42, 0x4c, 0x45, 0x44, 0x10, 0x02, 0x22, 0x70, 0x0a,
- 0x0b, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x73, 0x49, 0x6e, 0x66, 0x6f, 0x12, 0x40, 0x0a, 0x07,
- 0x72, 0x65, 0x73, 0x75, 0x6c, 0x74, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x26, 0x2e,
+ 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x27, 0x82,
+ 0xd3, 0xe4, 0x93, 0x02, 0x21, 0x3a, 0x01, 0x2a, 0x22, 0x1c, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73,
+ 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f,
+ 0x65, 0x6e, 0x61, 0x62, 0x6c, 0x65, 0x12, 0x86, 0x01, 0x0a, 0x07, 0x64, 0x69, 0x73, 0x61, 0x62,
+ 0x6c, 0x65, 0x12, 0x29, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70,
+ 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e,
+ 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e,
0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70,
0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69,
- 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x52, 0x07, 0x72, 0x65, 0x73, 0x75, 0x6c, 0x74, 0x73, 0x12, 0x1f,
- 0x0a, 0x0b, 0x74, 0x6f, 0x74, 0x61, 0x6c, 0x5f, 0x63, 0x6f, 0x75, 0x6e, 0x74, 0x18, 0x02, 0x20,
- 0x01, 0x28, 0x05, 0x52, 0x0a, 0x74, 0x6f, 0x74, 0x61, 0x6c, 0x43, 0x6f, 0x75, 0x6e, 0x74, 0x22,
- 0x63, 0x0a, 0x0c, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x73, 0x49, 0x6e, 0x66, 0x6f, 0x12,
- 0x18, 0x0a, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x03, 0x28, 0x09,
- 0x52, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x1f, 0x0a, 0x0b, 0x74, 0x6f, 0x74,
- 0x61, 0x6c, 0x5f, 0x63, 0x6f, 0x75, 0x6e, 0x74, 0x18, 0x02, 0x20, 0x01, 0x28, 0x05, 0x52, 0x0a,
- 0x74, 0x6f, 0x74, 0x61, 0x6c, 0x43, 0x6f, 0x75, 0x6e, 0x74, 0x12, 0x18, 0x0a, 0x07, 0x72, 0x65,
- 0x73, 0x75, 0x6c, 0x74, 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x09, 0x52, 0x07, 0x72, 0x65, 0x73,
- 0x75, 0x6c, 0x74, 0x73, 0x2a, 0x69, 0x0a, 0x12, 0x50, 0x75, 0x62, 0x6c, 0x69, 0x63, 0x52, 0x65,
- 0x67, 0x69, 0x73, 0x74, 0x72, 0x79, 0x54, 0x79, 0x70, 0x65, 0x12, 0x16, 0x0a, 0x12, 0x4e, 0x4f,
- 0x4e, 0x45, 0x5f, 0x52, 0x45, 0x47, 0x49, 0x53, 0x54, 0x52, 0x59, 0x5f, 0x54, 0x59, 0x50, 0x45,
- 0x10, 0x00, 0x12, 0x0e, 0x0a, 0x0a, 0x44, 0x4f, 0x43, 0x4b, 0x45, 0x52, 0x5f, 0x48, 0x55, 0x42,
- 0x10, 0x01, 0x12, 0x13, 0x0a, 0x0f, 0x41, 0x57, 0x53, 0x5f, 0x50, 0x52, 0x49, 0x56, 0x41, 0x54,
- 0x45, 0x5f, 0x45, 0x43, 0x52, 0x10, 0x02, 0x12, 0x0a, 0x0a, 0x06, 0x48, 0x41, 0x52, 0x42, 0x4f,
- 0x52, 0x10, 0x03, 0x12, 0x0a, 0x0a, 0x06, 0x47, 0x49, 0x54, 0x48, 0x55, 0x42, 0x10, 0x04, 0x32,
- 0xe1, 0x08, 0x0a, 0x06, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x12, 0x90, 0x01, 0x0a, 0x08, 0x72,
- 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12, 0x31, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f,
- 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72,
- 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x52, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x50, 0x6c, 0x75,
- 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x73, 0x70, 0x61,
- 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69,
- 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e,
- 0x66, 0x6f, 0x22, 0x29, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x23, 0x3a, 0x01, 0x2a, 0x22, 0x1e, 0x2f,
- 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c,
- 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12, 0x8a, 0x01,
- 0x0a, 0x06, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x12, 0x2f, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65,
- 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f,
- 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x50, 0x6c, 0x75, 0x67,
- 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x73, 0x70, 0x61, 0x63,
- 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74,
- 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66,
- 0x6f, 0x22, 0x27, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x21, 0x3a, 0x01, 0x2a, 0x22, 0x1c, 0x2f, 0x72,
- 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75,
- 0x67, 0x69, 0x6e, 0x2f, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x12, 0x7c, 0x0a, 0x0a, 0x64, 0x65,
- 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12, 0x29, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65,
- 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f,
- 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75,
- 0x65, 0x73, 0x74, 0x1a, 0x16, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f,
- 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x45, 0x6d, 0x70, 0x74, 0x79, 0x22, 0x2b, 0x82, 0xd3, 0xe4,
- 0x93, 0x02, 0x25, 0x3a, 0x01, 0x2a, 0x22, 0x20, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74,
- 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x64, 0x65,
- 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12, 0x84, 0x01, 0x0a, 0x06, 0x65, 0x6e, 0x61,
- 0x62, 0x6c, 0x65, 0x12, 0x29, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61,
- 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31,
- 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26,
- 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65,
- 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67,
- 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x27, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x21, 0x3a, 0x01,
- 0x2a, 0x22, 0x1c, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76,
- 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x65, 0x6e, 0x61, 0x62, 0x6c, 0x65, 0x12,
- 0x86, 0x01, 0x0a, 0x07, 0x64, 0x69, 0x73, 0x61, 0x62, 0x6c, 0x65, 0x12, 0x29, 0x2e, 0x73, 0x70,
- 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73,
- 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52,
- 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e,
+ 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x28, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x22, 0x3a, 0x01, 0x2a,
+ 0x22, 0x1d, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31,
+ 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x64, 0x69, 0x73, 0x61, 0x62, 0x6c, 0x65, 0x12,
+ 0x9c, 0x01, 0x0a, 0x0c, 0x67, 0x65, 0x74, 0x5f, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x73,
+ 0x12, 0x33, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e,
+ 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x52, 0x65,
+ 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65,
+ 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x28, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65,
+ 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e,
+ 0x76, 0x31, 0x2e, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x73, 0x49, 0x6e, 0x66, 0x6f, 0x22,
+ 0x2d, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x27, 0x3a, 0x01, 0x2a, 0x22, 0x22, 0x2f, 0x72, 0x65, 0x70,
+ 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69,
+ 0x6e, 0x2f, 0x67, 0x65, 0x74, 0x2d, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x73, 0x12, 0x88,
+ 0x01, 0x0a, 0x03, 0x67, 0x65, 0x74, 0x12, 0x33, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e,
0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79,
- 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x28,
- 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x22, 0x3a, 0x01, 0x2a, 0x22, 0x1d, 0x2f, 0x72, 0x65, 0x70, 0x6f,
- 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e,
- 0x2f, 0x64, 0x69, 0x73, 0x61, 0x62, 0x6c, 0x65, 0x12, 0x9c, 0x01, 0x0a, 0x0c, 0x67, 0x65, 0x74,
- 0x5f, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x73, 0x12, 0x33, 0x2e, 0x73, 0x70, 0x61, 0x63,
- 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74,
- 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x52, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72,
- 0x79, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x28,
- 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65,
- 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x56, 0x65, 0x72, 0x73,
- 0x69, 0x6f, 0x6e, 0x73, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x2d, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x27,
- 0x3a, 0x01, 0x2a, 0x22, 0x22, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79,
- 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x67, 0x65, 0x74, 0x2d, 0x76,
- 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x73, 0x12, 0x88, 0x01, 0x0a, 0x03, 0x67, 0x65, 0x74, 0x12,
- 0x33, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72,
- 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x52, 0x65, 0x70,
- 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71,
- 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e,
- 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76,
- 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x24, 0x82, 0xd3,
- 0xe4, 0x93, 0x02, 0x1e, 0x3a, 0x01, 0x2a, 0x22, 0x19, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69,
- 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x67,
- 0x65, 0x74, 0x12, 0x7f, 0x0a, 0x04, 0x6c, 0x69, 0x73, 0x74, 0x12, 0x27, 0x2e, 0x73, 0x70, 0x61,
+ 0x2e, 0x76, 0x31, 0x2e, 0x52, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x50, 0x6c,
+ 0x75, 0x67, 0x69, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x73, 0x70,
+ 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73,
+ 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x49,
+ 0x6e, 0x66, 0x6f, 0x22, 0x24, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1e, 0x3a, 0x01, 0x2a, 0x22, 0x19,
+ 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70,
+ 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x67, 0x65, 0x74, 0x12, 0x7f, 0x0a, 0x04, 0x6c, 0x69, 0x73,
+ 0x74, 0x12, 0x27, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69,
+ 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50,
+ 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x51, 0x75, 0x65, 0x72, 0x79, 0x1a, 0x27, 0x2e, 0x73, 0x70, 0x61,
0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69,
- 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x51, 0x75,
- 0x65, 0x72, 0x79, 0x1a, 0x27, 0x2e, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2e, 0x61,
- 0x70, 0x69, 0x2e, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31,
- 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x73, 0x49, 0x6e, 0x66, 0x6f, 0x22, 0x25, 0x82, 0xd3,
- 0xe4, 0x93, 0x02, 0x1f, 0x3a, 0x01, 0x2a, 0x22, 0x1a, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69,
- 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x6c,
- 0x69, 0x73, 0x74, 0x42, 0x41, 0x5a, 0x3f, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f,
- 0x6d, 0x2f, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x66, 0x6f, 0x72, 0x65, 0x74, 0x2d, 0x69, 0x6f, 0x2f,
- 0x61, 0x70, 0x69, 0x2f, 0x64, 0x69, 0x73, 0x74, 0x2f, 0x67, 0x6f, 0x2f, 0x73, 0x70, 0x61, 0x63,
- 0x65, 0x6f, 0x6e, 0x65, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74,
- 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
+ 0x74, 0x6f, 0x72, 0x79, 0x2e, 0x76, 0x31, 0x2e, 0x50, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x73, 0x49,
+ 0x6e, 0x66, 0x6f, 0x22, 0x25, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1f, 0x3a, 0x01, 0x2a, 0x22, 0x1a,
+ 0x2f, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x2f, 0x70,
+ 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x2f, 0x6c, 0x69, 0x73, 0x74, 0x42, 0x41, 0x5a, 0x3f, 0x67, 0x69,
+ 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x66, 0x6f,
+ 0x72, 0x65, 0x74, 0x2d, 0x69, 0x6f, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x64, 0x69, 0x73, 0x74, 0x2f,
+ 0x67, 0x6f, 0x2f, 0x73, 0x70, 0x61, 0x63, 0x65, 0x6f, 0x6e, 0x65, 0x2f, 0x61, 0x70, 0x69, 0x2f,
+ 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x2f, 0x76, 0x31, 0x62, 0x06, 0x70,
+ 0x72, 0x6f, 0x74, 0x6f, 0x33,
}
var (
@@ -1332,41 +1368,44 @@ var file_spaceone_api_repository_v1_plugin_proto_depIdxs = []int32{
11, // 2: spaceone.api.repository.v1.RegisterPluginRequest.capability:type_name -> google.protobuf.Struct
12, // 3: spaceone.api.repository.v1.RegisterPluginRequest.labels:type_name -> google.protobuf.ListValue
11, // 4: spaceone.api.repository.v1.RegisterPluginRequest.tags:type_name -> google.protobuf.Struct
- 11, // 5: spaceone.api.repository.v1.UpdatePluginRequest.capability:type_name -> google.protobuf.Struct
- 12, // 6: spaceone.api.repository.v1.UpdatePluginRequest.labels:type_name -> google.protobuf.ListValue
- 11, // 7: spaceone.api.repository.v1.UpdatePluginRequest.tags:type_name -> google.protobuf.Struct
- 13, // 8: spaceone.api.repository.v1.PluginQuery.query:type_name -> spaceone.api.core.v2.Query
- 1, // 9: spaceone.api.repository.v1.PluginQuery.state:type_name -> spaceone.api.repository.v1.PluginQuery.State
- 0, // 10: spaceone.api.repository.v1.PluginQuery.registry_type:type_name -> spaceone.api.repository.v1.PublicRegistryType
- 2, // 11: spaceone.api.repository.v1.PluginInfo.state:type_name -> spaceone.api.repository.v1.PluginInfo.State
- 0, // 12: spaceone.api.repository.v1.PluginInfo.registry_type:type_name -> spaceone.api.repository.v1.PublicRegistryType
- 11, // 13: spaceone.api.repository.v1.PluginInfo.registry_config:type_name -> google.protobuf.Struct
- 11, // 14: spaceone.api.repository.v1.PluginInfo.capability:type_name -> google.protobuf.Struct
- 12, // 15: spaceone.api.repository.v1.PluginInfo.labels:type_name -> google.protobuf.ListValue
- 11, // 16: spaceone.api.repository.v1.PluginInfo.tags:type_name -> google.protobuf.Struct
- 14, // 17: spaceone.api.repository.v1.PluginInfo.repository_info:type_name -> spaceone.api.repository.v1.RepositoryInfo
- 8, // 18: spaceone.api.repository.v1.PluginsInfo.results:type_name -> spaceone.api.repository.v1.PluginInfo
- 3, // 19: spaceone.api.repository.v1.Plugin.register:input_type -> spaceone.api.repository.v1.RegisterPluginRequest
- 4, // 20: spaceone.api.repository.v1.Plugin.update:input_type -> spaceone.api.repository.v1.UpdatePluginRequest
- 5, // 21: spaceone.api.repository.v1.Plugin.deregister:input_type -> spaceone.api.repository.v1.PluginRequest
- 5, // 22: spaceone.api.repository.v1.Plugin.enable:input_type -> spaceone.api.repository.v1.PluginRequest
- 5, // 23: spaceone.api.repository.v1.Plugin.disable:input_type -> spaceone.api.repository.v1.PluginRequest
- 6, // 24: spaceone.api.repository.v1.Plugin.get_versions:input_type -> spaceone.api.repository.v1.RepositoryPluginRequest
- 6, // 25: spaceone.api.repository.v1.Plugin.get:input_type -> spaceone.api.repository.v1.RepositoryPluginRequest
- 7, // 26: spaceone.api.repository.v1.Plugin.list:input_type -> spaceone.api.repository.v1.PluginQuery
- 8, // 27: spaceone.api.repository.v1.Plugin.register:output_type -> spaceone.api.repository.v1.PluginInfo
- 8, // 28: spaceone.api.repository.v1.Plugin.update:output_type -> spaceone.api.repository.v1.PluginInfo
- 15, // 29: spaceone.api.repository.v1.Plugin.deregister:output_type -> google.protobuf.Empty
- 8, // 30: spaceone.api.repository.v1.Plugin.enable:output_type -> spaceone.api.repository.v1.PluginInfo
- 8, // 31: spaceone.api.repository.v1.Plugin.disable:output_type -> spaceone.api.repository.v1.PluginInfo
- 10, // 32: spaceone.api.repository.v1.Plugin.get_versions:output_type -> spaceone.api.repository.v1.VersionsInfo
- 8, // 33: spaceone.api.repository.v1.Plugin.get:output_type -> spaceone.api.repository.v1.PluginInfo
- 9, // 34: spaceone.api.repository.v1.Plugin.list:output_type -> spaceone.api.repository.v1.PluginsInfo
- 27, // [27:35] is the sub-list for method output_type
- 19, // [19:27] is the sub-list for method input_type
- 19, // [19:19] is the sub-list for extension type_name
- 19, // [19:19] is the sub-list for extension extendee
- 0, // [0:19] is the sub-list for field type_name
+ 11, // 5: spaceone.api.repository.v1.RegisterPluginRequest.docs:type_name -> google.protobuf.Struct
+ 11, // 6: spaceone.api.repository.v1.UpdatePluginRequest.capability:type_name -> google.protobuf.Struct
+ 12, // 7: spaceone.api.repository.v1.UpdatePluginRequest.labels:type_name -> google.protobuf.ListValue
+ 11, // 8: spaceone.api.repository.v1.UpdatePluginRequest.tags:type_name -> google.protobuf.Struct
+ 11, // 9: spaceone.api.repository.v1.UpdatePluginRequest.docs:type_name -> google.protobuf.Struct
+ 13, // 10: spaceone.api.repository.v1.PluginQuery.query:type_name -> spaceone.api.core.v2.Query
+ 1, // 11: spaceone.api.repository.v1.PluginQuery.state:type_name -> spaceone.api.repository.v1.PluginQuery.State
+ 0, // 12: spaceone.api.repository.v1.PluginQuery.registry_type:type_name -> spaceone.api.repository.v1.PublicRegistryType
+ 2, // 13: spaceone.api.repository.v1.PluginInfo.state:type_name -> spaceone.api.repository.v1.PluginInfo.State
+ 0, // 14: spaceone.api.repository.v1.PluginInfo.registry_type:type_name -> spaceone.api.repository.v1.PublicRegistryType
+ 11, // 15: spaceone.api.repository.v1.PluginInfo.registry_config:type_name -> google.protobuf.Struct
+ 11, // 16: spaceone.api.repository.v1.PluginInfo.capability:type_name -> google.protobuf.Struct
+ 12, // 17: spaceone.api.repository.v1.PluginInfo.labels:type_name -> google.protobuf.ListValue
+ 11, // 18: spaceone.api.repository.v1.PluginInfo.tags:type_name -> google.protobuf.Struct
+ 11, // 19: spaceone.api.repository.v1.PluginInfo.docs:type_name -> google.protobuf.Struct
+ 14, // 20: spaceone.api.repository.v1.PluginInfo.repository_info:type_name -> spaceone.api.repository.v1.RepositoryInfo
+ 8, // 21: spaceone.api.repository.v1.PluginsInfo.results:type_name -> spaceone.api.repository.v1.PluginInfo
+ 3, // 22: spaceone.api.repository.v1.Plugin.register:input_type -> spaceone.api.repository.v1.RegisterPluginRequest
+ 4, // 23: spaceone.api.repository.v1.Plugin.update:input_type -> spaceone.api.repository.v1.UpdatePluginRequest
+ 5, // 24: spaceone.api.repository.v1.Plugin.deregister:input_type -> spaceone.api.repository.v1.PluginRequest
+ 5, // 25: spaceone.api.repository.v1.Plugin.enable:input_type -> spaceone.api.repository.v1.PluginRequest
+ 5, // 26: spaceone.api.repository.v1.Plugin.disable:input_type -> spaceone.api.repository.v1.PluginRequest
+ 6, // 27: spaceone.api.repository.v1.Plugin.get_versions:input_type -> spaceone.api.repository.v1.RepositoryPluginRequest
+ 6, // 28: spaceone.api.repository.v1.Plugin.get:input_type -> spaceone.api.repository.v1.RepositoryPluginRequest
+ 7, // 29: spaceone.api.repository.v1.Plugin.list:input_type -> spaceone.api.repository.v1.PluginQuery
+ 8, // 30: spaceone.api.repository.v1.Plugin.register:output_type -> spaceone.api.repository.v1.PluginInfo
+ 8, // 31: spaceone.api.repository.v1.Plugin.update:output_type -> spaceone.api.repository.v1.PluginInfo
+ 15, // 32: spaceone.api.repository.v1.Plugin.deregister:output_type -> google.protobuf.Empty
+ 8, // 33: spaceone.api.repository.v1.Plugin.enable:output_type -> spaceone.api.repository.v1.PluginInfo
+ 8, // 34: spaceone.api.repository.v1.Plugin.disable:output_type -> spaceone.api.repository.v1.PluginInfo
+ 10, // 35: spaceone.api.repository.v1.Plugin.get_versions:output_type -> spaceone.api.repository.v1.VersionsInfo
+ 8, // 36: spaceone.api.repository.v1.Plugin.get:output_type -> spaceone.api.repository.v1.PluginInfo
+ 9, // 37: spaceone.api.repository.v1.Plugin.list:output_type -> spaceone.api.repository.v1.PluginsInfo
+ 30, // [30:38] is the sub-list for method output_type
+ 22, // [22:30] is the sub-list for method input_type
+ 22, // [22:22] is the sub-list for extension type_name
+ 22, // [22:22] is the sub-list for extension extendee
+ 0, // [0:22] is the sub-list for field type_name
}
func init() { file_spaceone_api_repository_v1_plugin_proto_init() }
diff --git a/dist/json/cloudforet/api/repository/v1/Plugin.json b/dist/json/cloudforet/api/repository/v1/Plugin.json
index 4538f3a14..5fae5d961 100755
--- a/dist/json/cloudforet/api/repository/v1/Plugin.json
+++ b/dist/json/cloudforet/api/repository/v1/Plugin.json
@@ -245,6 +245,18 @@
"oneofdecl": "",
"defaultValue": ""
},
+ {
+ "name": "docs",
+ "description": "",
+ "label": "",
+ "type": "Struct",
+ "longType": "google.protobuf.Struct",
+ "fullType": "google.protobuf.Struct",
+ "ismap": false,
+ "isoneof": false,
+ "oneofdecl": "",
+ "defaultValue": ""
+ },
{
"name": "domain_id",
"description": "",
@@ -592,6 +604,18 @@
"isoneof": false,
"oneofdecl": "",
"defaultValue": ""
+ },
+ {
+ "name": "docs",
+ "description": "+optional\n{\"en\": {}, \"ko\": {}, \"ja\":{}}",
+ "label": "",
+ "type": "Struct",
+ "longType": "google.protobuf.Struct",
+ "fullType": "google.protobuf.Struct",
+ "ismap": false,
+ "isoneof": false,
+ "oneofdecl": "",
+ "defaultValue": ""
}
]
},
@@ -700,6 +724,18 @@
"isoneof": false,
"oneofdecl": "",
"defaultValue": ""
+ },
+ {
+ "name": "docs",
+ "description": "+optional",
+ "label": "",
+ "type": "Struct",
+ "longType": "google.protobuf.Struct",
+ "fullType": "google.protobuf.Struct",
+ "ismap": false,
+ "isoneof": false,
+ "oneofdecl": "",
+ "defaultValue": ""
}
]
},
diff --git a/dist/openapi/cloudforet/api/board/v1/openapi.json b/dist/openapi/cloudforet/api/board/v1/openapi.json
index 622c602d0..d843b6653 100755
--- a/dist/openapi/cloudforet/api/board/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/board/v1/openapi.json
@@ -259,44 +259,6 @@
"required": ["post_id"],
"title": "UpdatePostRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
@@ -465,6 +427,44 @@
"type": "object",
"required": ["path","filter"],
"title": "Unwind"
+ }
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/config/v1/openapi.json b/dist/openapi/cloudforet/api/config/v1/openapi.json
index edfbdeb6c..3bab8dab4 100755
--- a/dist/openapi/cloudforet/api/config/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/config/v1/openapi.json
@@ -373,9 +373,9 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/workspace-config/create": {
+ },"/config/user-config/create": {
"post": {
- "tags": ["config > workspace-config"],
+ "tags": ["config > user-config"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
@@ -395,16 +395,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/workspace-config/update": {
+ },"/config/user-config/update": {
"post": {
- "tags": ["config > workspace-config"],
+ "tags": ["config > user-config"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
@@ -424,16 +424,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/workspace-config/set": {
+ },"/config/user-config/set": {
"post": {
- "tags": ["config > workspace-config"],
+ "tags": ["config > user-config"],
"summary": "Set",
"operationId" : "",
"description": "### Description \n",
@@ -453,16 +453,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/workspace-config/delete": {
+ },"/config/user-config/delete": {
"post": {
- "tags": ["config > workspace-config"],
+ "tags": ["config > user-config"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
@@ -483,9 +483,9 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/workspace-config/get": {
+ },"/config/user-config/get": {
"post": {
- "tags": ["config > workspace-config"],
+ "tags": ["config > user-config"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
@@ -505,16 +505,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/workspace-config/list": {
+ },"/config/user-config/list": {
"post": {
- "tags": ["config > workspace-config"],
+ "tags": ["config > user-config"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
@@ -534,16 +534,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceConfigsInfo"},
+ "schema": {"$ref": "#/components/schemas/UserConfigsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceConfigsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserConfigsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/workspace-config/stat": {
+ },"/config/user-config/stat": {
"post": {
- "tags": ["config > workspace-config"],
+ "tags": ["config > user-config"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -570,9 +570,9 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/user-config/create": {
+ },"/config/workspace-config/create": {
"post": {
- "tags": ["config > user-config"],
+ "tags": ["config > workspace-config"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
@@ -592,16 +592,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/user-config/update": {
+ },"/config/workspace-config/update": {
"post": {
- "tags": ["config > user-config"],
+ "tags": ["config > workspace-config"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
@@ -621,16 +621,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/user-config/set": {
+ },"/config/workspace-config/set": {
"post": {
- "tags": ["config > user-config"],
+ "tags": ["config > workspace-config"],
"summary": "Set",
"operationId" : "",
"description": "### Description \n",
@@ -650,16 +650,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/user-config/delete": {
+ },"/config/workspace-config/delete": {
"post": {
- "tags": ["config > user-config"],
+ "tags": ["config > workspace-config"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
@@ -680,9 +680,9 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/user-config/get": {
+ },"/config/workspace-config/get": {
"post": {
- "tags": ["config > user-config"],
+ "tags": ["config > workspace-config"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
@@ -702,16 +702,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/user-config/list": {
+ },"/config/workspace-config/list": {
"post": {
- "tags": ["config > user-config"],
+ "tags": ["config > workspace-config"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
@@ -731,16 +731,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserConfigsInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceConfigsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserConfigsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceConfigsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/config/user-config/stat": {
+ },"/config/workspace-config/stat": {
"post": {
- "tags": ["config > user-config"],
+ "tags": ["config > workspace-config"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -808,44 +808,6 @@
"required": ["name","data"],
"title": "SetDomainConfigRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
@@ -1015,6 +977,44 @@
"required": ["path","filter"],
"title": "Unwind"
}
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
+ }
, "CreatePublicConfigRequest": {
"properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
@@ -1058,6 +1058,43 @@
"required": ["name","data"],
"title": "UpdatePublicConfigRequest"
}
+ , "SetUserConfigRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["name","data"],
+ "title": "SetUserConfigRequest"
+ }
+ , "UserConfigInfo": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["name","data","tags","domain_id","user_id","created_at","updated_at"],
+ "title": "UserConfigInfo"
+ }
+ , "UserConfigQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"name" : {"type": "string","title": "NAME"}},
+ "type": "object",
+ "required": [],
+ "title": "UserConfigQuery"
+ }
+ , "UserConfigRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"}},
+ "type": "object",
+ "required": ["name"],
+ "title": "UserConfigRequest"
+ }
+ , "UserConfigStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "UserConfigStatQuery"
+ }
+ , "UserConfigsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserConfigInfo"},
+ "type": "array","$ref": "#/components/schemas/UserConfigInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "UserConfigsInfo"
+ }
, "CreateWorkspaceConfigRequest": {
"properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
@@ -1100,43 +1137,6 @@
"type": "object",
"required": ["results","total_count"],
"title": "WorkspaceConfigsInfo"
- }
- , "SetUserConfigRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["name","data"],
- "title": "SetUserConfigRequest"
- }
- , "UserConfigInfo": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
- "type": "object",
- "required": ["name","data","tags","domain_id","user_id","created_at","updated_at"],
- "title": "UserConfigInfo"
- }
- , "UserConfigQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"name" : {"type": "string","title": "NAME"}},
- "type": "object",
- "required": [],
- "title": "UserConfigQuery"
- }
- , "UserConfigRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"}},
- "type": "object",
- "required": ["name"],
- "title": "UserConfigRequest"
- }
- , "UserConfigStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
- "type": "object",
- "required": ["query"],
- "title": "UserConfigStatQuery"
- }
- , "UserConfigsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserConfigInfo"},
- "type": "array","$ref": "#/components/schemas/UserConfigInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "UserConfigsInfo"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/cost_analysis/v1/openapi.json b/dist/openapi/cloudforet/api/cost_analysis/v1/openapi.json
index 686812545..c00d1edba 100755
--- a/dist/openapi/cloudforet/api/cost_analysis/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/cost_analysis/v1/openapi.json
@@ -8,18 +8,18 @@
"title": "Cost Analysis API",
"version": "3.1.0"
},
- "paths":{"/cost-analysis/data-source-account/update": {
+ "paths":{"/cost-analysis/cost-report-config/create": {
"post": {
- "tags": ["cost-analysis > data-source-account"],
- "summary": "Update",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nUpdate a DataSourceAccount with the specified DataSourceAccount ID related to the DataSource.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |account_id|account_id is the unique identifier of each CSP account.(e.g. Azure Tenant ID)|string|True|\n |workspace_id||string||\n |project_id||string||\n |service_account_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |recipients||Struct|True|\n |issue_day||int||\n |is_last_day||boolean||\n |currency||string||\n |data_source_filter||Struct||\n |language|Default `en` |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"issue_day" : {"type": "integer","title": "ISSUE_DAY" },"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY" },"currency" : {"type": "string","title": "CURRENCY" },"recipients" : {"type": "object","title": "RECIPIENTS" },"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER" },"language" : {"type": "string","title": "LANGUAGE" } }
},
"examples":{"Schema":{}
}
@@ -30,25 +30,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-account/reset": {
+ },"/cost-analysis/cost-report-config/update": {
"post": {
- "tags": ["cost-analysis > data-source-account"],
- "summary": "Reset",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |account_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n |issue_day||int||\n |is_last_day||boolean||\n |currency||string||\n |data_source_filter||Struct||\n |language||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" } }
+ "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"issue_day" : {"type": "integer","title": "ISSUE_DAY" },"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY" },"currency" : {"type": "string","title": "CURRENCY" },"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER" },"language" : {"type": "string","title": "LANGUAGE" } }
},
"examples":{"Schema":{}
}
@@ -57,21 +57,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-account/get": {
+ },"/cost-analysis/cost-report-config/update-recipients": {
"post": {
- "tags": ["cost-analysis > data-source-account"],
- "summary": "Get",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Update Recipients",
"operationId" : "",
- "description": "### Description \nGet a DataSourceAccount with the specified DataSourceAccount ID related to the DataSource.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_account_id||string|True|\n |account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id||string|True|\n |recipients||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_account_id" : {"type": "string","title": "DATA_SOURCE_ACCOUNT_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" } }
+ "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"recipients" : {"type": "object","title": "RECIPIENTS" } }
},
"examples":{"Schema":{}
}
@@ -82,25 +88,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-account/list": {
+ },"/cost-analysis/cost-report-config/enable": {
"post": {
- "tags": ["cost-analysis > data-source-account"],
- "summary": "List",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |data_source_id||string||\n |account_id||string||\n |workspace_id||string||\n |project_id||string||\n |service_account_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
},
"examples":{"Schema":{}
}
@@ -111,25 +117,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceAccountsInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceAccountsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-account/analyze": {
+ },"/cost-analysis/cost-report-config/disable": {
"post": {
- "tags": ["cost-analysis > data-source-account"],
- "summary": "Analyze",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |data_source_id||string|True|\n |account_id||string|True|\n |workspace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
},
"examples":{"Schema":{}
}
@@ -140,25 +146,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-account/stat": {
+ },"/cost-analysis/cost-report-config/delete": {
"post": {
- "tags": ["cost-analysis > data-source-account"],
- "summary": "Stat",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
},
"examples":{"Schema":{}
}
@@ -167,29 +173,46 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
+ "description": "Successfull Response"}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/cost-analysis/cost-report-config/run": {
+ "post": {
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Run",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
+ },
+ "examples":{"Schema":{}
}
- }}
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/register": {
+ },"/cost-analysis/cost-report-config/get": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Register",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nRegisters a DataSource with information of the plugin to use. Information of the plugin includes `version`, `provider`, and `upgrade_mode`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data_source_type|LOCAL, EXTERNAL |string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |provider||string||\n |secret_type|MANUAL, USE_SERVICE_ACCOUNT_SECRET |string||\n |secret_filter||SecretFilter||\n |template||Struct||\n |plugin_info||PluginInfo||\n |tags||Struct||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"data_source_type" : {"type": "string","title": "DATA_SOURCE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"secret_type" : {"type": "string","title": "SECRET_TYPE" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"template" : {"type": "object","title": "TEMPLATE" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"AWS HyperBilling Data Source test\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"conditions_policy\": \"ALWAYS\",\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"conditions\": [],\n \"tags\": {},\n \"name\": \"match_service_account\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\"a\": \"b\"}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -198,29 +221,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/update": {
+ },"/cost-analysis/cost-report-config/list": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Update",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nUpdates a specific DataSource. You can make changes in DataSource settings, including `name` and `tags`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |name||string||\n |secret_filter||SecretFilter||\n |template||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cost_report_config_id|The ID of cost report in the Protocol. |string||\n |state|ENABLED, DISABLED |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"template" : {"type": "object","title": "TEMPLATE" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"state" : {"type": "string","title": "STATE" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test2\",\n \"tags\": {\n \"type\": \"test\"\n }\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -229,29 +250,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/update-permissions": {
+ },"/cost-analysis/cost-report-config/stat": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Update Permissions",
+ "tags": ["cost-analysis > cost-report-config"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |permissions||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"permissions" : {"type": "object","title": "PERMISSIONS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\" : \"ds-12331222\",\n \"permissions\" : {\"deny\": [\"data.PayAsYouGo\", \"data.ActualCost\"]}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -260,29 +279,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/update-plugin": {
+ },"/cost-analysis/cost-query-set/create": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Update Plugin",
+ "tags": ["cost-analysis > cost-query-set"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nUpdates the plugin of a specific DataSource. This method resets the plugin data in the DataSource to update the `metadata`.",
+ "description": "### Description \nCreates a new CostQuerySet. You can make your own custom query that meets your needs, and input it as an `option` parameter of the resource. Queries such as `group_by` and `granularity` are provided by default.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |name||string|True|\n |options||Struct|True|\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"upgrade_mode\": \"AUTO\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"project_provider_region\",\n \"options\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -291,29 +308,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},"Default Example":{
+ "value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/update-secret-data": {
+ },"/cost-analysis/cost-query-set/update": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Update Secret Data",
+ "tags": ["cost-analysis > cost-query-set"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdates the secret data of plugin for DataSource. This method updates the secret data in the DataSource to update the `secret_data`.",
+ "description": "### Description \nUpdates a specific CostQuerySet. You can make changes in the details of queries.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_query_set_id||string|True|\n |name||string||\n |options||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" } }
+ "properties": {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"},"Schema":{}
}
}
},"required": true
@@ -322,29 +339,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},"Default Example":{
+ "value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/verify-plugin": {
+ },"/cost-analysis/cost-query-set/delete": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Verify Plugin",
+ "tags": ["cost-analysis > cost-query-set"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \nVerifies the plugin of a specific DataSource. This method validates the plugin data, `version` and `endpoint`.",
+ "description": "### Description \nDeletes a specific CostQuerySet. You must specify the `cost_query_set_id` of the CostQuerySet to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cost_query_set_id\": \"query-16ae671dc8fb\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
}
}
},"required": true
@@ -354,20 +371,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/enable": {
+ },"/cost-analysis/cost-query-set/get": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Enable",
+ "tags": ["cost-analysis > cost-query-set"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nEnables a specific DataSource. By enabling a DataSource, you can communicate with an external cloud service via the plugin.",
+ "description": "### Description \nGets a specific CostQuerySet. Prints detailed information about the CostQuerySet, including the details of queries.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cost_query_set_id\": \"query-16ae671dc8fb\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
}
}
},"required": true
@@ -376,29 +393,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},"Default Example":{
+ "value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/disable": {
+ },"/cost-analysis/cost-query-set/list": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Disable",
+ "tags": ["cost-analysis > cost-query-set"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nDisables a specific DataSource. By disabling a DataSource, you can block communication with an external cloud service via the plugin.",
+ "description": "### Description \nGets a list of all CostQuerySets. You can use a query to get a filtered list of CostQuerySets.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |query||Query||\n |name||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -407,52 +424,58 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/CostQuerySetsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CostQuerySetsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"cost_query_set_id\": \"query-16ae671dc8fb\",\n \"name\": \"3 month product pie chart\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"yuda@mz.co.kr\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-03-08T03:37:31.404Z\",\n \"updated_at\": \"2022-03-08T03:37:31.404Z\"\n },\n {\n \"cost_query_set_id\": \"query-d90addf25e4b\",\n \"name\": \"6 month project group\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"yuda@mz.co.kr\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-03-14T09:29:54.306Z\",\n \"updated_at\": \"2022-03-14T09:29:54.306Z\"\n }\n ],\n \"total_count\": 34\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/deregister": {
+ },"/cost-analysis/cost-query-set/stat": {
"post": {
- "tags": ["cost-analysis > data-source"],
- "summary": "Deregister",
+ "tags": ["cost-analysis > cost-query-set"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nDeregisters and deletes a specific DataSource. You must specify the `data_source_id` of the DataSource to deregister.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |cascade_delete_cost|Default value is true. If true delete all cost data related to data_source_id |boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"cascade_delete_cost" : {"type": "boolean","title": "CASCADE_DELETE_COST" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"cascade_delete_cost\": true,\n \"domain_id\": \"domain-085d1e872789\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/sync": {
+ },"/cost-analysis/data-source/register": {
"post": {
"tags": ["cost-analysis > data-source"],
- "summary": "Sync",
+ "summary": "Register",
"operationId" : "",
- "description": "### Description \nManually runs a specific DataSource to collect the cost data. This method is to get up-to-date cost data.",
+ "description": "### Description \nRegisters a DataSource with information of the plugin to use. Information of the plugin includes `version`, `provider`, and `upgrade_mode`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |start||string||\n |no_preload_cache||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data_source_type|LOCAL, EXTERNAL |string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |provider||string||\n |secret_type|MANUAL, USE_SERVICE_ACCOUNT_SECRET |string||\n |secret_filter||SecretFilter||\n |template||Struct||\n |plugin_info||PluginInfo||\n |tags||Struct||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"start" : {"type": "string","title": "START" },"no_preload_cache" : {"type": "boolean","title": "NO_PRELOAD_CACHE" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"data_source_type" : {"type": "string","title": "DATA_SOURCE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"secret_type" : {"type": "string","title": "SECRET_TYPE" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"template" : {"type": "object","title": "TEMPLATE" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"AWS HyperBilling Data Source test\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"conditions_policy\": \"ALWAYS\",\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"conditions\": [],\n \"tags\": {},\n \"name\": \"match_service_account\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\"a\": \"b\"}\n}"},"Schema":{}
}
}
},"required": true
@@ -461,29 +484,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
- "value": "{\n \"job_id\": \"job-07994c7c9021\",\n \"status\": \"CANCELED\",\n \"options\": {\n \"no_preload_cache\": false,\n \"start\": \"2021-01-01T00:00:00Z\"\n },\n \"total_tasks\": 2,\n \"remained_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-02T09:17:44.031Z\",\n \"updated_at\": \"2022-04-02T09:19:47.715Z\",\n \"finished_at\": \"2022-04-02T09:19:47.715Z\",\n \"changed\": [\n {\n \"start\": \"2021-01-01T00:00:00.000Z\"\n }\n ]\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/get": {
+ },"/cost-analysis/data-source/update": {
"post": {
"tags": ["cost-analysis > data-source"],
- "summary": "Get",
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nGets a specific DataSource. Prints detailed information about the DataSource, including `name`, `state`, and `plugin_info`.",
+ "description": "### Description \nUpdates a specific DataSource. You can make changes in DataSource settings, including `name` and `tags`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |name||string||\n |secret_filter||SecretFilter||\n |template||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"template" : {"type": "object","title": "TEMPLATE" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test2\",\n \"tags\": {\n \"type\": \"test\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -501,20 +524,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/list": {
+ },"/cost-analysis/data-source/update-permissions": {
"post": {
"tags": ["cost-analysis > data-source"],
- "summary": "List",
+ "summary": "Update Permissions",
"operationId" : "",
- "description": "### Description \nGets a list of all DataSources. You can use a query to get a filtered list of DataSources.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |query||Query||\n |data_source_id||string||\n |name||string||\n |state||string||\n |data_source_type|LOCAL, EXTERNAL |string||\n |provider||string||\n |connected_workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |permissions||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"data_source_type" : {"type": "string","title": "DATA_SOURCE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"connected_workspace_id" : {"type": "string","title": "CONNECTED_WORKSPACE_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"permissions" : {"type": "object","title": "PERMISSIONS" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\" : \"ds-12331222\",\n \"permissions\" : {\"deny\": [\"data.PayAsYouGo\", \"data.ActualCost\"]}\n}"},"Schema":{}
}
}
},"required": true
@@ -523,29 +546,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourcesInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourcesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source/stat": {
+ },"/cost-analysis/data-source/update-plugin": {
"post": {
"tags": ["cost-analysis > data-source"],
- "summary": "Stat",
+ "summary": "Update Plugin",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nUpdates the plugin of a specific DataSource. This method resets the plugin data in the DataSource to update the `metadata`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"upgrade_mode\": \"AUTO\"\n}"},"Schema":{}
}
}
},"required": true
@@ -554,27 +577,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-rule/create": {
+ },"/cost-analysis/data-source/update-secret-data": {
"post": {
- "tags": ["cost-analysis > data-source-rule"],
- "summary": "Create",
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Update Secret Data",
"operationId" : "",
- "description": "### Description \nCreates a new DataSourceRule. When creating the resource, this method can apply two types of conditions: mapping projects where the cost incurred to the Cost, and mapping cloud service accounts to the Cost. By adjusting the `condition_policy` parameter, the DataSourceRule can be applied when all conditions are met, applied when any of the conditions are met, or always applied regardless of whether the conditions are met.",
+ "description": "### Description \nUpdates the secret data of plugin for DataSource. This method updates the secret data in the DataSource to update the `secret_data`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |conditions_policy|ALL, ANY, ALWAYS |string|True|\n |actions||DataSourceRuleActions|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |workspace_id||string|True|\n |name||string||\n |conditions||array||\n |options||DataSourceRuleOptions||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\"source\": \"account\", \"target\": \"data.project_id\"}\n },\n \"options\": {\"stop_processing\": true},\n \"tags\": {\"b\": \"c\", \"a\": \"b\"}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -583,29 +608,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
- "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-rule/update": {
+ },"/cost-analysis/data-source/verify-plugin": {
"post": {
- "tags": ["cost-analysis > data-source-rule"],
- "summary": "Update",
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Verify Plugin",
"operationId" : "",
- "description": "### Description \nUpdates a specific DataSourceRule. You can make changes in DataSourceRule settings, including filtering conditions. If the parameter `is_default` is `true`, only `Admin` type User can use this method.",
+ "description": "### Description \nVerifies the plugin of a specific DataSource. This method validates the plugin data, `version` and `endpoint`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n |name||string||\n |conditions||array||\n |conditions_policy|ALL, ANY, ALWAYS |string||\n |actions||DataSourceRuleActions||\n |options||DataSourceRuleOptions||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\"b\": \"c\", \"a\": \"b\"}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response"}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/cost-analysis/data-source/enable": {
+ "post": {
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Enable",
+ "operationId" : "",
+ "description": "### Description \nEnables a specific DataSource. By enabling a DataSource, you can communicate with an external cloud service via the plugin.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
}
}
},"required": true
@@ -614,29 +662,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
- "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-rule/change-order": {
+ },"/cost-analysis/data-source/disable": {
"post": {
- "tags": ["cost-analysis > data-source-rule"],
- "summary": "Change Order",
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Disable",
"operationId" : "",
- "description": "### Description \nChanges the priority order of the DataSourceRules to apply. If there are multiple DataSourceRules applied in a specific service account, the priority order of the resources is requried. This method changes the priority order to apply DataSourceRules.",
+ "description": "### Description \nDisables a specific DataSource. By disabling a DataSource, you can block communication with an external cloud service via the plugin.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n |order||int|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" },"order" : {"type": "integer","title": "ORDER" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"order\": 2\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
}
}
},"required": true
@@ -645,29 +693,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
- "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-rule/delete": {
+ },"/cost-analysis/data-source/deregister": {
"post": {
- "tags": ["cost-analysis > data-source-rule"],
- "summary": "Delete",
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Deregister",
"operationId" : "",
- "description": "### Description \nDeletes a specific DataSourceRule. You must specify the `data_source_rule_id` of the DataSourceRule to delete. If the parameter `is_default` is `true`, only `Admin` type User can use this method.",
+ "description": "### Description \nDeregisters and deletes a specific DataSource. You must specify the `data_source_id` of the DataSource to deregister.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |cascade_delete_cost|Default value is true. If true delete all cost data related to data_source_id |boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"cascade_delete_cost" : {"type": "boolean","title": "CASCADE_DELETE_COST" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-22fab02f6b51\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"cascade_delete_cost\": true,\n \"domain_id\": \"domain-085d1e872789\"\n}"},"Schema":{}
}
}
},"required": true
@@ -677,20 +725,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-rule/get": {
+ },"/cost-analysis/data-source/sync": {
"post": {
- "tags": ["cost-analysis > data-source-rule"],
- "summary": "Get",
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Sync",
"operationId" : "",
- "description": "### Description \nGets a specific DataSourceRule. Prints detailed information about the DataSourceRule, including `conditions_policy` and conditions applied to DataSources.",
+ "description": "### Description \nManually runs a specific DataSource to collect the cost data. This method is to get up-to-date cost data.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |start||string||\n |no_preload_cache||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"start" : {"type": "string","title": "START" },"no_preload_cache" : {"type": "boolean","title": "NO_PRELOAD_CACHE" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-22fab02f6b51\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -699,29 +747,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/JobInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
- "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
+ "value": "{\n \"job_id\": \"job-07994c7c9021\",\n \"status\": \"CANCELED\",\n \"options\": {\n \"no_preload_cache\": false,\n \"start\": \"2021-01-01T00:00:00Z\"\n },\n \"total_tasks\": 2,\n \"remained_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-02T09:17:44.031Z\",\n \"updated_at\": \"2022-04-02T09:19:47.715Z\",\n \"finished_at\": \"2022-04-02T09:19:47.715Z\",\n \"changed\": [\n {\n \"start\": \"2021-01-01T00:00:00.000Z\"\n }\n ]\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-rule/list": {
+ },"/cost-analysis/data-source/get": {
"post": {
- "tags": ["cost-analysis > data-source-rule"],
- "summary": "List",
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a list of all DataSourceRules. You can use a query to get a filtered list of DataSourceRules.",
+ "description": "### Description \nGets a specific DataSource. Prints detailed information about the DataSource, including `name`, `state`, and `plugin_info`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |data_source_rule_id||string||\n |name||string||\n |rule_type|MANAGED, CUSTOM |string||\n |workspace_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" },"name" : {"type": "string","title": "NAME" },"rule_type" : {"type": "string","title": "RULE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\"\n}"},"Schema":{}
}
}
},"required": true
@@ -730,29 +778,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceRulesInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceRulesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"data_source_rule_id\": \"rule-22fab02f6b51\",\n \"name\": \"match_service_account\",\n \"order\": 1,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {},\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-05-25T16:01:51.858Z\"\n },\n {\n \"data_source_rule_id\": \"rule-188d366e9817\",\n \"name\": \"match_service_account\",\n \"order\": 1,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {},\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-03T16:00:54.099Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/data-source-rule/stat": {
+ },"/cost-analysis/data-source/list": {
"post": {
- "tags": ["cost-analysis > data-source-rule"],
- "summary": "Stat",
+ "tags": ["cost-analysis > data-source"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of all DataSources. You can use a query to get a filtered list of DataSources.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |query||Query||\n |data_source_id||string||\n |name||string||\n |state||string||\n |data_source_type|LOCAL, EXTERNAL |string||\n |provider||string||\n |connected_workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"data_source_type" : {"type": "string","title": "DATA_SOURCE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"connected_workspace_id" : {"type": "string","title": "CONNECTED_WORKSPACE_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -761,27 +809,58 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/DataSourcesInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/DataSourcesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"AWS HyperBilling Data Source test\",\n \"state\": \"ENABLED\",\n \"data_source_type\": \"EXTERNAL\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"version\": \"1.0.4\",\n \"options\": {},\n \"metadata\": {\n \"data_source_rules\": [\n {\n \"options\": {\n \"stop_processing\": true\n },\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"conditions\": [],\n \"name\": \"match_service_account\",\n \"tags\": {},\n \"data_source_id\": \"ds-085d1e872789\",\n \"conditions_policy\": \"ALWAYS\"\n }\n ]\n },\n \"secret_id\": \"secret-ca134639483\",\n \"upgrade_mode\": \"AUTO\"\n },\n \"template\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"cost_tag_keys\": [\n \"Name\",\n \"Environment\",\n \"Role\",\n \"Service\"\n ],\n \"cost_additional_info_keys\": [\n \"Instance Type\",\n \"Usage Type Details\"\n ],\n \"cost_data_keys\": [\n \"AmortizedCost\",\n \"BlendedCost\",\n ]\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:58:36.080Z\"\n }\n ],\n \"total_count\": 2\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget-usage/list": {
+ },"/cost-analysis/data-source/stat": {
"post": {
- "tags": ["cost-analysis > budget-usage"],
+ "tags": ["cost-analysis > data-source"],
+ "summary": "Stat",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/cost-analysis/cost-report-data/list": {
+ "post": {
+ "tags": ["cost-analysis > cost-report-data"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all BudgetUsages. You can use a query to get a filtered list of BudgetUsages.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |name||string||\n |date||string||\n |workspace_id||string||\n |project_id||string||\n |budget_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cost_report_data_id||string||\n |product||string||\n |provider||string||\n |is_confirmed||boolean||\n |workspace_id||string||\n |cost_report_config_id||string||\n |cost_report_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"name" : {"type": "string","title": "NAME" },"date" : {"type": "string","title": "DATE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cost_report_data_id" : {"type": "string","title": "COST_REPORT_DATA_ID" },"product" : {"type": "string","title": "PRODUCT" },"provider" : {"type": "string","title": "PROVIDER" },"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -790,27 +869,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/BudgetUsagesInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportsDataInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/BudgetUsagesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"budget_id\": \"budget-abb377eb9e8b\",\n \"name\": \"Cloudforet-Budget3\",\n \"date\": \"2022-01\",\n \"cost\": 7671.164,\n \"limit\": 10000.0,\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"project_id\": \"project-1b2b3b4b5b6b\",\n \"data_source_id\": \"data-source-1b2b3b4b5b6b\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"updated_at\": \"2022-07-19T04:26:08.099Z\"\n },\n {\n \"budget_id\": \"budget-abb377eb9e8b\",\n \"name\": \"Cloudforet-Budget3\",\n \"date\": \"2022-02\",\n \"cost\": 5931.771,\n \"limit\": 11000.0,\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"DISABLED\",\n \"providers\": []\n },\n \"project_id\": \"project-1b2b3b4b5b6b\",\n \"data_source_id\": \"data-source-1b2b3b4b5b6b\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"updated_at\": \"2022-07-19T04:26:08.105Z\"\n }\n ],\n \"total_count\": 12\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CostReportsDataInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget-usage/analyze": {
+ },"/cost-analysis/cost-report-data/analyze": {
"post": {
- "tags": ["cost-analysis > budget-usage"],
+ "tags": ["cost-analysis > cost-report-data"],
"summary": "Analyze",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |budget_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery||\n |product||string||\n |provider||string||\n |is_confirmed||boolean||\n |workspace_id||string||\n |project_id||string||\n |cost_report_config_id||string||\n |cost_report_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"product" : {"type": "string","title": "PRODUCT" },"provider" : {"type": "string","title": "PROVIDER" },"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
"examples":{"Schema":{}
}
@@ -828,18 +905,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget-usage/stat": {
+ },"/cost-analysis/cost-report-data/stat": {
"post": {
- "tags": ["cost-analysis > budget-usage"],
+ "tags": ["cost-analysis > cost-report-data"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |budget_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |cost_report_id||string||\n |cost_report_config_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
},
"examples":{"Schema":{}
}
@@ -1031,20 +1108,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/job-task/get": {
+ },"/cost-analysis/budget/create": {
"post": {
- "tags": ["cost-analysis > job-task"],
- "summary": "Get",
+ "tags": ["cost-analysis > budget"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nGets a specific JobTask. Prints detailed information about the JobTask, including the relevant resources: DataSource and Job. The criteria used for dividing a Job into JobTasks can be found in the DataSource used, but the total count of divided JobTasks can be found by this method.",
+ "description": "### Description \nCreates a new Budget. When creating a Budget, it should be set for a specific ProjectGroup or Project. The budgeted amount and date of the `planned_limits` should be specified on a monthly or yearly basis.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_task_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |time_unit|TOTAL, MONTHLY |string|True|\n |start||string|True|\n |end||string|True|\n |resource_group|WORKSPACE, PROJECT |string|True|\n |name||string||\n |limit||float||\n |planned_limits||array||\n |provider_filter||ProviderFilter||\n |notifications||array||\n |tags||Struct||\n |workspace_id||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_task_id" : {"type": "string","title": "JOB_TASK_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"limit" : {"type": "float","title": "LIMIT" },"planned_limits" : {"items": {"$ref": "#/components/schemas/PlannedLimit"}, "type": "array","title": "PLANNED_LIMITS" },"provider_filter" : {"$ref": "#/components/schemas/ProviderFilter","title": "PROVIDER_FILTER" },"time_unit" : {"type": "string","title": "TIME_UNIT" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"notifications" : {"items": {"$ref": "#/components/schemas/BudgetNotification"}, "type": "array","title": "NOTIFICATIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_task_id\": \"job-task-3622d860a776\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"Cloudforet-Budget\",\n \"planned_limits\": [{\"date\": \"2022-01\", \"limit\": 1000.0},\n {\"date\": \"2022-02\", \"limit\": 1100.0},\n {\"date\": \"2022-03\", \"limit\": 1200.0},\n {\"date\": \"2022-04\", \"limit\": 1300.0},\n {\"date\": \"2022-05\", \"limit\": 1400.0},\n {\"date\": \"2022-06\", \"limit\": 1500.0},\n {\"date\": \"2022-07\", \"limit\": 1600.0},\n {\"date\": \"2022-08\", \"limit\": 1700.0},\n {\"date\": \"2022-09\", \"limit\": 1800.0},\n {\"date\": \"2022-10\", \"limit\": 1900.0},\n {\"date\": \"2022-11\", \"limit\": 2000.0},\n {\"date\": \"2022-12\", \"limit\": 2100.0}],\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1053,29 +1130,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobTaskInfo"},
+ "schema": {"$ref": "#/components/schemas/BudgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobTaskInfo"},"Default Example":{
- "value": "{\n \"job_task_id\": \"job-task-3622d860a776\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"month\": \"202207\",\n \"platform\": \"gcp\"\n },\n \"created_count\": 1,\n \"job_id\": \"job-85cf2c385252\",\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:08.266Z\",\n \"started_at\": \"2022-07-17T16:01:28.243Z\",\n \"updated_at\": \"2022-07-17T16:01:28.939Z\",\n \"finished_at\": \"2022-07-17T16:01:28.939Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
+ "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/job-task/list": {
+ },"/cost-analysis/budget/update": {
"post": {
- "tags": ["cost-analysis > job-task"],
- "summary": "List",
+ "tags": ["cost-analysis > budget"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nGets a list of all JobTasks. You can use a query to get a filtered list of JobTasks.",
+ "description": "### Description \nUpdates a specific Budget. You can make changes in the budgeted amount of the time period specified while creating the resource.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_task_id||string||\n |status|PENDING, IN_PROGRESS, SUCCESS, FAILURE, TIMEOUT, CANCELED |string||\n |workspace_id||string||\n |job_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n |name||string||\n |limit||float||\n |planned_limits||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_task_id" : {"type": "string","title": "JOB_TASK_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"job_id" : {"type": "string","title": "JOB_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" },"name" : {"type": "string","title": "NAME" },"limit" : {"type": "float","title": "LIMIT" },"planned_limits" : {"items": {"$ref": "#/components/schemas/PlannedLimit"}, "type": "array","title": "PLANNED_LIMITS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget-test\", \"limit\": 15000.0,\n \"planned_limits\": [{\"date\": \"2022-01\", \"limit\": 500.0},\n {\"date\": \"2022-02\", \"limit\": 500.0},\n {\"date\": \"2022-03\", \"limit\": 500.0},\n {\"date\": \"2022-04\", \"limit\": 500.0},\n {\"date\": \"2022-05\", \"limit\": 500.0},\n {\"date\": \"2022-06\", \"limit\": 500.0},\n {\"date\": \"2022-07\", \"limit\": 500.0},\n {\"date\": \"2022-08\", \"limit\": 500.0},\n {\"date\": \"2022-09\", \"limit\": 500.0}],\n \"end\": \"2022-12\",\n \"tags\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -1084,29 +1161,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobTasksInfo"},
+ "schema": {"$ref": "#/components/schemas/BudgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobTasksInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"job_task_id\": \"job-task-3622d860a776\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"platform\": \"gcp\",\n \"month\": \"202207\"\n },\n \"created_count\": 1,\n \"job_id\": \"job-85cf2c385252\",\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:08.266Z\",\n \"started_at\": \"2022-07-17T16:01:28.243Z\",\n \"updated_at\": \"2022-07-17T16:01:28.939Z\",\n \"finished_at\": \"2022-07-17T16:01:28.939Z\"\n },\n {\n \"job_task_id\": \"job-task-038c0b076ec5\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"account\": \"257706363616\",\n \"start\": \"2022-07-01\"\n },\n \"created_count\": 5756,\n \"job_id\": \"job-6b6765f757a9\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:05.099Z\",\n \"started_at\": \"2022-07-17T16:00:47.356Z\",\n \"updated_at\": \"2022-07-17T16:01:20.856Z\",\n \"finished_at\": \"2022-07-17T16:01:20.856Z\"\n }\n ],\n \"total_count\": 720\n}"
+ "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
+ "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/job-task/stat": {
+ },"/cost-analysis/budget/set-notification": {
"post": {
- "tags": ["cost-analysis > job-task"],
- "summary": "Stat",
+ "tags": ["cost-analysis > budget"],
+ "summary": "Set Notification",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nSets a notification on a specific Budget. Sets a threshold on the budget, and if the cost exceeds the threshold, a notification is raised.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n |notifications||array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" },"notifications" : {"items": {"$ref": "#/components/schemas/BudgetNotification"}, "type": "array","title": "NOTIFICATIONS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-4c8606da4521\",\n \"notifications\": [\n {\n \"threshold\": 20.0,\n \"unit\": \"PERCENT\",\n \"notification_type\": \"CRITICAL\"\n },\n {\n \"threshold\": 1000.0,\n \"unit\": \"ACTUAL_COST\",\n \"notification_type\": \"WARNING\"\n }\n ]\n}"},"Schema":{}
}
}
},"required": true
@@ -1115,56 +1192,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/BudgetInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
+ "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/create": {
+ },"/cost-analysis/budget/delete": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Create",
+ "tags": ["cost-analysis > budget"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeletes a specific Budget. You must specify the `budget_id` of the Budget to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |recipients||Struct|True|\n |issue_day||int||\n |is_last_day||boolean||\n |currency||string||\n |data_source_filter||Struct||\n |language|Default `en` |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"issue_day" : {"type": "integer","title": "ISSUE_DAY" },"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY" },"currency" : {"type": "string","title": "CURRENCY" },"recipients" : {"type": "object","title": "RECIPIENTS" },"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER" },"language" : {"type": "string","title": "LANGUAGE" } }
+ "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-d51b6b6a9910\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/update": {
+ },"/cost-analysis/budget/get": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Update",
+ "tags": ["cost-analysis > budget"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific Budget. Prints detailed information about the Budget, including `planned_limits` of the project group or project for the pre-defined period.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n |issue_day||int||\n |is_last_day||boolean||\n |currency||string||\n |data_source_filter||Struct||\n |language||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"issue_day" : {"type": "integer","title": "ISSUE_DAY" },"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY" },"currency" : {"type": "string","title": "CURRENCY" },"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER" },"language" : {"type": "string","title": "LANGUAGE" } }
+ "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-d51b6b6a9910\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1173,27 +1246,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/BudgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
+ "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/update-recipients": {
+ },"/cost-analysis/budget/list": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Update Recipients",
+ "tags": ["cost-analysis > budget"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of all Budgets. You can use a query to get a filtered list of Budgets.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id||string|True|\n |recipients||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |budget_id||string||\n |name||string||\n |time_unit|TOTAL, MONTHLY |string||\n |workspace_id||string||\n |project_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"recipients" : {"type": "object","title": "RECIPIENTS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"name" : {"type": "string","title": "NAME" },"time_unit" : {"type": "string","title": "TIME_UNIT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -1202,25 +1277,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/BudgetsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/BudgetsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"budget_id\": \"budget-409e33836ea2\",\n \"name\": \"Budget 2 - Monthly\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-12T06:09:56.917Z\",\n \"updated_at\": \"2022-04-12T06:09:56.917Z\"\n }\n ],\n \"total_count\": 6\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/enable": {
+ },"/cost-analysis/budget/stat": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Enable",
+ "tags": ["cost-analysis > budget"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -1231,27 +1308,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/disable": {
+ },"/cost-analysis/data-source-rule/create": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Disable",
+ "tags": ["cost-analysis > data-source-rule"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nCreates a new DataSourceRule. When creating the resource, this method can apply two types of conditions: mapping projects where the cost incurred to the Cost, and mapping cloud service accounts to the Cost. By adjusting the `condition_policy` parameter, the DataSourceRule can be applied when all conditions are met, applied when any of the conditions are met, or always applied regardless of whether the conditions are met.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |conditions_policy|ALL, ANY, ALWAYS |string|True|\n |actions||DataSourceRuleActions|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |workspace_id||string|True|\n |name||string||\n |conditions||array||\n |options||DataSourceRuleOptions||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\"source\": \"account\", \"target\": \"data.project_id\"}\n },\n \"options\": {\"stop_processing\": true},\n \"tags\": {\"b\": \"c\", \"a\": \"b\"}\n}"},"Schema":{}
}
}
},"required": true
@@ -1260,73 +1337,60 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
+ "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/delete": {
+ },"/cost-analysis/data-source-rule/update": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Delete",
+ "tags": ["cost-analysis > data-source-rule"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nUpdates a specific DataSourceRule. You can make changes in DataSourceRule settings, including filtering conditions. If the parameter `is_default` is `true`, only `Admin` type User can use this method.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n |name||string||\n |conditions||array||\n |conditions_policy|ALL, ANY, ALWAYS |string||\n |actions||DataSourceRuleActions||\n |options||DataSourceRuleOptions||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
+ "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\"b\": \"c\", \"a\": \"b\"}\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
+ "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ }}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/run": {
+ },"/cost-analysis/data-source-rule/change-order": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Run",
+ "tags": ["cost-analysis > data-source-rule"],
+ "summary": "Change Order",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nChanges the priority order of the DataSourceRules to apply. If there are multiple DataSourceRules applied in a specific service account, the priority order of the resources is requried. This method changes the priority order to apply DataSourceRules.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n |order||int|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
+ "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" },"order" : {"type": "integer","title": "ORDER" } }
},
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/get": {
- "post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Get",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_config_id|The ID of cost report in the Protocol.|string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
- },
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"order\": 2\n}"},"Schema":{}
}
}
},"required": true
@@ -1335,56 +1399,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
+ "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/list": {
+ },"/cost-analysis/data-source-rule/delete": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "List",
+ "tags": ["cost-analysis > data-source-rule"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeletes a specific DataSourceRule. You must specify the `data_source_rule_id` of the DataSourceRule to delete. If the parameter `is_default` is `true`, only `Admin` type User can use this method.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cost_report_config_id|The ID of cost report in the Protocol. |string||\n |state|ENABLED, DISABLED |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"state" : {"type": "string","title": "STATE" } }
+ "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-22fab02f6b51\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-config/stat": {
+ },"/cost-analysis/data-source-rule/get": {
"post": {
- "tags": ["cost-analysis > cost-report-config"],
- "summary": "Stat",
+ "tags": ["cost-analysis > data-source-rule"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific DataSourceRule. Prints detailed information about the DataSourceRule, including `conditions_policy` and conditions applied to DataSources.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_rule_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_rule_id\": \"rule-22fab02f6b51\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1393,27 +1453,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportConfigsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DataSourceRuleInfo"},"Default Example":{
+ "value": "{\n \"data_source_rule_id\": \"rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-data/list": {
+ },"/cost-analysis/data-source-rule/list": {
"post": {
- "tags": ["cost-analysis > cost-report-data"],
+ "tags": ["cost-analysis > data-source-rule"],
"summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of all DataSourceRules. You can use a query to get a filtered list of DataSourceRules.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cost_report_data_id||string||\n |product||string||\n |provider||string||\n |is_confirmed||boolean||\n |workspace_id||string||\n |cost_report_config_id||string||\n |cost_report_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |data_source_rule_id||string||\n |name||string||\n |rule_type|MANAGED, CUSTOM |string||\n |workspace_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cost_report_data_id" : {"type": "string","title": "COST_REPORT_DATA_ID" },"product" : {"type": "string","title": "PRODUCT" },"provider" : {"type": "string","title": "PROVIDER" },"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID" },"name" : {"type": "string","title": "NAME" },"rule_type" : {"type": "string","title": "RULE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -1422,25 +1484,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportsDataInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceRulesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportsDataInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DataSourceRulesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"data_source_rule_id\": \"rule-22fab02f6b51\",\n \"name\": \"match_service_account\",\n \"order\": 1,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {},\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-05-25T16:01:51.858Z\"\n },\n {\n \"data_source_rule_id\": \"rule-188d366e9817\",\n \"name\": \"match_service_account\",\n \"order\": 1,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.account_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {},\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-03T16:00:54.099Z\"\n }\n ],\n \"total_count\": 2\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-data/analyze": {
+ },"/cost-analysis/data-source-rule/stat": {
"post": {
- "tags": ["cost-analysis > cost-report-data"],
- "summary": "Analyze",
+ "tags": ["cost-analysis > data-source-rule"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery||\n |product||string||\n |provider||string||\n |is_confirmed||boolean||\n |workspace_id||string||\n |project_id||string||\n |cost_report_config_id||string||\n |cost_report_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"product" : {"type": "string","title": "PRODUCT" },"provider" : {"type": "string","title": "PROVIDER" },"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -1458,20 +1522,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report-data/stat": {
+ },"/cost-analysis/job/cancel": {
"post": {
- "tags": ["cost-analysis > cost-report-data"],
- "summary": "Stat",
+ "tags": ["cost-analysis > job"],
+ "summary": "Cancel",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nCancels a specific Job. You can manually cease a Job in run with this method.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |cost_report_id||string||\n |cost_report_config_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" } }
+ "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-07994c7c9021\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1480,27 +1544,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/JobInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
+ "value": "{\n \"job_id\": \"job-07994c7c9021\",\n \"status\": \"CANCELED\",\n \"options\": {\n \"no_preload_cache\": false,\n \"start\": \"2021-01-01T00:00:00Z\"\n },\n \"total_tasks\": 2,\n \"remained_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-02T09:17:44.031Z\",\n \"updated_at\": \"2022-04-02T09:19:47.715Z\",\n \"finished_at\": \"2022-04-02T09:19:47.715Z\",\n \"changed\": [\n {\n \"start\": \"2021-01-01T00:00:00.000Z\"\n }\n ]\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget/create": {
+ },"/cost-analysis/job/get": {
"post": {
- "tags": ["cost-analysis > budget"],
- "summary": "Create",
+ "tags": ["cost-analysis > job"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nCreates a new Budget. When creating a Budget, it should be set for a specific ProjectGroup or Project. The budgeted amount and date of the `planned_limits` should be specified on a monthly or yearly basis.",
+ "description": "### Description \nGets a specific Job. Prints detailed information about the Job, including the plugin used, operation time, and `status`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |time_unit|TOTAL, MONTHLY |string|True|\n |start||string|True|\n |end||string|True|\n |resource_group|WORKSPACE, PROJECT |string|True|\n |name||string||\n |limit||float||\n |planned_limits||array||\n |provider_filter||ProviderFilter||\n |notifications||array||\n |tags||Struct||\n |workspace_id||string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"limit" : {"type": "float","title": "LIMIT" },"planned_limits" : {"items": {"$ref": "#/components/schemas/PlannedLimit"}, "type": "array","title": "PLANNED_LIMITS" },"provider_filter" : {"$ref": "#/components/schemas/ProviderFilter","title": "PROVIDER_FILTER" },"time_unit" : {"type": "string","title": "TIME_UNIT" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"notifications" : {"items": {"$ref": "#/components/schemas/BudgetNotification"}, "type": "array","title": "NOTIFICATIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"Cloudforet-Budget\",\n \"planned_limits\": [{\"date\": \"2022-01\", \"limit\": 1000.0},\n {\"date\": \"2022-02\", \"limit\": 1100.0},\n {\"date\": \"2022-03\", \"limit\": 1200.0},\n {\"date\": \"2022-04\", \"limit\": 1300.0},\n {\"date\": \"2022-05\", \"limit\": 1400.0},\n {\"date\": \"2022-06\", \"limit\": 1500.0},\n {\"date\": \"2022-07\", \"limit\": 1600.0},\n {\"date\": \"2022-08\", \"limit\": 1700.0},\n {\"date\": \"2022-09\", \"limit\": 1800.0},\n {\"date\": \"2022-10\", \"limit\": 1900.0},\n {\"date\": \"2022-11\", \"limit\": 2000.0},\n {\"date\": \"2022-12\", \"limit\": 2100.0}],\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-07994c7c9021\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1509,29 +1575,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/BudgetInfo"},
+ "schema": {"$ref": "#/components/schemas/JobInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
- "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
+ "value": "{\n \"job_id\": \"job-07994c7c9021\",\n \"status\": \"CANCELED\",\n \"options\": {\n \"no_preload_cache\": false,\n \"start\": \"2021-01-01T00:00:00Z\"\n },\n \"total_tasks\": 2,\n \"remained_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-02T09:17:44.031Z\",\n \"updated_at\": \"2022-04-02T09:19:47.715Z\",\n \"finished_at\": \"2022-04-02T09:19:47.715Z\",\n \"changed\": [\n {\n \"start\": \"2021-01-01T00:00:00.000Z\"\n }\n ]\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget/update": {
+ },"/cost-analysis/job/list": {
"post": {
- "tags": ["cost-analysis > budget"],
- "summary": "Update",
+ "tags": ["cost-analysis > job"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nUpdates a specific Budget. You can make changes in the budgeted amount of the time period specified while creating the resource.",
+ "description": "### Description \nGets a list of all Jobs. You can use a query to get a filtered list of Jobs.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n |name||string||\n |limit||float||\n |planned_limits||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_id||string||\n |status|IN_PROGRESS, SUCCESS, FAILURE, TIMEOUT, CANCELED |string||\n |workspace_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" },"name" : {"type": "string","title": "NAME" },"limit" : {"type": "float","title": "LIMIT" },"planned_limits" : {"items": {"$ref": "#/components/schemas/PlannedLimit"}, "type": "array","title": "PLANNED_LIMITS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_id" : {"type": "string","title": "JOB_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget-test\", \"limit\": 15000.0,\n \"planned_limits\": [{\"date\": \"2022-01\", \"limit\": 500.0},\n {\"date\": \"2022-02\", \"limit\": 500.0},\n {\"date\": \"2022-03\", \"limit\": 500.0},\n {\"date\": \"2022-04\", \"limit\": 500.0},\n {\"date\": \"2022-05\", \"limit\": 500.0},\n {\"date\": \"2022-06\", \"limit\": 500.0},\n {\"date\": \"2022-07\", \"limit\": 500.0},\n {\"date\": \"2022-08\", \"limit\": 500.0},\n {\"date\": \"2022-09\", \"limit\": 500.0}],\n \"end\": \"2022-12\",\n \"tags\": {}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -1540,29 +1606,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/BudgetInfo"},
+ "schema": {"$ref": "#/components/schemas/JobsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
- "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/JobsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"job_id\": \"job-85cf2c385252\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"start\": null,\n \"no_preload_cache\": false\n },\n \"total_tasks\": 1,\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:08.254Z\",\n \"updated_at\": \"2022-07-17T16:01:30.637Z\",\n \"finished_at\": \"2022-07-17T16:01:30.637Z\",\n \"changed\": [\n {\n \"start\": \"2022-07-01T00:00:00.000Z\"\n }\n ]\n },\n {\n \"job_id\": \"job-6b6765f757a9\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"start\": null,\n \"no_preload_cache\": false\n },\n \"total_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:05.077Z\",\n \"updated_at\": \"2022-07-17T16:01:28.206Z\",\n \"finished_at\": \"2022-07-17T16:01:28.206Z\",\n \"changed\": [\n {\n \"start\": \"2022-07-01T00:00:00.000Z\"\n }\n ]\n }\n ],\n \"total_count\": 372\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget/set-notification": {
+ },"/cost-analysis/job/stat": {
"post": {
- "tags": ["cost-analysis > budget"],
- "summary": "Set Notification",
+ "tags": ["cost-analysis > job"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nSets a notification on a specific Budget. Sets a threshold on the budget, and if the cost exceeds the threshold, a notification is raised.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n |notifications||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" },"notifications" : {"items": {"$ref": "#/components/schemas/BudgetNotification"}, "type": "array","title": "NOTIFICATIONS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-4c8606da4521\",\n \"notifications\": [\n {\n \"threshold\": 20.0,\n \"unit\": \"PERCENT\",\n \"notification_type\": \"CRITICAL\"\n },\n {\n \"threshold\": 1000.0,\n \"unit\": \"ACTUAL_COST\",\n \"notification_type\": \"WARNING\"\n }\n ]\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1571,52 +1637,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/BudgetInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
- "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget/delete": {
- "post": {
- "tags": ["cost-analysis > budget"],
- "summary": "Delete",
- "operationId" : "",
- "description": "### Description \nDeletes a specific Budget. You must specify the `budget_id` of the Budget to delete.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" } }
- },
- "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-d51b6b6a9910\"\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget/get": {
+ },"/cost-analysis/job-task/get": {
"post": {
- "tags": ["cost-analysis > budget"],
+ "tags": ["cost-analysis > job-task"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a specific Budget. Prints detailed information about the Budget, including `planned_limits` of the project group or project for the pre-defined period.",
+ "description": "### Description \nGets a specific JobTask. Prints detailed information about the JobTask, including the relevant resources: DataSource and Job. The criteria used for dividing a Job into JobTasks can be found in the DataSource used, but the total count of divided JobTasks can be found by this method.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |budget_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_task_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"budget_id" : {"type": "string","title": "BUDGET_ID" } }
+ "properties": {"job_task_id" : {"type": "string","title": "JOB_TASK_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"budget_id\": \"budget-d51b6b6a9910\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_task_id\": \"job-task-3622d860a776\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1625,27 +1666,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/BudgetInfo"},
+ "schema": {"$ref": "#/components/schemas/JobTaskInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/BudgetInfo"},"Default Example":{
- "value": "{\n \"budget_id\": \"budget-d51b6b6a9910\",\n \"name\": \"Cloudforet-Budget\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-18T09:30:56.901Z\",\n \"updated_at\": \"2022-07-18T09:30:56.901Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/JobTaskInfo"},"Default Example":{
+ "value": "{\n \"job_task_id\": \"job-task-3622d860a776\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"month\": \"202207\",\n \"platform\": \"gcp\"\n },\n \"created_count\": 1,\n \"job_id\": \"job-85cf2c385252\",\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:08.266Z\",\n \"started_at\": \"2022-07-17T16:01:28.243Z\",\n \"updated_at\": \"2022-07-17T16:01:28.939Z\",\n \"finished_at\": \"2022-07-17T16:01:28.939Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget/list": {
+ },"/cost-analysis/job-task/list": {
"post": {
- "tags": ["cost-analysis > budget"],
+ "tags": ["cost-analysis > job-task"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Budgets. You can use a query to get a filtered list of Budgets.",
+ "description": "### Description \nGets a list of all JobTasks. You can use a query to get a filtered list of JobTasks.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |budget_id||string||\n |name||string||\n |time_unit|TOTAL, MONTHLY |string||\n |workspace_id||string||\n |project_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_task_id||string||\n |status|PENDING, IN_PROGRESS, SUCCESS, FAILURE, TIMEOUT, CANCELED |string||\n |workspace_id||string||\n |job_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"name" : {"type": "string","title": "NAME" },"time_unit" : {"type": "string","title": "TIME_UNIT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_task_id" : {"type": "string","title": "JOB_TASK_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"job_id" : {"type": "string","title": "JOB_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
"examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
@@ -1656,18 +1697,18 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/BudgetsInfo"},
+ "schema": {"$ref": "#/components/schemas/JobTasksInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/BudgetsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"budget_id\": \"budget-409e33836ea2\",\n \"name\": \"Budget 2 - Monthly\",\n \"limit\": 18600.0,\n \"planned_limits\": [\n {\n \"date\": \"2022-01\",\n \"limit\": 1000.0\n },\n {\n \"date\": \"2022-02\",\n \"limit\": 1100.0\n },\n {\n \"date\": \"2022-03\",\n \"limit\": 1200.0\n },\n {\n \"date\": \"2022-04\",\n \"limit\": 1300.0\n },\n {\n \"date\": \"2022-05\",\n \"limit\": 1400.0\n },\n {\n \"date\": \"2022-06\",\n \"limit\": 1500.0\n },\n {\n \"date\": \"2022-07\",\n \"limit\": 1600.0\n },\n {\n \"date\": \"2022-08\",\n \"limit\": 1700.0\n },\n {\n \"date\": \"2022-09\",\n \"limit\": 1800.0\n },\n {\n \"date\": \"2022-10\",\n \"limit\": 1900.0\n },\n {\n \"date\": \"2022-11\",\n \"limit\": 2000.0\n },\n {\n \"date\": \"2022-12\",\n \"limit\": 2100.0\n }\n ],\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"time_unit\": \"MONTHLY\",\n \"start\": \"2022-01\",\n \"end\": \"2022-12\",\n \"tags\": {},\n \"project_group_id\": \"pg-812c90990877\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-12T06:09:56.917Z\",\n \"updated_at\": \"2022-04-12T06:09:56.917Z\"\n }\n ],\n \"total_count\": 6\n}"
+ "Schema": {"$ref": "#/components/schemas/JobTasksInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"job_task_id\": \"job-task-3622d860a776\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"platform\": \"gcp\",\n \"month\": \"202207\"\n },\n \"created_count\": 1,\n \"job_id\": \"job-85cf2c385252\",\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:08.266Z\",\n \"started_at\": \"2022-07-17T16:01:28.243Z\",\n \"updated_at\": \"2022-07-17T16:01:28.939Z\",\n \"finished_at\": \"2022-07-17T16:01:28.939Z\"\n },\n {\n \"job_task_id\": \"job-task-038c0b076ec5\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"account\": \"257706363616\",\n \"start\": \"2022-07-01\"\n },\n \"created_count\": 5756,\n \"job_id\": \"job-6b6765f757a9\",\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:05.099Z\",\n \"started_at\": \"2022-07-17T16:00:47.356Z\",\n \"updated_at\": \"2022-07-17T16:01:20.856Z\",\n \"finished_at\": \"2022-07-17T16:01:20.856Z\"\n }\n ],\n \"total_count\": 720\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/budget/stat": {
+ },"/cost-analysis/job-task/stat": {
"post": {
- "tags": ["cost-analysis > budget"],
+ "tags": ["cost-analysis > job-task"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -1694,20 +1735,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-query-set/create": {
+ },"/cost-analysis/data-source-account/update": {
"post": {
- "tags": ["cost-analysis > cost-query-set"],
- "summary": "Create",
+ "tags": ["cost-analysis > data-source-account"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nCreates a new CostQuerySet. You can make your own custom query that meets your needs, and input it as an `option` parameter of the resource. Queries such as `group_by` and `granularity` are provided by default.",
+ "description": "### Description \nUpdate a DataSourceAccount with the specified DataSourceAccount ID related to the DataSource.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |name||string|True|\n |options||Struct|True|\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |account_id|account_id is the unique identifier of each CSP account.(e.g. Azure Tenant ID)|string|True|\n |workspace_id||string||\n |project_id||string||\n |service_account_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-085d1e872789\",\n \"name\": \"project_provider_region\",\n \"options\": {}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1716,60 +1757,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},"Default Example":{
- "value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"
- }}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-query-set/update": {
- "post": {
- "tags": ["cost-analysis > cost-query-set"],
- "summary": "Update",
- "operationId" : "",
- "description": "### Description \nUpdates a specific CostQuerySet. You can make changes in the details of queries.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_query_set_id||string|True|\n |name||string||\n |options||Struct||\n |tags||Struct||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
- },
- "examples":{"Default Example":{"value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},"Default Example":{
- "value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-query-set/delete": {
+ },"/cost-analysis/data-source-account/reset": {
"post": {
- "tags": ["cost-analysis > cost-query-set"],
- "summary": "Delete",
+ "tags": ["cost-analysis > data-source-account"],
+ "summary": "Reset",
"operationId" : "",
- "description": "### Description \nDeletes a specific CostQuerySet. You must specify the `cost_query_set_id` of the CostQuerySet to delete.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |account_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cost_query_set_id\": \"query-16ae671dc8fb\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1779,20 +1787,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-query-set/get": {
+ },"/cost-analysis/data-source-account/get": {
"post": {
- "tags": ["cost-analysis > cost-query-set"],
+ "tags": ["cost-analysis > data-source-account"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a specific CostQuerySet. Prints detailed information about the CostQuerySet, including the details of queries.",
+ "description": "### Description \nGet a DataSourceAccount with the specified DataSourceAccount ID related to the DataSource.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_account_id||string|True|\n |account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID" } }
+ "properties": {"data_source_account_id" : {"type": "string","title": "DATA_SOURCE_ACCOUNT_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cost_query_set_id\": \"query-16ae671dc8fb\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1801,29 +1809,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostQuerySetInfo"},"Default Example":{
- "value": "{\n \"cost_query_set_id\": \"query-76a58ea5d02c\",\n \"name\": \"project_provider_region\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"test@cloudforet.io\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T06:11:03.701Z\",\n \"updated_at\": \"2022-07-19T06:11:03.701Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DataSourceAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-query-set/list": {
+ },"/cost-analysis/data-source-account/list": {
"post": {
- "tags": ["cost-analysis > cost-query-set"],
+ "tags": ["cost-analysis > data-source-account"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all CostQuerySets. You can use a query to get a filtered list of CostQuerySets.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |query||Query||\n |name||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |data_source_id||string||\n |account_id||string||\n |workspace_id||string||\n |project_id||string||\n |service_account_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1832,27 +1838,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostQuerySetsInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceAccountsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostQuerySetsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"cost_query_set_id\": \"query-16ae671dc8fb\",\n \"name\": \"3 month product pie chart\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"yuda@mz.co.kr\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-03-08T03:37:31.404Z\",\n \"updated_at\": \"2022-03-08T03:37:31.404Z\"\n },\n {\n \"cost_query_set_id\": \"query-d90addf25e4b\",\n \"name\": \"6 month project group\",\n \"options\": {},\n \"tags\": {},\n \"user_id\": \"yuda@mz.co.kr\",\n \"data_source_id\": \"ds-085d1e872789\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-03-14T09:29:54.306Z\",\n \"updated_at\": \"2022-03-14T09:29:54.306Z\"\n }\n ],\n \"total_count\": 34\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DataSourceAccountsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-query-set/stat": {
+ },"/cost-analysis/data-source-account/analyze": {
"post": {
- "tags": ["cost-analysis > cost-query-set"],
- "summary": "Stat",
+ "tags": ["cost-analysis > data-source-account"],
+ "summary": "Analyze",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |data_source_id||string|True|\n |account_id||string|True|\n |workspace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"account_id" : {"type": "string","title": "ACCOUNT_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1870,18 +1874,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report/send": {
+ },"/cost-analysis/data-source-account/stat": {
"post": {
- "tags": ["cost-analysis > cost-report"],
- "summary": "Send",
+ "tags": ["cost-analysis > data-source-account"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_id|The ID of cost report in the Protocol.|string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -1890,23 +1894,29 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report/get-url": {
+ },"/cost-analysis/budget-usage/list": {
"post": {
- "tags": ["cost-analysis > cost-report"],
- "summary": "Get Url",
+ "tags": ["cost-analysis > budget-usage"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of all BudgetUsages. You can use a query to get a filtered list of BudgetUsages.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_id|The ID of cost report in the Protocol|string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |name||string||\n |date||string||\n |workspace_id||string||\n |project_id||string||\n |budget_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"name" : {"type": "string","title": "NAME" },"date" : {"type": "string","title": "DATE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -1915,25 +1925,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/BudgetUsagesInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/BudgetUsagesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"budget_id\": \"budget-abb377eb9e8b\",\n \"name\": \"Cloudforet-Budget3\",\n \"date\": \"2022-01\",\n \"cost\": 7671.164,\n \"limit\": 10000.0,\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"ENABLED\",\n \"providers\": [\n \"aws\",\n \"google_cloud\"\n ]\n },\n \"project_id\": \"project-1b2b3b4b5b6b\",\n \"data_source_id\": \"data-source-1b2b3b4b5b6b\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"updated_at\": \"2022-07-19T04:26:08.099Z\"\n },\n {\n \"budget_id\": \"budget-abb377eb9e8b\",\n \"name\": \"Cloudforet-Budget3\",\n \"date\": \"2022-02\",\n \"cost\": 5931.771,\n \"limit\": 11000.0,\n \"currency\": \"USD\",\n \"provider_filter\": {\n \"state\": \"DISABLED\",\n \"providers\": []\n },\n \"project_id\": \"project-1b2b3b4b5b6b\",\n \"data_source_id\": \"data-source-1b2b3b4b5b6b\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"updated_at\": \"2022-07-19T04:26:08.105Z\"\n }\n ],\n \"total_count\": 12\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report/get": {
+ },"/cost-analysis/budget-usage/analyze": {
"post": {
- "tags": ["cost-analysis > cost-report"],
- "summary": "Get",
+ "tags": ["cost-analysis > budget-usage"],
+ "summary": "Analyze",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_id|The ID of cost report in the Protocol.|string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |budget_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1944,25 +1956,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report/list": {
+ },"/cost-analysis/budget-usage/stat": {
"post": {
- "tags": ["cost-analysis > cost-report"],
- "summary": "List",
+ "tags": ["cost-analysis > budget-usage"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cost_report_id||string||\n |cost_report_config_id||string||\n |status|IN_PROGRESS, SUCCESS |string||\n |issue_date|YYYY-mm 2023-12 |string||\n |workspace_name||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |budget_id||string||\n |data_source_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"status" : {"type": "string","title": "STATUS" },"issue_date" : {"type": "string","title": "ISSUE_DATE" },"workspace_name" : {"type": "string","title": "WORKSPACE_NAME" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"budget_id" : {"type": "string","title": "BUDGET_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1973,25 +1985,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CostReportsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CostReportsInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/cost-report/stat": {
+ },"/cost-analysis/cost-report/send": {
"post": {
"tags": ["cost-analysis > cost-report"],
- "summary": "Stat",
+ "summary": "Send",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |cost_report_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_id|The ID of cost report in the Protocol.|string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
+ "properties": {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
},
"examples":{"Schema":{}
}
@@ -2000,29 +2012,23 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/job/cancel": {
+ },"/cost-analysis/cost-report/get-url": {
"post": {
- "tags": ["cost-analysis > job"],
- "summary": "Cancel",
+ "tags": ["cost-analysis > cost-report"],
+ "summary": "Get Url",
"operationId" : "",
- "description": "### Description \nCancels a specific Job. You can manually cease a Job in run with this method.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_id|The ID of cost report in the Protocol|string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
+ "properties": {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-07994c7c9021\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2031,29 +2037,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
- "value": "{\n \"job_id\": \"job-07994c7c9021\",\n \"status\": \"CANCELED\",\n \"options\": {\n \"no_preload_cache\": false,\n \"start\": \"2021-01-01T00:00:00Z\"\n },\n \"total_tasks\": 2,\n \"remained_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-02T09:17:44.031Z\",\n \"updated_at\": \"2022-04-02T09:19:47.715Z\",\n \"finished_at\": \"2022-04-02T09:19:47.715Z\",\n \"changed\": [\n {\n \"start\": \"2021-01-01T00:00:00.000Z\"\n }\n ]\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/job/get": {
+ },"/cost-analysis/cost-report/get": {
"post": {
- "tags": ["cost-analysis > job"],
+ "tags": ["cost-analysis > cost-report"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a specific Job. Prints detailed information about the Job, including the plugin used, operation time, and `status`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cost_report_id|The ID of cost report in the Protocol.|string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
+ "properties": {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-07994c7c9021\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2062,29 +2066,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
- "value": "{\n \"job_id\": \"job-07994c7c9021\",\n \"status\": \"CANCELED\",\n \"options\": {\n \"no_preload_cache\": false,\n \"start\": \"2021-01-01T00:00:00Z\"\n },\n \"total_tasks\": 2,\n \"remained_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-04-02T09:17:44.031Z\",\n \"updated_at\": \"2022-04-02T09:19:47.715Z\",\n \"finished_at\": \"2022-04-02T09:19:47.715Z\",\n \"changed\": [\n {\n \"start\": \"2021-01-01T00:00:00.000Z\"\n }\n ]\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CostReportInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/job/list": {
+ },"/cost-analysis/cost-report/list": {
"post": {
- "tags": ["cost-analysis > job"],
+ "tags": ["cost-analysis > cost-report"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Jobs. You can use a query to get a filtered list of Jobs.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_id||string||\n |status|IN_PROGRESS, SUCCESS, FAILURE, TIMEOUT, CANCELED |string||\n |workspace_id||string||\n |data_source_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cost_report_id||string||\n |cost_report_config_id||string||\n |status|IN_PROGRESS, SUCCESS |string||\n |issue_date|YYYY-mm 2023-12 |string||\n |workspace_name||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_id" : {"type": "string","title": "JOB_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" },"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID" },"status" : {"type": "string","title": "STATUS" },"issue_date" : {"type": "string","title": "ISSUE_DATE" },"workspace_name" : {"type": "string","title": "WORKSPACE_NAME" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2093,27 +2095,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobsInfo"},
+ "schema": {"$ref": "#/components/schemas/CostReportsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"job_id\": \"job-85cf2c385252\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"start\": null,\n \"no_preload_cache\": false\n },\n \"total_tasks\": 1,\n \"data_source_id\": \"ds-c96609f5afeb\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:08.254Z\",\n \"updated_at\": \"2022-07-17T16:01:30.637Z\",\n \"finished_at\": \"2022-07-17T16:01:30.637Z\",\n \"changed\": [\n {\n \"start\": \"2022-07-01T00:00:00.000Z\"\n }\n ]\n },\n {\n \"job_id\": \"job-6b6765f757a9\",\n \"status\": \"SUCCESS\",\n \"options\": {\n \"start\": null,\n \"no_preload_cache\": false\n },\n \"total_tasks\": 2,\n \"data_source_id\": \"ds-fcba92ca73b1\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-17T16:00:05.077Z\",\n \"updated_at\": \"2022-07-17T16:01:28.206Z\",\n \"finished_at\": \"2022-07-17T16:01:28.206Z\",\n \"changed\": [\n {\n \"start\": \"2022-07-01T00:00:00.000Z\"\n }\n ]\n }\n ],\n \"total_count\": 372\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CostReportsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/cost-analysis/job/stat": {
+ },"/cost-analysis/cost-report/stat": {
"post": {
- "tags": ["cost-analysis > job"],
+ "tags": ["cost-analysis > cost-report"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |cost_report_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"cost_report_id" : {"type": "string","title": "COST_REPORT_ID" } }
},
"examples":{"Schema":{}
}
@@ -2135,92 +2135,54 @@
},
"components":{
"schemas": {
- "DataSourceAccountAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
- "type": "object",
- "required": ["query","data_source_id","account_id","workspace_id"],
- "title": "DataSourceAccountAnalyzeQuery"
- }
- , "DataSourceAccountInfo": {
- "properties" : {"account_id" : {"type": "string","title": "ACCOUNT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"is_sync" : {"type": "boolean","title": "IS_SYNC"},"is_linked" : {"type": "boolean","title": "IS_LINKED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"v_workspace_id" : {"type": "string","title": "V_WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"}},
+ "CostReportConfigInfo": {
+ "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"state" : {"type": "string","title": "STATE"},"issue_day" : {"type": "integer","title": "ISSUE_DAY"},"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY"},"currency" : {"type": "string","title": "CURRENCY"},"recipients" : {"type": "object","title": "RECIPIENTS"},"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER"},"language" : {"type": "string","title": "LANGUAGE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["account_id","data_source_id","name","is_sync","is_linked","domain_id","workspace_id","v_workspace_id","created_at","updated_at","last_synced_at"],
- "title": "DataSourceAccountInfo"
+ "required": ["cost_report_config_id","state","issue_day","is_last_day","currency","recipients","data_source_filter","language","domain_id","created_at","updated_at"],
+ "title": "CostReportConfigInfo"
}
- , "DataSourceAccountQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
+ , "CostReportConfigQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"state" : {"type": "string","title": "STATE"}},
"type": "object",
"required": [],
- "title": "DataSourceAccountQuery"
+ "title": "CostReportConfigQuery"
}
- , "DataSourceAccountRequest": {
- "properties" : {"data_source_account_id" : {"type": "string","title": "DATA_SOURCE_ACCOUNT_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"}},
+ , "CostReportConfigRequest": {
+ "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"}},
"type": "object",
- "required": ["data_source_account_id","account_id"],
- "title": "DataSourceAccountRequest"
+ "required": ["cost_report_config_id"],
+ "title": "CostReportConfigRequest"
}
- , "DataSourceAccountStatQuery": {
+ , "CostReportConfigStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "DataSourceAccountStatQuery"
+ "title": "CostReportConfigStatQuery"
}
- , "DataSourceAccountsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DataSourceAccountInfo"},
- "type": "array","$ref": "#/components/schemas/DataSourceAccountInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "CostReportConfigsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostReportConfigInfo"},
+ "type": "array","$ref": "#/components/schemas/CostReportConfigInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "DataSourceAccountsInfo"
- }
- , "ResetDataSourceAccountRequest": {
- "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"}},
- "type": "object",
- "required": ["data_source_id"],
- "title": "ResetDataSourceAccountRequest"
- }
- , "UpdateDataSourceAccountRequest": {
- "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
- "type": "object",
- "required": ["data_source_id","account_id"],
- "title": "UpdateDataSourceAccountRequest"
- }
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
+ "title": "CostReportConfigsInfo"
}
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
+ , "CreateCostReportConfigRequest": {
+ "properties" : {"issue_day" : {"type": "integer","title": "ISSUE_DAY"},"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY"},"currency" : {"type": "string","title": "CURRENCY"},"recipients" : {"type": "object","title": "RECIPIENTS"},"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER"},"language" : {"type": "string","title": "LANGUAGE"}},
"type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
+ "required": ["recipients"],
+ "title": "CreateCostReportConfigRequest"
}
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ , "UpdateCostReportConfigRecipientsRequest": {
+ "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"recipients" : {"type": "object","title": "RECIPIENTS"}},
"type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
+ "required": ["cost_report_config_id"],
+ "title": "UpdateCostReportConfigRecipientsRequest"
}
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ , "UpdateCostReportConfigRequest": {
+ "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"issue_day" : {"type": "integer","title": "ISSUE_DAY"},"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY"},"currency" : {"type": "string","title": "CURRENCY"},"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER"},"language" : {"type": "string","title": "LANGUAGE"}},
"type": "object",
- "required": ["version"],
- "title": "VersionInfo"
+ "required": ["cost_report_config_id"],
+ "title": "UpdateCostReportConfigRequest"
}
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
@@ -2391,6 +2353,87 @@
"required": ["path","filter"],
"title": "Unwind"
}
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
+ }
+ , "CostQuerySetInfo": {
+ "properties" : {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"user_id" : {"type": "string","title": "USER_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["cost_query_set_id","name","options","tags","domain_id","workspace_id","user_id","data_source_id","created_at","updated_at"],
+ "title": "CostQuerySetInfo"
+ }
+ , "CostQuerySetQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"}},
+ "type": "object",
+ "required": ["data_source_id"],
+ "title": "CostQuerySetQuery"
+ }
+ , "CostQuerySetRequest": {
+ "properties" : {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID"}},
+ "type": "object",
+ "required": ["cost_query_set_id"],
+ "title": "CostQuerySetRequest"
+ }
+ , "CostQuerySetStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
+ "type": "object",
+ "required": ["query","data_source_id"],
+ "title": "CostQuerySetStatQuery"
+ }
+ , "CostQuerySetsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostQuerySetInfo"},
+ "type": "array","$ref": "#/components/schemas/CostQuerySetInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "CostQuerySetsInfo"
+ }
+ , "CreateCostQuerySetRequest": {
+ "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["data_source_id","name","options"],
+ "title": "CreateCostQuerySetRequest"
+ }
+ , "UpdateCostQuerySetRequest": {
+ "properties" : {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["cost_query_set_id"],
+ "title": "UpdateCostQuerySetRequest"
+ }
, "DataSourceInfo": {
"properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"data_source_type" : {"type": "string","title": "DATA_SOURCE_TYPE"},"permissions" : {"type": "object","title": "PERMISSIONS"},"provider" : {"type": "string","title": "PROVIDER"},"secret_type" : {"type": "string","title": "SECRET_TYPE"},"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"template" : {"type": "object","title": "TEMPLATE"},"tags" : {"type": "object","title": "TAGS"},"cost_tag_keys" : {"items": {"type": "string"},
"type": "array","title": "COST_TAG_KEYS"},"cost_additional_info_keys" : {"items": {"type": "string"},
@@ -2482,273 +2525,79 @@
"required": ["data_source_id","secret_schema_id","secret_data"],
"title": "UpdateSecretDataSourceRequest"
}
- , "ChangeDataSourceRuleOrderRequest": {
- "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"order" : {"type": "integer","title": "ORDER"}},
+ , "CostReportDataAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"product" : {"type": "string","title": "PRODUCT"},"provider" : {"type": "string","title": "PROVIDER"},"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
"type": "object",
- "required": ["data_source_rule_id","order"],
- "title": "ChangeDataSourceRuleOrderRequest"
+ "required": [],
+ "title": "CostReportDataAnalyzeQuery"
}
- , "CreateDataSourceRuleRequest": {
- "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"},
- "type": "array","$ref": "#/components/schemas/DataSourceRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "CostReportDataInfo": {
+ "properties" : {"cost_report_data_id" : {"type": "string","title": "COST_REPORT_DATA_ID"},"cost" : {"type": "object","title": "COST"},"cost_report_name" : {"type": "string","title": "COST_REPORT_NAME"},"issue_date" : {"type": "string","title": "ISSUE_DATE"},"report_year" : {"type": "string","title": "REPORT_YEAR"},"report_month" : {"type": "string","title": "REPORT_MONTH"},"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED"},"provider" : {"type": "string","title": "PROVIDER"},"product" : {"type": "string","title": "PRODUCT"},"service_account_name" : {"type": "string","title": "SERVICE_ACCOUNT_NAME"},"data_source_name" : {"type": "string","title": "DATA_SOURCE_NAME"},"project_name" : {"type": "string","title": "PROJECT_NAME"},"workspace_name" : {"type": "string","title": "WORKSPACE_NAME"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["data_source_id","conditions_policy","actions","resource_group","workspace_id"],
- "title": "CreateDataSourceRuleRequest"
+ "required": ["cost_report_data_id","cost","cost_report_name","issue_date","report_year","report_month","is_confirmed","provider","product","service_account_name","data_source_name","project_name","workspace_name","domain_id","workspace_id","project_id","cost_report_config_id","cost_report_id","data_source_id","service_account_id","created_at"],
+ "title": "CostReportDataInfo"
}
- , "DataSourceRuleActions": {
- "properties" : {"change_project" : {"type": "string","title": "CHANGE_PROJECT"},"match_project" : {"$ref": "#/components/schemas/MatchRule","title": "MATCH_PROJECT"},"match_service_account" : {"$ref": "#/components/schemas/MatchRule","title": "MATCH_SERVICE_ACCOUNT"},"add_additional_info" : {"type": "object","title": "ADD_ADDITIONAL_INFO"}},
+ , "CostReportDataQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cost_report_data_id" : {"type": "string","title": "COST_REPORT_DATA_ID"},"product" : {"type": "string","title": "PRODUCT"},"provider" : {"type": "string","title": "PROVIDER"},"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
"type": "object",
- "required": ["change_project","match_project","match_service_account","add_additional_info"],
- "title": "DataSourceRuleActions"
+ "required": [],
+ "title": "CostReportDataQuery"
}
- , "DataSourceRuleCondition": {
- "properties" : {"key" : {"type": "string","title": "KEY"},"value" : {"type": "string","title": "VALUE"},"operator" : {"type": "string","title": "OPERATOR"}},
+ , "CostReportDataStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"}},
"type": "object",
- "required": ["key","value","operator"],
- "title": "DataSourceRuleCondition"
+ "required": ["query"],
+ "title": "CostReportDataStatQuery"
}
- , "DataSourceRuleInfo": {
- "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"name" : {"type": "string","title": "NAME"},"rule_type" : {"type": "string","title": "RULE_TYPE"},"order" : {"type": "integer","title": "ORDER"},"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"},
- "type": "array","$ref": "#/components/schemas/DataSourceRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "CostReportsDataInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostReportDataInfo"},
+ "type": "array","$ref": "#/components/schemas/CostReportDataInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["data_source_rule_id","name","rule_type","order","conditions","conditions_policy","actions","options","tags","resource_group","domain_id","workspace_id","data_source_id","created_at"],
- "title": "DataSourceRuleInfo"
+ "required": ["results","total_count"],
+ "title": "CostReportsDataInfo"
}
- , "DataSourceRuleOptions": {
- "properties" : {"stop_processing" : {"type": "boolean","title": "STOP_PROCESSING"}},
+ , "CostAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
"type": "object",
- "required": ["stop_processing"],
- "title": "DataSourceRuleOptions"
+ "required": ["query","data_source_id"],
+ "title": "CostAnalyzeQuery"
}
- , "DataSourceRuleQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"name" : {"type": "string","title": "NAME"},"rule_type" : {"type": "string","title": "RULE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
+ , "CostInfo": {
+ "properties" : {"cost_id" : {"type": "string","title": "COST_ID"},"cost" : {"type": "float","title": "COST"},"usage_quantity" : {"type": "float","title": "USAGE_QUANTITY"},"usage_unit" : {"type": "string","title": "USAGE_UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"region_key" : {"type": "string","title": "REGION_KEY"},"product" : {"type": "string","title": "PRODUCT"},"usage_type" : {"type": "string","title": "USAGE_TYPE"},"resource" : {"type": "string","title": "RESOURCE"},"tags" : {"type": "object","title": "TAGS"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"data" : {"type": "object","title": "DATA"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"billed_year" : {"type": "string","title": "BILLED_YEAR"},"billed_month" : {"type": "string","title": "BILLED_MONTH"},"billed_date" : {"type": "string","title": "BILLED_DATE"}},
"type": "object",
- "required": [],
- "title": "DataSourceRuleQuery"
+ "required": ["cost_id","cost","usage_quantity","usage_unit","provider","region_code","region_key","product","usage_type","resource","tags","additional_info","data","domain_id","workspace_id","project_id","service_account_id","data_source_id","account_id","billed_year","billed_month","billed_date"],
+ "title": "CostInfo"
}
- , "DataSourceRuleRequest": {
- "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"}},
+ , "CostQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"cost_id" : {"type": "string","title": "COST_ID"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"region_key" : {"type": "string","title": "REGION_KEY"},"product" : {"type": "string","title": "PRODUCT"},"usage_type" : {"type": "string","title": "USAGE_TYPE"},"resource" : {"type": "string","title": "RESOURCE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"billed_year" : {"type": "string","title": "BILLED_YEAR"},"billed_month" : {"type": "string","title": "BILLED_MONTH"},"billed_date" : {"type": "string","title": "BILLED_DATE"}},
"type": "object",
- "required": ["data_source_rule_id"],
- "title": "DataSourceRuleRequest"
+ "required": ["data_source_id"],
+ "title": "CostQuery"
}
- , "DataSourceRuleStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "CostRequest": {
+ "properties" : {"cost_id" : {"type": "string","title": "COST_ID"}},
+ "type": "object",
+ "required": ["cost_id"],
+ "title": "CostRequest"
+ }
+ , "CostStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
"type": "object",
"required": ["query"],
- "title": "DataSourceRuleStatQuery"
+ "title": "CostStatQuery"
}
- , "DataSourceRulesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
- "type": "array","$ref": "#/components/schemas/DataSourceRuleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "CostsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostInfo"},
+ "type": "array","$ref": "#/components/schemas/CostInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "DataSourceRulesInfo"
+ "title": "CostsInfo"
}
- , "MatchRule": {
- "properties" : {"source" : {"type": "string","title": "SOURCE"},"target" : {"type": "string","title": "TARGET"},"all_workspaces" : {"type": "boolean","title": "ALL_WORKSPACES"}},
+ , "CreateCostRequest": {
+ "properties" : {"cost" : {"type": "float","title": "COST"},"usage_quantity" : {"type": "float","title": "USAGE_QUANTITY"},"usage_unit" : {"type": "float","title": "USAGE_UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"product" : {"type": "string","title": "PRODUCT"},"usage_type" : {"type": "string","title": "USAGE_TYPE"},"resource" : {"type": "string","title": "RESOURCE"},"tags" : {"type": "object","title": "TAGS"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"billed_date" : {"type": "string","title": "BILLED_DATE"}},
"type": "object",
- "required": ["source","target","all_workspaces"],
- "title": "MatchRule"
- }
- , "UpdateDataSourceRuleRequest": {
- "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"},
- "type": "array","$ref": "#/components/schemas/DataSourceRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["data_source_rule_id"],
- "title": "UpdateDataSourceRuleRequest"
- }
- , "BudgetUsageAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"budget_id" : {"type": "string","title": "BUDGET_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": ["query"],
- "title": "BudgetUsageAnalyzeQuery"
- }
- , "BudgetUsageInfo": {
- "properties" : {"budget_id" : {"type": "string","title": "BUDGET_ID"},"name" : {"type": "string","title": "NAME"},"date" : {"type": "string","title": "DATE"},"cost" : {"type": "float","title": "COST"},"limit" : {"type": "float","title": "LIMIT"},"currency" : {"type": "string","title": "CURRENCY"},"provider_filter" : {"$ref": "#/components/schemas/BudgetUsageProviderFilter","title": "PROVIDER_FILTER"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
- "type": "object",
- "required": ["budget_id","name","date","cost","limit","currency","provider_filter","resource_group","data_source_id","project_id","workspace_id","domain_id","updated_at"],
- "title": "BudgetUsageInfo"
- }
- , "BudgetUsageProviderFilter": {
- "properties" : {"state" : {"type": "string","title": "STATE"},"providers" : {"items": {"type": "string"},
- "type": "array","title": "PROVIDERS"}},
- "type": "object",
- "required": ["state","providers"],
- "title": "BudgetUsageProviderFilter"
- }
- , "BudgetUsageQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"name" : {"type": "string","title": "NAME"},"date" : {"type": "string","title": "DATE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"budget_id" : {"type": "string","title": "BUDGET_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": [],
- "title": "BudgetUsageQuery"
- }
- , "BudgetUsageStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"budget_id" : {"type": "string","title": "BUDGET_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": ["query"],
- "title": "BudgetUsageStatQuery"
- }
- , "BudgetUsagesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/BudgetUsageInfo"},
- "type": "array","$ref": "#/components/schemas/BudgetUsageInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "BudgetUsagesInfo"
- }
- , "CostAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": ["query","data_source_id"],
- "title": "CostAnalyzeQuery"
- }
- , "CostInfo": {
- "properties" : {"cost_id" : {"type": "string","title": "COST_ID"},"cost" : {"type": "float","title": "COST"},"usage_quantity" : {"type": "float","title": "USAGE_QUANTITY"},"usage_unit" : {"type": "string","title": "USAGE_UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"region_key" : {"type": "string","title": "REGION_KEY"},"product" : {"type": "string","title": "PRODUCT"},"usage_type" : {"type": "string","title": "USAGE_TYPE"},"resource" : {"type": "string","title": "RESOURCE"},"tags" : {"type": "object","title": "TAGS"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"data" : {"type": "object","title": "DATA"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"billed_year" : {"type": "string","title": "BILLED_YEAR"},"billed_month" : {"type": "string","title": "BILLED_MONTH"},"billed_date" : {"type": "string","title": "BILLED_DATE"}},
- "type": "object",
- "required": ["cost_id","cost","usage_quantity","usage_unit","provider","region_code","region_key","product","usage_type","resource","tags","additional_info","data","domain_id","workspace_id","project_id","service_account_id","data_source_id","account_id","billed_year","billed_month","billed_date"],
- "title": "CostInfo"
- }
- , "CostQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"cost_id" : {"type": "string","title": "COST_ID"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"region_key" : {"type": "string","title": "REGION_KEY"},"product" : {"type": "string","title": "PRODUCT"},"usage_type" : {"type": "string","title": "USAGE_TYPE"},"resource" : {"type": "string","title": "RESOURCE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"billed_year" : {"type": "string","title": "BILLED_YEAR"},"billed_month" : {"type": "string","title": "BILLED_MONTH"},"billed_date" : {"type": "string","title": "BILLED_DATE"}},
- "type": "object",
- "required": ["data_source_id"],
- "title": "CostQuery"
- }
- , "CostRequest": {
- "properties" : {"cost_id" : {"type": "string","title": "COST_ID"}},
- "type": "object",
- "required": ["cost_id"],
- "title": "CostRequest"
- }
- , "CostStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": ["query"],
- "title": "CostStatQuery"
- }
- , "CostsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostInfo"},
- "type": "array","$ref": "#/components/schemas/CostInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "CostsInfo"
- }
- , "CreateCostRequest": {
- "properties" : {"cost" : {"type": "float","title": "COST"},"usage_quantity" : {"type": "float","title": "USAGE_QUANTITY"},"usage_unit" : {"type": "float","title": "USAGE_UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"product" : {"type": "string","title": "PRODUCT"},"usage_type" : {"type": "string","title": "USAGE_TYPE"},"resource" : {"type": "string","title": "RESOURCE"},"tags" : {"type": "object","title": "TAGS"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"billed_date" : {"type": "string","title": "BILLED_DATE"}},
- "type": "object",
- "required": ["cost","project_id","data_source_id","billed_date"],
- "title": "CreateCostRequest"
- }
- , "JobTaskInfo": {
- "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"options" : {"type": "object","title": "OPTIONS"},"created_count" : {"type": "integer","title": "CREATED_COUNT"},"error_code" : {"type": "string","title": "ERROR_CODE"},"error_message" : {"type": "string","title": "ERROR_MESSAGE"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"started_at" : {"type": "string","title": "STARTED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
- "type": "object",
- "required": ["job_task_id","status","options","created_count","error_code","error_message","resource_group","domain_id","workspace_id","job_id","data_source_id","created_at","started_at","updated_at","finished_at"],
- "title": "JobTaskInfo"
- }
- , "JobTaskQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": [],
- "title": "JobTaskQuery"
- }
- , "JobTaskRequest": {
- "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"}},
- "type": "object",
- "required": ["job_task_id"],
- "title": "JobTaskRequest"
- }
- , "JobTaskStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
- "type": "object",
- "required": ["query"],
- "title": "JobTaskStatQuery"
- }
- , "JobTasksInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobTaskInfo"},
- "type": "array","$ref": "#/components/schemas/JobTaskInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "JobTasksInfo"
- }
- , "CostReportConfigInfo": {
- "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"state" : {"type": "string","title": "STATE"},"issue_day" : {"type": "integer","title": "ISSUE_DAY"},"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY"},"currency" : {"type": "string","title": "CURRENCY"},"recipients" : {"type": "object","title": "RECIPIENTS"},"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER"},"language" : {"type": "string","title": "LANGUAGE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
- "type": "object",
- "required": ["cost_report_config_id","state","issue_day","is_last_day","currency","recipients","data_source_filter","language","domain_id","created_at","updated_at"],
- "title": "CostReportConfigInfo"
- }
- , "CostReportConfigQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"state" : {"type": "string","title": "STATE"}},
- "type": "object",
- "required": [],
- "title": "CostReportConfigQuery"
- }
- , "CostReportConfigRequest": {
- "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"}},
- "type": "object",
- "required": ["cost_report_config_id"],
- "title": "CostReportConfigRequest"
- }
- , "CostReportConfigStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
- "type": "object",
- "required": ["query"],
- "title": "CostReportConfigStatQuery"
- }
- , "CostReportConfigsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostReportConfigInfo"},
- "type": "array","$ref": "#/components/schemas/CostReportConfigInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "CostReportConfigsInfo"
- }
- , "CreateCostReportConfigRequest": {
- "properties" : {"issue_day" : {"type": "integer","title": "ISSUE_DAY"},"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY"},"currency" : {"type": "string","title": "CURRENCY"},"recipients" : {"type": "object","title": "RECIPIENTS"},"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER"},"language" : {"type": "string","title": "LANGUAGE"}},
- "type": "object",
- "required": ["recipients"],
- "title": "CreateCostReportConfigRequest"
- }
- , "UpdateCostReportConfigRecipientsRequest": {
- "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"recipients" : {"type": "object","title": "RECIPIENTS"}},
- "type": "object",
- "required": ["cost_report_config_id"],
- "title": "UpdateCostReportConfigRecipientsRequest"
- }
- , "UpdateCostReportConfigRequest": {
- "properties" : {"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"issue_day" : {"type": "integer","title": "ISSUE_DAY"},"is_last_day" : {"type": "boolean","title": "IS_LAST_DAY"},"currency" : {"type": "string","title": "CURRENCY"},"data_source_filter" : {"type": "object","title": "DATA_SOURCE_FILTER"},"language" : {"type": "string","title": "LANGUAGE"}},
- "type": "object",
- "required": ["cost_report_config_id"],
- "title": "UpdateCostReportConfigRequest"
- }
- , "CostReportDataAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"product" : {"type": "string","title": "PRODUCT"},"provider" : {"type": "string","title": "PROVIDER"},"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": [],
- "title": "CostReportDataAnalyzeQuery"
- }
- , "CostReportDataInfo": {
- "properties" : {"cost_report_data_id" : {"type": "string","title": "COST_REPORT_DATA_ID"},"cost" : {"type": "object","title": "COST"},"cost_report_name" : {"type": "string","title": "COST_REPORT_NAME"},"issue_date" : {"type": "string","title": "ISSUE_DATE"},"report_year" : {"type": "string","title": "REPORT_YEAR"},"report_month" : {"type": "string","title": "REPORT_MONTH"},"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED"},"provider" : {"type": "string","title": "PROVIDER"},"product" : {"type": "string","title": "PRODUCT"},"service_account_name" : {"type": "string","title": "SERVICE_ACCOUNT_NAME"},"data_source_name" : {"type": "string","title": "DATA_SOURCE_NAME"},"project_name" : {"type": "string","title": "PROJECT_NAME"},"workspace_name" : {"type": "string","title": "WORKSPACE_NAME"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
- "type": "object",
- "required": ["cost_report_data_id","cost","cost_report_name","issue_date","report_year","report_month","is_confirmed","provider","product","service_account_name","data_source_name","project_name","workspace_name","domain_id","workspace_id","project_id","cost_report_config_id","cost_report_id","data_source_id","service_account_id","created_at"],
- "title": "CostReportDataInfo"
- }
- , "CostReportDataQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cost_report_data_id" : {"type": "string","title": "COST_REPORT_DATA_ID"},"product" : {"type": "string","title": "PRODUCT"},"provider" : {"type": "string","title": "PROVIDER"},"is_confirmed" : {"type": "boolean","title": "IS_CONFIRMED"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
- "type": "object",
- "required": [],
- "title": "CostReportDataQuery"
- }
- , "CostReportDataStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"}},
- "type": "object",
- "required": ["query"],
- "title": "CostReportDataStatQuery"
- }
- , "CostReportsDataInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostReportDataInfo"},
- "type": "array","$ref": "#/components/schemas/CostReportDataInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "CostReportsDataInfo"
+ "required": ["cost","project_id","data_source_id","billed_date"],
+ "title": "CreateCostRequest"
}
, "BudgetInfo": {
"properties" : {"budget_id" : {"type": "string","title": "BUDGET_ID"},"name" : {"type": "string","title": "NAME"},"limit" : {"type": "float","title": "LIMIT"},"planned_limits" : {"items": {"$ref": "#/components/schemas/PlannedLimit"},
@@ -2824,85 +2673,81 @@
"required": ["budget_id"],
"title": "UpdateBudgetRequest"
}
- , "CostQuerySetInfo": {
- "properties" : {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"user_id" : {"type": "string","title": "USER_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
- "type": "object",
- "required": ["cost_query_set_id","name","options","tags","domain_id","workspace_id","user_id","data_source_id","created_at","updated_at"],
- "title": "CostQuerySetInfo"
- }
- , "CostQuerySetQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"}},
- "type": "object",
- "required": ["data_source_id"],
- "title": "CostQuerySetQuery"
- }
- , "CostQuerySetRequest": {
- "properties" : {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID"}},
+ , "ChangeDataSourceRuleOrderRequest": {
+ "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"order" : {"type": "integer","title": "ORDER"}},
"type": "object",
- "required": ["cost_query_set_id"],
- "title": "CostQuerySetRequest"
+ "required": ["data_source_rule_id","order"],
+ "title": "ChangeDataSourceRuleOrderRequest"
}
- , "CostQuerySetStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
+ , "CreateDataSourceRuleRequest": {
+ "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"},
+ "type": "array","$ref": "#/components/schemas/DataSourceRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["query","data_source_id"],
- "title": "CostQuerySetStatQuery"
+ "required": ["data_source_id","conditions_policy","actions","resource_group","workspace_id"],
+ "title": "CreateDataSourceRuleRequest"
}
- , "CostQuerySetsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostQuerySetInfo"},
- "type": "array","$ref": "#/components/schemas/CostQuerySetInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "DataSourceRuleActions": {
+ "properties" : {"change_project" : {"type": "string","title": "CHANGE_PROJECT"},"match_project" : {"$ref": "#/components/schemas/MatchRule","title": "MATCH_PROJECT"},"match_service_account" : {"$ref": "#/components/schemas/MatchRule","title": "MATCH_SERVICE_ACCOUNT"},"add_additional_info" : {"type": "object","title": "ADD_ADDITIONAL_INFO"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "CostQuerySetsInfo"
+ "required": ["change_project","match_project","match_service_account","add_additional_info"],
+ "title": "DataSourceRuleActions"
}
- , "CreateCostQuerySetRequest": {
- "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "DataSourceRuleCondition": {
+ "properties" : {"key" : {"type": "string","title": "KEY"},"value" : {"type": "string","title": "VALUE"},"operator" : {"type": "string","title": "OPERATOR"}},
"type": "object",
- "required": ["data_source_id","name","options"],
- "title": "CreateCostQuerySetRequest"
+ "required": ["key","value","operator"],
+ "title": "DataSourceRuleCondition"
}
- , "UpdateCostQuerySetRequest": {
- "properties" : {"cost_query_set_id" : {"type": "string","title": "COST_QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "DataSourceRuleInfo": {
+ "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"name" : {"type": "string","title": "NAME"},"rule_type" : {"type": "string","title": "RULE_TYPE"},"order" : {"type": "integer","title": "ORDER"},"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"},
+ "type": "array","$ref": "#/components/schemas/DataSourceRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["cost_query_set_id"],
- "title": "UpdateCostQuerySetRequest"
+ "required": ["data_source_rule_id","name","rule_type","order","conditions","conditions_policy","actions","options","tags","resource_group","domain_id","workspace_id","data_source_id","created_at"],
+ "title": "DataSourceRuleInfo"
}
- , "CostReportInfo": {
- "properties" : {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"cost" : {"type": "object","title": "COST"},"status" : {"type": "string","title": "STATUS"},"report_number" : {"type": "string","title": "REPORT_NUMBER"},"currency" : {"type": "string","title": "CURRENCY"},"currency_date" : {"type": "string","title": "CURRENCY_DATE"},"issue_date" : {"type": "string","title": "ISSUE_DATE"},"report_year" : {"type": "string","title": "REPORT_YEAR"},"report_month" : {"type": "string","title": "REPORT_MONTH"},"workspace_name" : {"type": "string","title": "WORKSPACE_NAME"},"bank_name" : {"type": "string","title": "BANK_NAME"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "DataSourceRuleOptions": {
+ "properties" : {"stop_processing" : {"type": "boolean","title": "STOP_PROCESSING"}},
"type": "object",
- "required": ["cost_report_id","cost","status","report_number","currency","currency_date","issue_date","report_year","report_month","workspace_name","bank_name","cost_report_config_id","workspace_id","domain_id","created_at"],
- "title": "CostReportInfo"
+ "required": ["stop_processing"],
+ "title": "DataSourceRuleOptions"
}
- , "CostReportQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"status" : {"type": "string","title": "STATUS"},"issue_date" : {"type": "string","title": "ISSUE_DATE"},"workspace_name" : {"type": "string","title": "WORKSPACE_NAME"}},
+ , "DataSourceRuleQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"name" : {"type": "string","title": "NAME"},"rule_type" : {"type": "string","title": "RULE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
"type": "object",
"required": [],
- "title": "CostReportQuery"
+ "title": "DataSourceRuleQuery"
}
- , "CostReportRequest": {
- "properties" : {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"}},
+ , "DataSourceRuleRequest": {
+ "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"}},
"type": "object",
- "required": ["cost_report_id"],
- "title": "CostReportRequest"
+ "required": ["data_source_rule_id"],
+ "title": "DataSourceRuleRequest"
}
- , "CostReportStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"}},
+ , "DataSourceRuleStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "CostReportStatQuery"
+ "title": "DataSourceRuleStatQuery"
}
- , "CostReportsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostReportInfo"},
- "type": "array","$ref": "#/components/schemas/CostReportInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "DataSourceRulesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DataSourceRuleInfo"},
+ "type": "array","$ref": "#/components/schemas/DataSourceRuleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "CostReportsInfo"
+ "title": "DataSourceRulesInfo"
}
- , "GetUrlCostReportRequest": {
- "properties" : {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"}},
+ , "MatchRule": {
+ "properties" : {"source" : {"type": "string","title": "SOURCE"},"target" : {"type": "string","title": "TARGET"},"all_workspaces" : {"type": "boolean","title": "ALL_WORKSPACES"}},
"type": "object",
- "required": ["cost_report_id"],
- "title": "GetUrlCostReportRequest"
+ "required": ["source","target","all_workspaces"],
+ "title": "MatchRule"
+ }
+ , "UpdateDataSourceRuleRequest": {
+ "properties" : {"data_source_rule_id" : {"type": "string","title": "DATA_SOURCE_RULE_ID"},"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/DataSourceRuleCondition"},
+ "type": "array","$ref": "#/components/schemas/DataSourceRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/DataSourceRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/DataSourceRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["data_source_rule_id"],
+ "title": "UpdateDataSourceRuleRequest"
}
, "ChangedInfo": {
"properties" : {"start" : {"type": "string","title": "START"},"end" : {"type": "string","title": "END"},"filter" : {"type": "object","title": "FILTER"}},
@@ -2948,6 +2793,161 @@
"type": "object",
"required": ["account_id"],
"title": "SyncedAccountInfo"
+ }
+ , "JobTaskInfo": {
+ "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"options" : {"type": "object","title": "OPTIONS"},"created_count" : {"type": "integer","title": "CREATED_COUNT"},"error_code" : {"type": "string","title": "ERROR_CODE"},"error_message" : {"type": "string","title": "ERROR_MESSAGE"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"started_at" : {"type": "string","title": "STARTED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
+ "type": "object",
+ "required": ["job_task_id","status","options","created_count","error_code","error_message","resource_group","domain_id","workspace_id","job_id","data_source_id","created_at","started_at","updated_at","finished_at"],
+ "title": "JobTaskInfo"
+ }
+ , "JobTaskQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "JobTaskQuery"
+ }
+ , "JobTaskRequest": {
+ "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"}},
+ "type": "object",
+ "required": ["job_task_id"],
+ "title": "JobTaskRequest"
+ }
+ , "JobTaskStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "JobTaskStatQuery"
+ }
+ , "JobTasksInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobTaskInfo"},
+ "type": "array","$ref": "#/components/schemas/JobTaskInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "JobTasksInfo"
+ }
+ , "DataSourceAccountAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": ["query","data_source_id","account_id","workspace_id"],
+ "title": "DataSourceAccountAnalyzeQuery"
+ }
+ , "DataSourceAccountInfo": {
+ "properties" : {"account_id" : {"type": "string","title": "ACCOUNT_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"is_sync" : {"type": "boolean","title": "IS_SYNC"},"is_linked" : {"type": "boolean","title": "IS_LINKED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"v_workspace_id" : {"type": "string","title": "V_WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"}},
+ "type": "object",
+ "required": ["account_id","data_source_id","name","is_sync","is_linked","domain_id","workspace_id","v_workspace_id","created_at","updated_at","last_synced_at"],
+ "title": "DataSourceAccountInfo"
+ }
+ , "DataSourceAccountQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "DataSourceAccountQuery"
+ }
+ , "DataSourceAccountRequest": {
+ "properties" : {"data_source_account_id" : {"type": "string","title": "DATA_SOURCE_ACCOUNT_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"}},
+ "type": "object",
+ "required": ["data_source_account_id","account_id"],
+ "title": "DataSourceAccountRequest"
+ }
+ , "DataSourceAccountStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "DataSourceAccountStatQuery"
+ }
+ , "DataSourceAccountsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DataSourceAccountInfo"},
+ "type": "array","$ref": "#/components/schemas/DataSourceAccountInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "DataSourceAccountsInfo"
+ }
+ , "ResetDataSourceAccountRequest": {
+ "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"}},
+ "type": "object",
+ "required": ["data_source_id"],
+ "title": "ResetDataSourceAccountRequest"
+ }
+ , "UpdateDataSourceAccountRequest": {
+ "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"account_id" : {"type": "string","title": "ACCOUNT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
+ "type": "object",
+ "required": ["data_source_id","account_id"],
+ "title": "UpdateDataSourceAccountRequest"
+ }
+ , "BudgetUsageAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"budget_id" : {"type": "string","title": "BUDGET_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "BudgetUsageAnalyzeQuery"
+ }
+ , "BudgetUsageInfo": {
+ "properties" : {"budget_id" : {"type": "string","title": "BUDGET_ID"},"name" : {"type": "string","title": "NAME"},"date" : {"type": "string","title": "DATE"},"cost" : {"type": "float","title": "COST"},"limit" : {"type": "float","title": "LIMIT"},"currency" : {"type": "string","title": "CURRENCY"},"provider_filter" : {"$ref": "#/components/schemas/BudgetUsageProviderFilter","title": "PROVIDER_FILTER"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["budget_id","name","date","cost","limit","currency","provider_filter","resource_group","data_source_id","project_id","workspace_id","domain_id","updated_at"],
+ "title": "BudgetUsageInfo"
+ }
+ , "BudgetUsageProviderFilter": {
+ "properties" : {"state" : {"type": "string","title": "STATE"},"providers" : {"items": {"type": "string"},
+ "type": "array","title": "PROVIDERS"}},
+ "type": "object",
+ "required": ["state","providers"],
+ "title": "BudgetUsageProviderFilter"
+ }
+ , "BudgetUsageQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"name" : {"type": "string","title": "NAME"},"date" : {"type": "string","title": "DATE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"budget_id" : {"type": "string","title": "BUDGET_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "BudgetUsageQuery"
+ }
+ , "BudgetUsageStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"budget_id" : {"type": "string","title": "BUDGET_ID"},"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "BudgetUsageStatQuery"
+ }
+ , "BudgetUsagesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/BudgetUsageInfo"},
+ "type": "array","$ref": "#/components/schemas/BudgetUsageInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "BudgetUsagesInfo"
+ }
+ , "CostReportInfo": {
+ "properties" : {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"cost" : {"type": "object","title": "COST"},"status" : {"type": "string","title": "STATUS"},"report_number" : {"type": "string","title": "REPORT_NUMBER"},"currency" : {"type": "string","title": "CURRENCY"},"currency_date" : {"type": "string","title": "CURRENCY_DATE"},"issue_date" : {"type": "string","title": "ISSUE_DATE"},"report_year" : {"type": "string","title": "REPORT_YEAR"},"report_month" : {"type": "string","title": "REPORT_MONTH"},"workspace_name" : {"type": "string","title": "WORKSPACE_NAME"},"bank_name" : {"type": "string","title": "BANK_NAME"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ "type": "object",
+ "required": ["cost_report_id","cost","status","report_number","currency","currency_date","issue_date","report_year","report_month","workspace_name","bank_name","cost_report_config_id","workspace_id","domain_id","created_at"],
+ "title": "CostReportInfo"
+ }
+ , "CostReportQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"},"cost_report_config_id" : {"type": "string","title": "COST_REPORT_CONFIG_ID"},"status" : {"type": "string","title": "STATUS"},"issue_date" : {"type": "string","title": "ISSUE_DATE"},"workspace_name" : {"type": "string","title": "WORKSPACE_NAME"}},
+ "type": "object",
+ "required": [],
+ "title": "CostReportQuery"
+ }
+ , "CostReportRequest": {
+ "properties" : {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"}},
+ "type": "object",
+ "required": ["cost_report_id"],
+ "title": "CostReportRequest"
+ }
+ , "CostReportStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "CostReportStatQuery"
+ }
+ , "CostReportsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CostReportInfo"},
+ "type": "array","$ref": "#/components/schemas/CostReportInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "CostReportsInfo"
+ }
+ , "GetUrlCostReportRequest": {
+ "properties" : {"cost_report_id" : {"type": "string","title": "COST_REPORT_ID"}},
+ "type": "object",
+ "required": ["cost_report_id"],
+ "title": "GetUrlCostReportRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/dashboard/v1/openapi.json b/dist/openapi/cloudforet/api/dashboard/v1/openapi.json
index a0fea9bc4..a843911e4 100755
--- a/dist/openapi/cloudforet/api/dashboard/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/dashboard/v1/openapi.json
@@ -205,18 +205,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-data-table/add": {
+ },"/dashboard/public-dashboard/create": {
"post": {
- "tags": ["dashboard > private-data-table"],
- "summary": "Add",
+ "tags": ["dashboard > public-dashboard"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |source_type||SourceType|True|\n |options||AddOptions|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |resource_group|DOMAIN, WORKSPACE, PROJECT |string|True|\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |workspace_id||string||\n |project_id||string||\n |folder_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"source_type" : {"type": "SourceType","title": "SOURCE_TYPE" },"options" : {"$ref": "#/components/schemas/AddOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -227,25 +227,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
+ "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-data-table/transform": {
+ },"/dashboard/public-dashboard/update": {
"post": {
- "tags": ["dashboard > private-data-table"],
- "summary": "Transform",
+ "tags": ["dashboard > public-dashboard"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |operator||Operator|True|\n |options||TransformOptions|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |folder_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"operator" : {"type": "Operator","title": "OPERATOR" },"options" : {"$ref": "#/components/schemas/TransformOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -256,25 +256,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
+ "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-data-table/update": {
+ },"/dashboard/public-dashboard/share": {
"post": {
- "tags": ["dashboard > private-data-table"],
- "summary": "Update",
+ "tags": ["dashboard > public-dashboard"],
+ "summary": "Share",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n |name||string||\n |options||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
},
"examples":{"Schema":{}
}
@@ -285,25 +285,54 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
+ "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-data-table/delete": {
+ },"/dashboard/public-dashboard/unshare": {
"post": {
- "tags": ["dashboard > private-data-table"],
+ "tags": ["dashboard > public-dashboard"],
+ "summary": "Unshare",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/dashboard/public-dashboard/delete": {
+ "post": {
+ "tags": ["dashboard > public-dashboard"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
},
"examples":{"Schema":{}
}
@@ -315,18 +344,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-data-table/load": {
+ },"/dashboard/public-dashboard/get": {
"post": {
- "tags": ["dashboard > private-data-table"],
- "summary": "Load",
+ "tags": ["dashboard > public-dashboard"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n |granularity|DAILY, MONTHLY, YEARLY |string|True|\n |start||string||\n |end||string||\n |sort||array||\n |page||Page||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"granularity" : {"type": "string","title": "GRANULARITY" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"sort" : {"items": {"$ref": "#/components/schemas/Sort"}, "type": "array","title": "SORT" },"page" : {"$ref": "#/components/schemas/Page","title": "PAGE" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
},
"examples":{"Schema":{}
}
@@ -337,25 +366,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-data-table/get": {
+ },"/dashboard/public-dashboard/list": {
"post": {
- "tags": ["dashboard > private-data-table"],
- "summary": "Get",
+ "tags": ["dashboard > public-dashboard"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |dashboard_id||string||\n |name||string||\n |shared||boolean||\n |scope|WORKSPACE, PROJECT |string||\n |workspace_id||string||\n |project_id||string||\n |folder_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"shared" : {"type": "boolean","title": "SHARED" },"scope" : {"type": "string","title": "SCOPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -366,25 +395,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
+ "schema": {"$ref": "#/components/schemas/PublicDashboardsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PublicDashboardsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-data-table/list": {
+ },"/dashboard/public-dashboard/stat": {
"post": {
- "tags": ["dashboard > private-data-table"],
- "summary": "List",
+ "tags": ["dashboard > public-dashboard"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |query||Query||\n |data_table_id||string||\n |name||string||\n |data_type||DataType||\n |source_type||SourceType||\n |operator||Operator||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"widget_id" : {"type": "string","title": "WIDGET_ID" },"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"name" : {"type": "string","title": "NAME" },"data_type" : {"type": "DataType","title": "DATA_TYPE" },"source_type" : {"type": "SourceType","title": "SOURCE_TYPE" },"operator" : {"type": "Operator","title": "OPERATOR" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -395,25 +424,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDataTablesInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDataTablesInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-folder/create": {
+ },"/dashboard/public-widget/create": {
"post": {
- "tags": ["dashboard > private-folder"],
+ "tags": ["dashboard > public-widget"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct||\n |dashboards||array||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||int||\n |data_tables||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" },"dashboards" : {"items": {}, "type": "array","title": "DASHBOARDS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "integer","title": "DATA_TABLE_ID" },"data_tables" : {"items": {}, "type": "array","title": "DATA_TABLES" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -424,25 +453,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateFolderInfo"},
+ "schema": {"$ref": "#/components/schemas/PublicWidgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateFolderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PublicWidgetInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-folder/update": {
+ },"/dashboard/public-widget/update": {
"post": {
- "tags": ["dashboard > private-folder"],
+ "tags": ["dashboard > public-widget"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |folder_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"folder_id" : {"type": "string","title": "FOLDER_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -453,25 +482,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateFolderInfo"},
+ "schema": {"$ref": "#/components/schemas/PublicWidgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateFolderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PublicWidgetInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-folder/delete": {
+ },"/dashboard/public-widget/delete": {
"post": {
- "tags": ["dashboard > private-folder"],
+ "tags": ["dashboard > public-widget"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |folder_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
},
"examples":{"Schema":{}
}
@@ -483,18 +512,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-folder/get": {
+ },"/dashboard/public-widget/load": {
"post": {
- "tags": ["dashboard > private-folder"],
- "summary": "Get",
+ "tags": ["dashboard > public-widget"],
+ "summary": "Load",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |folder_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |query||TimeSeriesAnalyzeQuery|True|\n |vars||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"vars" : {"type": "object","title": "VARS" } }
},
"examples":{"Schema":{}
}
@@ -505,25 +534,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateFolderInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateFolderInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-folder/list": {
+ },"/dashboard/public-widget/get": {
"post": {
- "tags": ["dashboard > private-folder"],
- "summary": "List",
+ "tags": ["dashboard > public-widget"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |folder_id||string||\n |name||string||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"folder_id" : {"type": "string","title": "FOLDER_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
},
"examples":{"Schema":{}
}
@@ -534,25 +563,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateFoldersInfo"},
+ "schema": {"$ref": "#/components/schemas/PublicWidgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateFoldersInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PublicWidgetInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-folder/stat": {
+ },"/dashboard/public-widget/list": {
"post": {
- "tags": ["dashboard > private-folder"],
- "summary": "Stat",
+ "tags": ["dashboard > public-widget"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |query||Query||\n |widget_id||string||\n |name||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" } }
},
"examples":{"Schema":{}
}
@@ -563,9 +592,9 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/PublicWidgetsInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/PublicWidgetsInfo"}}
}
}}
}
@@ -796,18 +825,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-widget/create": {
+ },"/dashboard/private-folder/create": {
"post": {
- "tags": ["dashboard > private-widget"],
+ "tags": ["dashboard > private-folder"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||int||\n |data_tables||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct||\n |dashboards||array||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "integer","title": "DATA_TABLE_ID" },"data_tables" : {"items": {}, "type": "array","title": "DATA_TABLES" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" },"dashboards" : {"items": {}, "type": "array","title": "DASHBOARDS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -818,25 +847,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateFolderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateFolderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-widget/update": {
+ },"/dashboard/private-folder/update": {
"post": {
- "tags": ["dashboard > private-widget"],
+ "tags": ["dashboard > private-folder"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |folder_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"folder_id" : {"type": "string","title": "FOLDER_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -847,25 +876,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateFolderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateFolderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-widget/delete": {
+ },"/dashboard/private-folder/delete": {
"post": {
- "tags": ["dashboard > private-widget"],
+ "tags": ["dashboard > private-folder"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |folder_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
+ "properties": {"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -877,18 +906,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-widget/load": {
+ },"/dashboard/private-folder/get": {
"post": {
- "tags": ["dashboard > private-widget"],
- "summary": "Load",
+ "tags": ["dashboard > private-folder"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |query||TimeSeriesAnalyzeQuery|True|\n |vars||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |folder_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"vars" : {"type": "object","title": "VARS" } }
+ "properties": {"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -899,25 +928,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/PrivateFolderInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateFolderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-widget/get": {
+ },"/dashboard/private-folder/list": {
"post": {
- "tags": ["dashboard > private-widget"],
- "summary": "Get",
+ "tags": ["dashboard > private-folder"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |folder_id||string||\n |name||string||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"folder_id" : {"type": "string","title": "FOLDER_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -928,25 +957,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateFoldersInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateFoldersInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-widget/list": {
+ },"/dashboard/private-folder/stat": {
"post": {
- "tags": ["dashboard > private-widget"],
- "summary": "List",
+ "tags": ["dashboard > private-folder"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |query||Query||\n |widget_id||string||\n |name||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -957,25 +986,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateWidgetsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateWidgetsInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-widget/create": {
+ },"/dashboard/private-dashboard/create": {
"post": {
- "tags": ["dashboard > public-widget"],
+ "tags": ["dashboard > private-dashboard"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||int||\n |data_tables||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |workspace_id||string||\n |folder_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "integer","title": "DATA_TABLE_ID" },"data_tables" : {"items": {}, "type": "array","title": "DATA_TABLES" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -986,25 +1015,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicWidgetInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicWidgetInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-widget/update": {
+ },"/dashboard/private-dashboard/update": {
"post": {
- "tags": ["dashboard > public-widget"],
+ "tags": ["dashboard > private-dashboard"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |folder_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -1015,25 +1044,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicWidgetInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicWidgetInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-widget/delete": {
+ },"/dashboard/private-dashboard/delete": {
"post": {
- "tags": ["dashboard > public-widget"],
+ "tags": ["dashboard > private-dashboard"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" } }
},
"examples":{"Schema":{}
}
@@ -1045,18 +1074,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-widget/load": {
+ },"/dashboard/private-dashboard/get": {
"post": {
- "tags": ["dashboard > public-widget"],
- "summary": "Load",
+ "tags": ["dashboard > private-dashboard"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |query||TimeSeriesAnalyzeQuery|True|\n |vars||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"vars" : {"type": "object","title": "VARS" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" } }
},
"examples":{"Schema":{}
}
@@ -1067,25 +1096,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-widget/get": {
+ },"/dashboard/private-dashboard/list": {
"post": {
- "tags": ["dashboard > public-widget"],
- "summary": "Get",
+ "tags": ["dashboard > private-dashboard"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |dashboard_id||string||\n |name||string||\n |workspace_id||string||\n |folder_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
},
"examples":{"Schema":{}
}
@@ -1096,25 +1125,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicWidgetInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateDashboardsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicWidgetInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDashboardsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-widget/list": {
+ },"/dashboard/private-dashboard/stat": {
"post": {
- "tags": ["dashboard > public-widget"],
- "summary": "List",
+ "tags": ["dashboard > private-dashboard"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |query||Query||\n |widget_id||string||\n |name||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -1125,25 +1154,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicWidgetsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicWidgetsInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/create": {
+ },"/dashboard/private-widget/create": {
"post": {
- "tags": ["dashboard > public-dashboard"],
+ "tags": ["dashboard > private-widget"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |resource_group|DOMAIN, WORKSPACE, PROJECT |string|True|\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |workspace_id||string||\n |project_id||string||\n |folder_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||int||\n |data_tables||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "integer","title": "DATA_TABLE_ID" },"data_tables" : {"items": {}, "type": "array","title": "DATA_TABLES" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1154,25 +1183,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/update": {
+ },"/dashboard/private-widget/update": {
"post": {
- "tags": ["dashboard > public-dashboard"],
+ "tags": ["dashboard > private-widget"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |folder_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |name||string||\n |state|ACTIVE, INACTIVE |string||\n |description||string||\n |widget_type||string||\n |size||string||\n |options||Struct||\n |data_table_id||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"widget_type" : {"type": "string","title": "WIDGET_TYPE" },"size" : {"type": "string","title": "SIZE" },"options" : {"type": "object","title": "OPTIONS" },"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1183,25 +1212,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/share": {
+ },"/dashboard/private-widget/delete": {
"post": {
- "tags": ["dashboard > public-dashboard"],
- "summary": "Share",
+ "tags": ["dashboard > private-widget"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
},
"examples":{"Schema":{}
}
@@ -1210,27 +1239,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/unshare": {
+ },"/dashboard/private-widget/load": {
"post": {
- "tags": ["dashboard > public-dashboard"],
- "summary": "Unshare",
+ "tags": ["dashboard > private-widget"],
+ "summary": "Load",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |query||TimeSeriesAnalyzeQuery|True|\n |vars||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"vars" : {"type": "object","title": "VARS" } }
},
"examples":{"Schema":{}
}
@@ -1241,48 +1264,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/delete": {
- "post": {
- "tags": ["dashboard > public-dashboard"],
- "summary": "Delete",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/get": {
+ },"/dashboard/private-widget/get": {
"post": {
- "tags": ["dashboard > public-dashboard"],
+ "tags": ["dashboard > private-widget"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |scope|WORKSPACE, PROJECT |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"scope" : {"type": "string","title": "SCOPE" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" } }
},
"examples":{"Schema":{}
}
@@ -1293,25 +1293,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicDashboardInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicDashboardInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateWidgetInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/list": {
+ },"/dashboard/private-widget/list": {
"post": {
- "tags": ["dashboard > public-dashboard"],
+ "tags": ["dashboard > private-widget"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |dashboard_id||string||\n |name||string||\n |shared||boolean||\n |scope|WORKSPACE, PROJECT |string||\n |workspace_id||string||\n |project_id||string||\n |folder_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |query||Query||\n |widget_id||string||\n |name||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"shared" : {"type": "boolean","title": "SHARED" },"scope" : {"type": "string","title": "SCOPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" } }
},
"examples":{"Schema":{}
}
@@ -1322,25 +1322,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PublicDashboardsInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateWidgetsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PublicDashboardsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateWidgetsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/public-dashboard/stat": {
+ },"/dashboard/private-data-table/add": {
"post": {
- "tags": ["dashboard > public-dashboard"],
- "summary": "Stat",
+ "tags": ["dashboard > private-data-table"],
+ "summary": "Add",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |source_type||SourceType|True|\n |options||AddOptions|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"source_type" : {"type": "SourceType","title": "SOURCE_TYPE" },"options" : {"$ref": "#/components/schemas/AddOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1351,25 +1351,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-dashboard/create": {
+ },"/dashboard/private-data-table/transform": {
"post": {
- "tags": ["dashboard > private-dashboard"],
- "summary": "Create",
+ "tags": ["dashboard > private-data-table"],
+ "summary": "Transform",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |workspace_id||string||\n |folder_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |operator||Operator|True|\n |options||TransformOptions|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"widget_id" : {"type": "string","title": "WIDGET_ID" },"name" : {"type": "string","title": "NAME" },"operator" : {"type": "Operator","title": "OPERATOR" },"options" : {"$ref": "#/components/schemas/TransformOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1380,25 +1380,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-dashboard/update": {
+ },"/dashboard/private-data-table/update": {
"post": {
- "tags": ["dashboard > private-dashboard"],
+ "tags": ["dashboard > private-data-table"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n |name||string||\n |description||string||\n |layouts||array||\n |vars||Struct||\n |options||Struct||\n |variables||Struct||\n |variables_schema||Struct||\n |labels||array||\n |tags||Struct||\n |folder_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n |name||string||\n |options||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"description" : {"type": "string","title": "DESCRIPTION" },"layouts" : {"items": {"$ref": "#/components/schemas/Layout"}, "type": "array","title": "LAYOUTS" },"vars" : {"type": "object","title": "VARS" },"options" : {"type": "object","title": "OPTIONS" },"variables" : {"type": "object","title": "VARIABLES" },"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1409,25 +1409,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-dashboard/delete": {
+ },"/dashboard/private-data-table/delete": {
"post": {
- "tags": ["dashboard > private-dashboard"],
+ "tags": ["dashboard > private-data-table"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" } }
+ "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1439,18 +1439,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-dashboard/get": {
+ },"/dashboard/private-data-table/load": {
"post": {
- "tags": ["dashboard > private-dashboard"],
- "summary": "Get",
+ "tags": ["dashboard > private-data-table"],
+ "summary": "Load",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |dashboard_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n |granularity|DAILY, MONTHLY, YEARLY |string|True|\n |start||string||\n |end||string||\n |sort||array||\n |page||Page||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" } }
+ "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"granularity" : {"type": "string","title": "GRANULARITY" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"sort" : {"items": {"$ref": "#/components/schemas/Sort"}, "type": "array","title": "SORT" },"page" : {"$ref": "#/components/schemas/Page","title": "PAGE" } }
},
"examples":{"Schema":{}
}
@@ -1461,25 +1461,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDashboardInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-dashboard/list": {
+ },"/dashboard/private-data-table/get": {
"post": {
- "tags": ["dashboard > private-dashboard"],
- "summary": "List",
+ "tags": ["dashboard > private-data-table"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |dashboard_id||string||\n |name||string||\n |workspace_id||string||\n |folder_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_table_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"dashboard_id" : {"type": "string","title": "DASHBOARD_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"folder_id" : {"type": "string","title": "FOLDER_ID" } }
+ "properties": {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1490,25 +1490,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PrivateDashboardsInfo"},
+ "schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PrivateDashboardsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDataTableInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/dashboard/private-dashboard/stat": {
+ },"/dashboard/private-data-table/list": {
"post": {
- "tags": ["dashboard > private-dashboard"],
- "summary": "Stat",
+ "tags": ["dashboard > private-data-table"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |widget_id||string|True|\n |query||Query||\n |data_table_id||string||\n |name||string||\n |data_type||DataType||\n |source_type||SourceType||\n |operator||Operator||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"widget_id" : {"type": "string","title": "WIDGET_ID" },"data_table_id" : {"type": "string","title": "DATA_TABLE_ID" },"name" : {"type": "string","title": "NAME" },"data_type" : {"type": "DataType","title": "DATA_TYPE" },"source_type" : {"type": "SourceType","title": "SOURCE_TYPE" },"operator" : {"type": "Operator","title": "OPERATOR" } }
},
"examples":{"Schema":{}
}
@@ -1519,9 +1519,9 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/PrivateDataTablesInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/PrivateDataTablesInfo"}}
}
}}
}
@@ -1646,44 +1646,6 @@
"required": ["data_table_id"],
"title": "UpdatePublicDataTableRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
@@ -1853,187 +1815,95 @@
"required": ["path","filter"],
"title": "Unwind"
}
- , "AddPrivateDataTableRequest": {
- "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"source_type" : {"type": "SourceType","title": "SOURCE_TYPE"},"options" : {"$ref": "#/components/schemas/AddOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["widget_id","source_type","options"],
- "title": "AddPrivateDataTableRequest"
- }
- , "LoadPrivateDataTableRequest": {
- "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"granularity" : {"type": "string","title": "GRANULARITY"},"start" : {"type": "string","title": "START"},"end" : {"type": "string","title": "END"},"sort" : {"items": {"$ref": "#/components/schemas/Sort"},
- "type": "array","$ref": "#/components/schemas/Sort","title": "SORT"},"page" : {"$ref": "#/components/schemas/Page","title": "PAGE"}},
- "type": "object",
- "required": ["data_table_id","granularity"],
- "title": "LoadPrivateDataTableRequest"
- }
- , "PrivateDataTableInfo": {
- "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"name" : {"type": "string","title": "NAME"},"data_type" : {"type": "DataType","title": "DATA_TYPE"},"source_type" : {"type": "SourceType","title": "SOURCE_TYPE"},"operator" : {"type": "Operator","title": "OPERATOR"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"labels_info" : {"type": "object","title": "LABELS_INFO"},"data_info" : {"type": "object","title": "DATA_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"widget_id" : {"type": "string","title": "WIDGET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
- "type": "object",
- "required": ["data_table_id","name","data_type","source_type","operator","options","tags","labels_info","data_info","domain_id","user_id","dashboard_id","widget_id","created_at","updated_at"],
- "title": "PrivateDataTableInfo"
- }
- , "PrivateDataTableQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"widget_id" : {"type": "string","title": "WIDGET_ID"},"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"name" : {"type": "string","title": "NAME"},"data_type" : {"type": "DataType","title": "DATA_TYPE"},"source_type" : {"type": "SourceType","title": "SOURCE_TYPE"},"operator" : {"type": "Operator","title": "OPERATOR"}},
- "type": "object",
- "required": ["widget_id"],
- "title": "PrivateDataTableQuery"
- }
- , "PrivateDataTableRequest": {
- "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"}},
- "type": "object",
- "required": ["data_table_id"],
- "title": "PrivateDataTableRequest"
- }
- , "PrivateDataTablesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
- "type": "array","$ref": "#/components/schemas/PrivateDataTableInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "PrivateDataTablesInfo"
- }
- , "TransformPrivateDataTableRequest": {
- "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"operator" : {"type": "Operator","title": "OPERATOR"},"options" : {"$ref": "#/components/schemas/TransformOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["widget_id","operator","options"],
- "title": "TransformPrivateDataTableRequest"
- }
- , "UpdatePrivateDataTableRequest": {
- "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["data_table_id"],
- "title": "UpdatePrivateDataTableRequest"
- }
- , "CreatePrivateFolderRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"dashboards" : {"items": {"type": "object"},
- "type": "array","title": "DASHBOARDS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["name"],
- "title": "CreatePrivateFolderRequest"
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
}
- , "PrivateFolderInfo": {
- "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
"type": "object",
- "required": ["folder_id","name","tags","domain_id","workspace_id","user_id","created_at","updated_at"],
- "title": "PrivateFolderInfo"
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
}
- , "PrivateFolderQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
"type": "object",
- "required": [],
- "title": "PrivateFolderQuery"
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
}
- , "PrivateFolderRequest": {
- "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"}},
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
"type": "object",
- "required": ["folder_id"],
- "title": "PrivateFolderRequest"
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
}
- , "PrivateFolderStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
"type": "object",
- "required": ["query"],
- "title": "PrivateFolderStatQuery"
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
}
- , "PrivateFoldersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PrivateFolderInfo"},
- "type": "array","$ref": "#/components/schemas/PrivateFolderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "PrivateFoldersInfo"
+ "required": ["version"],
+ "title": "VersionInfo"
}
- , "UpdatePrivateFolderRequest": {
- "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "CreatePublicDashboardRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"description" : {"type": "string","title": "DESCRIPTION"},"layouts" : {"items": {"$ref": "#/components/schemas/Layout"},
+ "type": "array","$ref": "#/components/schemas/Layout","title": "LAYOUTS"},"vars" : {"type": "object","title": "VARS"},"options" : {"type": "object","title": "OPTIONS"},"variables" : {"type": "object","title": "VARIABLES"},"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"folder_id" : {"type": "string","title": "FOLDER_ID"}},
"type": "object",
- "required": ["folder_id"],
- "title": "UpdatePrivateFolderRequest"
+ "required": ["name","resource_group"],
+ "title": "CreatePublicDashboardRequest"
}
- , "CreatePublicFolderRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"dashboards" : {"items": {"type": "object"},
- "type": "array","title": "DASHBOARDS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "Layout": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"widgets" : {"type": "array","title": "WIDGETS"}},
"type": "object",
- "required": ["name"],
- "title": "CreatePublicFolderRequest"
+ "required": ["name","options","widgets"],
+ "title": "Layout"
}
- , "PublicFolderInfo": {
- "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"shared" : {"type": "boolean","title": "SHARED"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "PublicDashboardInfo": {
+ "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"description" : {"type": "string","title": "DESCRIPTION"},"version" : {"type": "string","title": "VERSION"},"layouts" : {"items": {"$ref": "#/components/schemas/Layout"},
+ "type": "array","$ref": "#/components/schemas/Layout","title": "LAYOUTS"},"vars" : {"type": "object","title": "VARS"},"options" : {"type": "object","title": "OPTIONS"},"variables" : {"type": "object","title": "VARIABLES"},"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"shared" : {"type": "boolean","title": "SHARED"},"scope" : {"type": "string","title": "SCOPE"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"folder_id" : {"type": "string","title": "FOLDER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["folder_id","name","tags","shared","resource_group","domain_id","workspace_id","project_id","created_at","updated_at"],
- "title": "PublicFolderInfo"
+ "required": ["dashboard_id","name","description","version","layouts","vars","options","variables","variables_schema","labels","tags","shared","scope","resource_group","domain_id","workspace_id","project_id","folder_id","created_at","updated_at"],
+ "title": "PublicDashboardInfo"
}
- , "PublicFolderQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "PublicDashboardQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"shared" : {"type": "boolean","title": "SHARED"},"scope" : {"type": "string","title": "SCOPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"folder_id" : {"type": "string","title": "FOLDER_ID"}},
"type": "object",
"required": [],
- "title": "PublicFolderQuery"
+ "title": "PublicDashboardQuery"
}
- , "PublicFolderRequest": {
- "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"}},
+ , "PublicDashboardRequest": {
+ "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"scope" : {"type": "string","title": "SCOPE"}},
"type": "object",
- "required": ["folder_id"],
- "title": "PublicFolderRequest"
+ "required": ["dashboard_id"],
+ "title": "PublicDashboardRequest"
}
- , "PublicFolderStatQuery": {
+ , "PublicDashboardStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "PublicFolderStatQuery"
+ "title": "PublicDashboardStatQuery"
}
- , "PublicFoldersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PublicFolderInfo"},
- "type": "array","$ref": "#/components/schemas/PublicFolderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "PublicDashboardsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PublicDashboardInfo"},
+ "type": "array","$ref": "#/components/schemas/PublicDashboardInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "PublicFoldersInfo"
- }
- , "UpdatePublicFolderRequest": {
- "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["folder_id"],
- "title": "UpdatePublicFolderRequest"
- }
- , "CreatePrivateWidgetRequest": {
- "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"widget_type" : {"type": "string","title": "WIDGET_TYPE"},"size" : {"type": "string","title": "SIZE"},"options" : {"type": "object","title": "OPTIONS"},"data_table_id" : {"type": "integer","title": "DATA_TABLE_ID"},"data_tables" : {"items": {"type": "object"},
- "type": "array","title": "DATA_TABLES"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["dashboard_id"],
- "title": "CreatePrivateWidgetRequest"
- }
- , "LoadPrivateWidgetRequest": {
- "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"vars" : {"type": "object","title": "VARS"}},
- "type": "object",
- "required": ["widget_id","query"],
- "title": "LoadPrivateWidgetRequest"
- }
- , "PrivateWidgetInfo": {
- "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"widget_type" : {"type": "string","title": "WIDGET_TYPE"},"size" : {"type": "string","title": "SIZE"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
- "type": "object",
- "required": ["widget_id","name","state","description","widget_type","size","options","tags","domain_id","user_id","dashboard_id","data_table_id","created_at","updated_at"],
- "title": "PrivateWidgetInfo"
+ "title": "PublicDashboardsInfo"
}
- , "PrivateWidgetQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"}},
+ , "UpdatePublicDashboardRequest": {
+ "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"description" : {"type": "string","title": "DESCRIPTION"},"layouts" : {"items": {"$ref": "#/components/schemas/Layout"},
+ "type": "array","$ref": "#/components/schemas/Layout","title": "LAYOUTS"},"vars" : {"type": "object","title": "VARS"},"options" : {"type": "object","title": "OPTIONS"},"variables" : {"type": "object","title": "VARIABLES"},"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"folder_id" : {"type": "string","title": "FOLDER_ID"}},
"type": "object",
"required": ["dashboard_id"],
- "title": "PrivateWidgetQuery"
- }
- , "PrivateWidgetRequest": {
- "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"}},
- "type": "object",
- "required": ["widget_id"],
- "title": "PrivateWidgetRequest"
- }
- , "PrivateWidgetsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
- "type": "array","$ref": "#/components/schemas/PrivateWidgetInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "PrivateWidgetsInfo"
- }
- , "UpdatePrivateWidgetRequest": {
- "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"widget_type" : {"type": "string","title": "WIDGET_TYPE"},"size" : {"type": "string","title": "SIZE"},"options" : {"type": "object","title": "OPTIONS"},"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["widget_id"],
- "title": "UpdatePrivateWidgetRequest"
+ "title": "UpdatePublicDashboardRequest"
}
, "CreatePublicWidgetRequest": {
"properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"widget_type" : {"type": "string","title": "WIDGET_TYPE"},"size" : {"type": "string","title": "SIZE"},"options" : {"type": "object","title": "OPTIONS"},"data_table_id" : {"type": "integer","title": "DATA_TABLE_ID"},"data_tables" : {"items": {"type": "object"},
@@ -2079,57 +1949,93 @@
"required": ["widget_id"],
"title": "UpdatePublicWidgetRequest"
}
- , "CreatePublicDashboardRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"description" : {"type": "string","title": "DESCRIPTION"},"layouts" : {"items": {"$ref": "#/components/schemas/Layout"},
- "type": "array","$ref": "#/components/schemas/Layout","title": "LAYOUTS"},"vars" : {"type": "object","title": "VARS"},"options" : {"type": "object","title": "OPTIONS"},"variables" : {"type": "object","title": "VARIABLES"},"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"folder_id" : {"type": "string","title": "FOLDER_ID"}},
+ , "CreatePublicFolderRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"dashboards" : {"items": {"type": "object"},
+ "type": "array","title": "DASHBOARDS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["name","resource_group"],
- "title": "CreatePublicDashboardRequest"
+ "required": ["name"],
+ "title": "CreatePublicFolderRequest"
}
- , "Layout": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"widgets" : {"type": "array","title": "WIDGETS"}},
+ , "PublicFolderInfo": {
+ "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"shared" : {"type": "boolean","title": "SHARED"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["name","options","widgets"],
- "title": "Layout"
+ "required": ["folder_id","name","tags","shared","resource_group","domain_id","workspace_id","project_id","created_at","updated_at"],
+ "title": "PublicFolderInfo"
}
- , "PublicDashboardInfo": {
- "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"description" : {"type": "string","title": "DESCRIPTION"},"version" : {"type": "string","title": "VERSION"},"layouts" : {"items": {"$ref": "#/components/schemas/Layout"},
- "type": "array","$ref": "#/components/schemas/Layout","title": "LAYOUTS"},"vars" : {"type": "object","title": "VARS"},"options" : {"type": "object","title": "OPTIONS"},"variables" : {"type": "object","title": "VARIABLES"},"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"shared" : {"type": "boolean","title": "SHARED"},"scope" : {"type": "string","title": "SCOPE"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"folder_id" : {"type": "string","title": "FOLDER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "PublicFolderQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["dashboard_id","name","description","version","layouts","vars","options","variables","variables_schema","labels","tags","shared","scope","resource_group","domain_id","workspace_id","project_id","folder_id","created_at","updated_at"],
- "title": "PublicDashboardInfo"
+ "required": [],
+ "title": "PublicFolderQuery"
}
- , "PublicDashboardQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"shared" : {"type": "boolean","title": "SHARED"},"scope" : {"type": "string","title": "SCOPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"folder_id" : {"type": "string","title": "FOLDER_ID"}},
+ , "PublicFolderRequest": {
+ "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"}},
+ "type": "object",
+ "required": ["folder_id"],
+ "title": "PublicFolderRequest"
+ }
+ , "PublicFolderStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "PublicFolderStatQuery"
+ }
+ , "PublicFoldersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PublicFolderInfo"},
+ "type": "array","$ref": "#/components/schemas/PublicFolderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "PublicFoldersInfo"
+ }
+ , "UpdatePublicFolderRequest": {
+ "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["folder_id"],
+ "title": "UpdatePublicFolderRequest"
+ }
+ , "CreatePrivateFolderRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"dashboards" : {"items": {"type": "object"},
+ "type": "array","title": "DASHBOARDS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": ["name"],
+ "title": "CreatePrivateFolderRequest"
+ }
+ , "PrivateFolderInfo": {
+ "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["folder_id","name","tags","domain_id","workspace_id","user_id","created_at","updated_at"],
+ "title": "PrivateFolderInfo"
+ }
+ , "PrivateFolderQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
"required": [],
- "title": "PublicDashboardQuery"
+ "title": "PrivateFolderQuery"
}
- , "PublicDashboardRequest": {
- "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"scope" : {"type": "string","title": "SCOPE"}},
+ , "PrivateFolderRequest": {
+ "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"}},
"type": "object",
- "required": ["dashboard_id"],
- "title": "PublicDashboardRequest"
+ "required": ["folder_id"],
+ "title": "PrivateFolderRequest"
}
- , "PublicDashboardStatQuery": {
+ , "PrivateFolderStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "PublicDashboardStatQuery"
+ "title": "PrivateFolderStatQuery"
}
- , "PublicDashboardsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PublicDashboardInfo"},
- "type": "array","$ref": "#/components/schemas/PublicDashboardInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "PrivateFoldersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PrivateFolderInfo"},
+ "type": "array","$ref": "#/components/schemas/PrivateFolderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "PublicDashboardsInfo"
+ "title": "PrivateFoldersInfo"
}
- , "UpdatePublicDashboardRequest": {
- "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"description" : {"type": "string","title": "DESCRIPTION"},"layouts" : {"items": {"$ref": "#/components/schemas/Layout"},
- "type": "array","$ref": "#/components/schemas/Layout","title": "LAYOUTS"},"vars" : {"type": "object","title": "VARS"},"options" : {"type": "object","title": "OPTIONS"},"variables" : {"type": "object","title": "VARIABLES"},"variables_schema" : {"type": "object","title": "VARIABLES_SCHEMA"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"folder_id" : {"type": "string","title": "FOLDER_ID"}},
+ , "UpdatePrivateFolderRequest": {
+ "properties" : {"folder_id" : {"type": "string","title": "FOLDER_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["dashboard_id"],
- "title": "UpdatePublicDashboardRequest"
+ "required": ["folder_id"],
+ "title": "UpdatePrivateFolderRequest"
}
, "CreatePrivateDashboardRequest": {
"properties" : {"name" : {"type": "string","title": "NAME"},"description" : {"type": "string","title": "DESCRIPTION"},"layouts" : {"items": {"$ref": "#/components/schemas/Layout"},
@@ -2176,6 +2082,100 @@
"type": "object",
"required": ["dashboard_id"],
"title": "UpdatePrivateDashboardRequest"
+ }
+ , "CreatePrivateWidgetRequest": {
+ "properties" : {"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"widget_type" : {"type": "string","title": "WIDGET_TYPE"},"size" : {"type": "string","title": "SIZE"},"options" : {"type": "object","title": "OPTIONS"},"data_table_id" : {"type": "integer","title": "DATA_TABLE_ID"},"data_tables" : {"items": {"type": "object"},
+ "type": "array","title": "DATA_TABLES"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["dashboard_id"],
+ "title": "CreatePrivateWidgetRequest"
+ }
+ , "LoadPrivateWidgetRequest": {
+ "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"vars" : {"type": "object","title": "VARS"}},
+ "type": "object",
+ "required": ["widget_id","query"],
+ "title": "LoadPrivateWidgetRequest"
+ }
+ , "PrivateWidgetInfo": {
+ "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"widget_type" : {"type": "string","title": "WIDGET_TYPE"},"size" : {"type": "string","title": "SIZE"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["widget_id","name","state","description","widget_type","size","options","tags","domain_id","user_id","dashboard_id","data_table_id","created_at","updated_at"],
+ "title": "PrivateWidgetInfo"
+ }
+ , "PrivateWidgetQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"}},
+ "type": "object",
+ "required": ["dashboard_id"],
+ "title": "PrivateWidgetQuery"
+ }
+ , "PrivateWidgetRequest": {
+ "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"}},
+ "type": "object",
+ "required": ["widget_id"],
+ "title": "PrivateWidgetRequest"
+ }
+ , "PrivateWidgetsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PrivateWidgetInfo"},
+ "type": "array","$ref": "#/components/schemas/PrivateWidgetInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "PrivateWidgetsInfo"
+ }
+ , "UpdatePrivateWidgetRequest": {
+ "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"widget_type" : {"type": "string","title": "WIDGET_TYPE"},"size" : {"type": "string","title": "SIZE"},"options" : {"type": "object","title": "OPTIONS"},"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["widget_id"],
+ "title": "UpdatePrivateWidgetRequest"
+ }
+ , "AddPrivateDataTableRequest": {
+ "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"source_type" : {"type": "SourceType","title": "SOURCE_TYPE"},"options" : {"$ref": "#/components/schemas/AddOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["widget_id","source_type","options"],
+ "title": "AddPrivateDataTableRequest"
+ }
+ , "LoadPrivateDataTableRequest": {
+ "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"granularity" : {"type": "string","title": "GRANULARITY"},"start" : {"type": "string","title": "START"},"end" : {"type": "string","title": "END"},"sort" : {"items": {"$ref": "#/components/schemas/Sort"},
+ "type": "array","$ref": "#/components/schemas/Sort","title": "SORT"},"page" : {"$ref": "#/components/schemas/Page","title": "PAGE"}},
+ "type": "object",
+ "required": ["data_table_id","granularity"],
+ "title": "LoadPrivateDataTableRequest"
+ }
+ , "PrivateDataTableInfo": {
+ "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"name" : {"type": "string","title": "NAME"},"data_type" : {"type": "DataType","title": "DATA_TYPE"},"source_type" : {"type": "SourceType","title": "SOURCE_TYPE"},"operator" : {"type": "Operator","title": "OPERATOR"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"labels_info" : {"type": "object","title": "LABELS_INFO"},"data_info" : {"type": "object","title": "DATA_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"dashboard_id" : {"type": "string","title": "DASHBOARD_ID"},"widget_id" : {"type": "string","title": "WIDGET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["data_table_id","name","data_type","source_type","operator","options","tags","labels_info","data_info","domain_id","user_id","dashboard_id","widget_id","created_at","updated_at"],
+ "title": "PrivateDataTableInfo"
+ }
+ , "PrivateDataTableQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"widget_id" : {"type": "string","title": "WIDGET_ID"},"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"name" : {"type": "string","title": "NAME"},"data_type" : {"type": "DataType","title": "DATA_TYPE"},"source_type" : {"type": "SourceType","title": "SOURCE_TYPE"},"operator" : {"type": "Operator","title": "OPERATOR"}},
+ "type": "object",
+ "required": ["widget_id"],
+ "title": "PrivateDataTableQuery"
+ }
+ , "PrivateDataTableRequest": {
+ "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"}},
+ "type": "object",
+ "required": ["data_table_id"],
+ "title": "PrivateDataTableRequest"
+ }
+ , "PrivateDataTablesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PrivateDataTableInfo"},
+ "type": "array","$ref": "#/components/schemas/PrivateDataTableInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "PrivateDataTablesInfo"
+ }
+ , "TransformPrivateDataTableRequest": {
+ "properties" : {"widget_id" : {"type": "string","title": "WIDGET_ID"},"name" : {"type": "string","title": "NAME"},"operator" : {"type": "Operator","title": "OPERATOR"},"options" : {"$ref": "#/components/schemas/TransformOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["widget_id","operator","options"],
+ "title": "TransformPrivateDataTableRequest"
+ }
+ , "UpdatePrivateDataTableRequest": {
+ "properties" : {"data_table_id" : {"type": "string","title": "DATA_TABLE_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["data_table_id"],
+ "title": "UpdatePrivateDataTableRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/file_manager/v1/openapi.json b/dist/openapi/cloudforet/api/file_manager/v1/openapi.json
index 67f391ada..fcac409f7 100755
--- a/dist/openapi/cloudforet/api/file_manager/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/file_manager/v1/openapi.json
@@ -258,44 +258,6 @@
"required": ["file_id"],
"title": "UpdateFileRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
@@ -464,6 +426,44 @@
"type": "object",
"required": ["path","filter"],
"title": "Unwind"
+ }
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/identity/v1/openapi.json b/dist/openapi/cloudforet/api/identity/v1/openapi.json
index 2f4c3d633..e8ff381e2 100755
--- a/dist/openapi/cloudforet/api/identity/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/identity/v1/openapi.json
@@ -8,20 +8,20 @@
"title": "Identity API",
"version": "3.1.0"
},
- "paths":{"/identity/domain/update": {
+ "paths":{"/identity/user/create": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Update",
+ "tags": ["identity > user"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nYou can create user. after create user you have to binding role to user.\nSee role-binding create api.\nExternal type user do not need password.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |plugin_info||PluginInfo||\n |config||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |backend|LOCAL, EXTERNAL |string|True|\n |domain_id||string|True|\n |password|When backend is LOCAL, password is required. |string||\n |name||string||\n |email||string||\n |user_type|USER, API_USER |string||\n |language|en,ko |string||\n |timezone|UTC, Asia/Seoul |string||\n |tags||Struct||\n |reset_password|If reset_password is true, send email |boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"config" : {"type": "object","title": "CONFIG" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"user_type" : {"type": "string","title": "USER_TYPE" },"backend" : {"type": "string","title": "BACKEND" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"password\": \"password\",\n \"name\": \"Wonny\",\n \"email\": \"example@cloudforet.com\",\n \"user_type\": \"USER\",\n \"backend\": \"LOCAL\",\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -30,27 +30,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/change-auth-plugin": {
+ },"/identity/user/update": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Change Auth Plugin",
+ "tags": ["identity > user"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nUpdate user info by given user_id",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |plugin_info||PluginInfo||\n |release_auth_plugin||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |password||string||\n |name||string||\n |email||string||\n |language||string||\n |timezone||string||\n |tags||Struct||\n |reset_password||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"release_auth_plugin" : {"type": "boolean","title": "RELEASE_AUTH_PLUGIN" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
}
}
},"required": true
@@ -59,25 +61,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/update-plugin": {
+ },"/identity/user/verify-email": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Update Plugin",
+ "tags": ["identity > user"],
+ "summary": "Verify Email",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |email||string||\n |force||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"email" : {"type": "string","title": "EMAIL" },"force" : {"type": "boolean","title": "FORCE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -86,27 +90,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/verify-plugin": {
+ },"/identity/user/confirm-email": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Verify Plugin",
+ "tags": ["identity > user"],
+ "summary": "Confirm Email",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |verify_code||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"verify_code" : {"type": "string","title": "VERIFY_CODE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -115,21 +113,29 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/get": {
+ },"/identity/user/reset-password": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Get",
+ "tags": ["identity > user"],
+ "summary": "Reset Password",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -138,27 +144,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/role/create": {
+ }
+ },"/identity/user/set-required-actions": {
"post": {
- "tags": ["identity > role"],
- "summary": "Create",
+ "tags": ["identity > user"],
+ "summary": "Set Required Actions",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |role_type|SYSTEM, DOMAIN, PROJECT |string|True|\n |policies||array|True|\n |domain_id||string|True|\n |page_permissions||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |actions| |array|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"}, "type": "array","title": "POLICIES" },"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"}, "type": "array","title": "PAGE_PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"actions" : {"items": {}, "type": "array","title": "ACTIONS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -169,27 +169,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/update": {
+ },"/identity/user/enable-mfa": {
"post": {
- "tags": ["identity > role"],
- "summary": "Update",
+ "tags": ["identity > user"],
+ "summary": "Enable Mfa",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nEnable MFA for user. If this api is called, send email to user.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |domain_id||string|True|\n |name||string||\n |policies||array||\n |page_permissions||array||\n |tags||Struct||\n |release_page_permissions||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |mfa_type|EMAIL|string|True|\n |options|If mfa_type is EMAIL, email is required in options. options will be saved in mfa's options field.|Struct|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"}, "type": "array","title": "POLICIES" },"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"}, "type": "array","title": "PAGE_PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"release_page_permissions" : {"type": "boolean","title": "RELEASE_PAGE_PERMISSIONS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"mfa_type" : {"type": "string","title": "MFA_TYPE" },"options" : {"type": "object","title": "OPTIONS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"mfa_type\": \"EMAIL\",\n \"options\": {\"email\": \"wonny@cloudforet.com\"},\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
}
}
},"required": true
@@ -198,50 +200,60 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/delete": {
+ },"/identity/user/disable-mfa": {
"post": {
- "tags": ["identity > role"],
- "summary": "Delete",
+ "tags": ["identity > user"],
+ "summary": "Disable Mfa",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDisable MFA for user. If this api is called, send email to user.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |force|If this value true, disable MFA without verification for user. |boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"force" : {"type": "boolean","title": "FORCE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"force\": false,\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/get": {
+ },"/identity/user/confirm-mfa": {
"post": {
- "tags": ["identity > role"],
- "summary": "Get",
+ "tags": ["identity > user"],
+ "summary": "Confirm Mfa",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nConfirm MFA for user by given verify_code which is sent by your authentication method.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |verify_code||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"verify_code" : {"type": "string","title": "VERIFY_CODE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet\",\n \"verify_code\": \"123456\",\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
}
}
},"required": true
@@ -250,25 +262,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/list": {
+ },"/identity/user/enable": {
"post": {
- "tags": ["identity > role"],
- "summary": "List",
+ "tags": ["identity > user"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |role_id||string||\n |name||string||\n |role_type|SYSTEM, DOMAIN, PROJECT |string||\n |policy_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"policy_id" : {"type": "string","title": "POLICY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -279,25 +293,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RolesInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RolesInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/stat": {
+ },"/identity/user/disable": {
"post": {
- "tags": ["identity > role"],
- "summary": "Stat",
+ "tags": ["identity > user"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -308,25 +324,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/create": {
+ },"/identity/user/delete": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Create",
+ "tags": ["identity > user"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |resource_type||string|True|\n |resource_id||string|True|\n |role_id||string|True|\n |domain_id||string|True|\n |project_id||string||\n |project_group_id||string||\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"resource_id" : {"type": "string","title": "RESOURCE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -335,27 +353,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/update": {
+ },"/identity/user/get": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Update",
+ "tags": ["identity > user"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |domain_id||string|True|\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
},
"examples":{"Schema":{}
}
@@ -366,48 +378,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/delete": {
+ },"/identity/user/list": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Delete",
+ "tags": ["identity > user"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_id||string||\n |name||string||\n |state||string||\n |email||string||\n |user_type|USER, API_USER |string||\n |backend|LOCAL, EXTERNAL |string||\n |domain_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/get": {
- "post": {
- "tags": ["identity > role-binding"],
- "summary": "Get",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_id" : {"type": "string","title": "USER_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"email" : {"type": "string","title": "EMAIL" },"user_type" : {"type": "string","title": "USER_TYPE" },"backend" : {"type": "string","title": "BACKEND" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -418,25 +409,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/UsersInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UsersInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/list": {
+ },"/identity/user/stat": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "List",
+ "tags": ["identity > user"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |role_binding_id||string||\n |resource_type||string||\n |resource_id||string||\n |role_id||string||\n |role_type||string||\n |project_id||string||\n |project_group_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"resource_id" : {"type": "string","title": "RESOURCE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -447,25 +438,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingsInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/stat": {
+ },"/identity/user/find": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Stat",
+ "tags": ["identity > user"],
+ "summary": "Find",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |search||FindUserSearch|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"search" : {"$ref": "#/components/schemas/FindUserSearch","title": "SEARCH" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -476,25 +467,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/FindUsersInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/FindUsersInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/create": {
+ },"/identity/user/sync": {
"post": {
- "tags": ["identity > project"],
- "summary": "Create",
+ "tags": ["identity > user"],
+ "summary": "Sync",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |project_group_id||string|True|\n |domain_id||string|True|\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -505,25 +496,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
+ "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/update": {
+ },"/identity/token/issue": {
"post": {
- "tags": ["identity > project"],
- "summary": "Update",
+ "tags": ["identity > token"],
+ "summary": "Issue",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n |project_group_id||string||\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |credentials||Struct|True|\n |domain_id||string|True|\n |user_id||string||\n |user_type|LOCAL, EXTERNAL |string||\n |timeout||int||\n |refresh_count||int||\n |verify_code|if MFA is enabled, verify_code is required |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"credentials" : {"type": "object","title": "CREDENTIALS" },"user_type" : {"type": "string","title": "USER_TYPE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"timeout" : {"type": "integer","title": "TIMEOUT" },"refresh_count" : {"type": "integer","title": "REFRESH_COUNT" },"verify_code" : {"type": "string","title": "VERIFY_CODE" } }
},
"examples":{"Schema":{}
}
@@ -534,25 +527,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/TokenInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/TokenInfo"}}
}
}}
}
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/project/delete": {
+ }
+ },"/identity/token/refresh": {
"post": {
- "tags": ["identity > project"],
- "summary": "Delete",
+ "tags": ["identity > token"],
+ "summary": "Refresh",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": { }
},
"examples":{"Schema":{}
}
@@ -561,21 +554,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/TokenInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/TokenInfo"}}
+ }
+ }}
}
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/project/get": {
+ }
+ },"/identity/provider/create": {
"post": {
- "tags": ["identity > project"],
- "summary": "Get",
+ "tags": ["identity > provider"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |name||string|True|\n |template||Struct|True|\n |domain_id||string|True|\n |order||int||\n |metadata||Struct||\n |capability||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"order" : {"type": "integer","title": "ORDER" },"template" : {"type": "object","title": "TEMPLATE" },"metadata" : {"type": "object","title": "METADATA" },"capability" : {"type": "object","title": "CAPABILITY" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -586,25 +585,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/ProviderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/list": {
+ },"/identity/provider/update": {
"post": {
- "tags": ["identity > project"],
- "summary": "List",
+ "tags": ["identity > provider"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |project_id||string||\n |name||string||\n |project_group_id||string||\n |user_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |domain_id||string|True|\n |name||string||\n |order||int||\n |template||Struct||\n |metadata||Struct||\n |capability||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"name" : {"type": "string","title": "NAME" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"order" : {"type": "integer","title": "ORDER" },"template" : {"type": "object","title": "TEMPLATE" },"metadata" : {"type": "object","title": "METADATA" },"capability" : {"type": "object","title": "CAPABILITY" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -615,25 +614,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectsInfo"},
+ "schema": {"$ref": "#/components/schemas/ProviderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/stat": {
+ },"/identity/provider/delete": {
"post": {
- "tags": ["identity > project"],
- "summary": "Stat",
+ "tags": ["identity > provider"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -642,27 +641,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/add-member": {
+ },"/identity/provider/get": {
"post": {
- "tags": ["identity > project"],
- "summary": "Add Member",
+ "tags": ["identity > provider"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |role_id||string||\n |labels||array||\n |tags||Struct||\n |is_external_user||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"is_external_user" : {"type": "boolean","title": "IS_EXTERNAL_USER" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" },"only" : {"items": {}, "type": "array","title": "ONLY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -673,25 +666,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/ProviderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/modify-member": {
+ },"/identity/provider/list": {
"post": {
- "tags": ["identity > project"],
- "summary": "Modify Member",
+ "tags": ["identity > provider"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |provider||string||\n |name||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -702,25 +695,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/ProvidersInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProvidersInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/remove-member": {
+ },"/identity/provider/stat": {
"post": {
- "tags": ["identity > project"],
- "summary": "Remove Member",
+ "tags": ["identity > provider"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -729,21 +722,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/list-members": {
+ },"/identity/api-key/create": {
"post": {
- "tags": ["identity > project"],
- "summary": "List Members",
+ "tags": ["identity > api-key"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n |query||Query||\n |user_id||string||\n |role_id||string||\n |include_parent_member||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"include_parent_member" : {"type": "boolean","title": "INCLUDE_PARENT_MEMBER" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -754,25 +753,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectRoleBindingsInfo"},
+ "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectRoleBindingsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/create": {
+ },"/identity/api-key/enable": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Create",
+ "tags": ["identity > api-key"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |domain_id||string|True|\n |parent_project_group_id||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"parent_project_group_id" : {"type": "string","title": "PARENT_PROJECT_GROUP_ID" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -783,25 +782,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/update": {
+ },"/identity/api-key/disable": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Update",
+ "tags": ["identity > api-key"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |name||string||\n |parent_project_group_id||string||\n |release_parent_project_group||boolean||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"parent_project_group_id" : {"type": "string","title": "PARENT_PROJECT_GROUP_ID" },"release_parent_project_group" : {"type": "boolean","title": "RELEASE_PARENT_PROJECT_GROUP" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -812,25 +811,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/delete": {
+ },"/identity/api-key/delete": {
"post": {
- "tags": ["identity > project-group"],
+ "tags": ["identity > api-key"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -842,18 +841,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/get": {
+ },"/identity/api-key/get": {
"post": {
- "tags": ["identity > project-group"],
+ "tags": ["identity > api-key"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
},
"examples":{"Schema":{}
}
@@ -864,25 +863,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/list": {
+ },"/identity/api-key/list": {
"post": {
- "tags": ["identity > project-group"],
+ "tags": ["identity > api-key"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |project_group_id||string||\n |name||string||\n |parent_project_group_id||string||\n |author_within||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |api_key_id||string||\n |state|ENABLED, DISABLED |string||\n |user_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"parent_project_group_id" : {"type": "string","title": "PARENT_PROJECT_GROUP_ID" },"author_within" : {"type": "boolean","title": "AUTHOR_WITHIN" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"api_key_id" : {"type": "string","title": "API_KEY_ID" },"state" : {"type": "string","title": "STATE" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -893,16 +892,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"},
+ "schema": {"$ref": "#/components/schemas/APIKeysInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/APIKeysInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/stat": {
+ },"/identity/api-key/stat": {
"post": {
- "tags": ["identity > project-group"],
+ "tags": ["identity > api-key"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -929,18 +928,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/add-member": {
+ },"/identity/role-binding/create": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Add Member",
+ "tags": ["identity > role-binding"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |role_id||string||\n |labels||array||\n |tags||Struct||\n |is_external_user||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |resource_type||string|True|\n |resource_id||string|True|\n |role_id||string|True|\n |domain_id||string|True|\n |project_id||string||\n |project_group_id||string||\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"is_external_user" : {"type": "boolean","title": "IS_EXTERNAL_USER" } }
+ "properties": {"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"resource_id" : {"type": "string","title": "RESOURCE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -951,25 +950,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/modify-member": {
+ },"/identity/role-binding/update": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Modify Member",
+ "tags": ["identity > role-binding"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |domain_id||string|True|\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -980,25 +979,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/remove-member": {
+ },"/identity/role-binding/delete": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Remove Member",
+ "tags": ["identity > role-binding"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1010,18 +1009,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/list-members": {
+ },"/identity/role-binding/get": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "List Members",
+ "tags": ["identity > role-binding"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |query||Query||\n |user_id||string||\n |role_id||string||\n |include_parent_member||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"include_parent_member" : {"type": "boolean","title": "INCLUDE_PARENT_MEMBER" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
},
"examples":{"Schema":{}
}
@@ -1032,25 +1031,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingsInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/list-projects": {
+ },"/identity/role-binding/list": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "List Projects",
+ "tags": ["identity > role-binding"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |query||Query||\n |recursive||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |role_binding_id||string||\n |resource_type||string||\n |resource_id||string||\n |role_id||string||\n |role_type||string||\n |project_id||string||\n |project_group_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"recursive" : {"type": "boolean","title": "RECURSIVE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"resource_id" : {"type": "string","title": "RESOURCE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1061,25 +1060,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupProjectsInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupProjectsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/api-key/create": {
+ },"/identity/role-binding/stat": {
"post": {
- "tags": ["identity > api-key"],
- "summary": "Create",
+ "tags": ["identity > role-binding"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1090,25 +1089,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/api-key/enable": {
+ },"/identity/project-group/create": {
"post": {
- "tags": ["identity > api-key"],
- "summary": "Enable",
+ "tags": ["identity > project-group"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |domain_id||string|True|\n |parent_project_group_id||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"parent_project_group_id" : {"type": "string","title": "PARENT_PROJECT_GROUP_ID" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1119,25 +1118,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/api-key/disable": {
+ },"/identity/project-group/update": {
"post": {
- "tags": ["identity > api-key"],
- "summary": "Disable",
+ "tags": ["identity > project-group"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |name||string||\n |parent_project_group_id||string||\n |release_parent_project_group||boolean||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"parent_project_group_id" : {"type": "string","title": "PARENT_PROJECT_GROUP_ID" },"release_parent_project_group" : {"type": "boolean","title": "RELEASE_PARENT_PROJECT_GROUP" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1148,25 +1147,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/api-key/delete": {
+ },"/identity/project-group/delete": {
"post": {
- "tags": ["identity > api-key"],
+ "tags": ["identity > project-group"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1178,18 +1177,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/api-key/get": {
+ },"/identity/project-group/get": {
"post": {
- "tags": ["identity > api-key"],
+ "tags": ["identity > project-group"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |api_key_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"api_key_id" : {"type": "string","title": "API_KEY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
},
"examples":{"Schema":{}
}
@@ -1200,25 +1199,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/APIKeyInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/APIKeyInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/api-key/list": {
+ },"/identity/project-group/list": {
"post": {
- "tags": ["identity > api-key"],
+ "tags": ["identity > project-group"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |api_key_id||string||\n |state|ENABLED, DISABLED |string||\n |user_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |project_group_id||string||\n |name||string||\n |parent_project_group_id||string||\n |author_within||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"api_key_id" : {"type": "string","title": "API_KEY_ID" },"state" : {"type": "string","title": "STATE" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"parent_project_group_id" : {"type": "string","title": "PARENT_PROJECT_GROUP_ID" },"author_within" : {"type": "boolean","title": "AUTHOR_WITHIN" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1229,16 +1228,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/APIKeysInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/APIKeysInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/api-key/stat": {
+ },"/identity/project-group/stat": {
"post": {
- "tags": ["identity > api-key"],
+ "tags": ["identity > project-group"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -1265,18 +1264,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/create": {
+ },"/identity/project-group/add-member": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Create",
+ "tags": ["identity > project-group"],
+ "summary": "Add Member",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |name||string|True|\n |template||Struct|True|\n |domain_id||string|True|\n |order||int||\n |metadata||Struct||\n |capability||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |role_id||string||\n |labels||array||\n |tags||Struct||\n |is_external_user||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"order" : {"type": "integer","title": "ORDER" },"template" : {"type": "object","title": "TEMPLATE" },"metadata" : {"type": "object","title": "METADATA" },"capability" : {"type": "object","title": "CAPABILITY" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"is_external_user" : {"type": "boolean","title": "IS_EXTERNAL_USER" } }
},
"examples":{"Schema":{}
}
@@ -1287,25 +1286,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/update": {
+ },"/identity/project-group/modify-member": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Update",
+ "tags": ["identity > project-group"],
+ "summary": "Modify Member",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |domain_id||string|True|\n |name||string||\n |order||int||\n |template||Struct||\n |metadata||Struct||\n |capability||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"order" : {"type": "integer","title": "ORDER" },"template" : {"type": "object","title": "TEMPLATE" },"metadata" : {"type": "object","title": "METADATA" },"capability" : {"type": "object","title": "CAPABILITY" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1316,25 +1315,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/delete": {
+ },"/identity/project-group/remove-member": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Delete",
+ "tags": ["identity > project-group"],
+ "summary": "Remove Member",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1346,18 +1345,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/get": {
+ },"/identity/project-group/list-members": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Get",
+ "tags": ["identity > project-group"],
+ "summary": "List Members",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |query||Query||\n |user_id||string||\n |role_id||string||\n |include_parent_member||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" },"only" : {"items": {}, "type": "array","title": "ONLY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"include_parent_member" : {"type": "boolean","title": "INCLUDE_PARENT_MEMBER" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1368,25 +1367,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupRoleBindingsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/list": {
+ },"/identity/project-group/list-projects": {
"post": {
- "tags": ["identity > provider"],
- "summary": "List",
+ "tags": ["identity > project-group"],
+ "summary": "List Projects",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |provider||string||\n |name||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |domain_id||string|True|\n |query||Query||\n |recursive||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"recursive" : {"type": "boolean","title": "RECURSIVE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1397,25 +1396,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProvidersInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupProjectsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProvidersInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupProjectsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/stat": {
+ },"/identity/domain/update": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Stat",
+ "tags": ["identity > domain"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |plugin_info||PluginInfo||\n |config||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"config" : {"type": "object","title": "CONFIG" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1426,25 +1425,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/endpoint/list": {
+ },"/identity/domain/change-auth-plugin": {
"post": {
- "tags": ["identity > endpoint"],
- "summary": "List",
+ "tags": ["identity > domain"],
+ "summary": "Change Auth Plugin",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |service||string||\n |endpoint_type|example: public | internal |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |plugin_info||PluginInfo||\n |release_auth_plugin||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"service" : {"type": "string","title": "SERVICE" },"endpoint_type" : {"type": "string","title": "ENDPOINT_TYPE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"release_auth_plugin" : {"type": "boolean","title": "RELEASE_AUTH_PLUGIN" } }
},
"examples":{"Schema":{}
}
@@ -1455,25 +1454,106 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EndpointsInfo"},
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EndpointsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/policy/create": {
+ },"/identity/domain/update-plugin": {
"post": {
- "tags": ["identity > policy"],
+ "tags": ["identity > domain"],
+ "summary": "Update Plugin",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/domain/verify-plugin": {
+ "post": {
+ "tags": ["identity > domain"],
+ "summary": "Verify Plugin",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response"}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/domain/get": {
+ "post": {
+ "tags": ["identity > domain"],
+ "summary": "Get",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |only||array||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/role/create": {
+ "post": {
+ "tags": ["identity > role"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |permissions||array|True|\n |domain_id||string|True|\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |role_type|SYSTEM, DOMAIN, PROJECT |string|True|\n |policies||array|True|\n |domain_id||string|True|\n |page_permissions||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"}, "type": "array","title": "POLICIES" },"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"}, "type": "array","title": "PAGE_PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1484,25 +1564,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PolicyInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PolicyInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/policy/update": {
+ },"/identity/role/update": {
"post": {
- "tags": ["identity > policy"],
+ "tags": ["identity > role"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |policy_id||string|True|\n |domain_id||string|True|\n |name||string||\n |permissions||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |domain_id||string|True|\n |name||string||\n |policies||array||\n |page_permissions||array||\n |tags||Struct||\n |release_page_permissions||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"policy_id" : {"type": "string","title": "POLICY_ID" },"name" : {"type": "string","title": "NAME" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"}, "type": "array","title": "POLICIES" },"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"}, "type": "array","title": "PAGE_PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"release_page_permissions" : {"type": "boolean","title": "RELEASE_PAGE_PERMISSIONS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1513,25 +1593,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PolicyInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PolicyInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/policy/delete": {
+ },"/identity/role/delete": {
"post": {
- "tags": ["identity > policy"],
+ "tags": ["identity > role"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |policy_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"policy_id" : {"type": "string","title": "POLICY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1543,18 +1623,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/policy/get": {
+ },"/identity/role/get": {
"post": {
- "tags": ["identity > policy"],
+ "tags": ["identity > role"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |policy_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"policy_id" : {"type": "string","title": "POLICY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
},
"examples":{"Schema":{}
}
@@ -1565,25 +1645,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PolicyInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PolicyInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/policy/list": {
+ },"/identity/role/list": {
"post": {
- "tags": ["identity > policy"],
+ "tags": ["identity > role"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |policy_id||string||\n |name||string||\n |domain_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |role_id||string||\n |name||string||\n |role_type|SYSTEM, DOMAIN, PROJECT |string||\n |policy_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"policy_id" : {"type": "string","title": "POLICY_ID" },"name" : {"type": "string","title": "NAME" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"policy_id" : {"type": "string","title": "POLICY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1594,16 +1674,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PoliciesInfo"},
+ "schema": {"$ref": "#/components/schemas/RolesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PoliciesInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RolesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/policy/stat": {
+ },"/identity/role/stat": {
"post": {
- "tags": ["identity > policy"],
+ "tags": ["identity > role"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -1630,6 +1710,93 @@
}}
}
,"security": [{"HTTPBearer": []}] }
+ },"/identity/domain-owner/update": {
+ "post": {
+ "tags": ["identity > domain-owner"],
+ "summary": "Update",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |owner_id||string|True|\n |domain_id||string|True|\n |password||string||\n |name||string||\n |email||string||\n |language||string||\n |timezone||string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"owner_id" : {"type": "string","title": "OWNER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/DomainOwnerInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/DomainOwnerInfo"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/domain-owner/get": {
+ "post": {
+ "tags": ["identity > domain-owner"],
+ "summary": "Get",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |owner_id||string|True|\n |only||array||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"owner_id" : {"type": "string","title": "OWNER_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/DomainOwnerInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/DomainOwnerInfo"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/endpoint/list": {
+ "post": {
+ "tags": ["identity > endpoint"],
+ "summary": "List",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |service||string||\n |endpoint_type|example: public | internal |string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"service" : {"type": "string","title": "SERVICE" },"endpoint_type" : {"type": "string","title": "ENDPOINT_TYPE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/EndpointsInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/EndpointsInfo"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
},"/identity/service-account/create": {
"post": {
"tags": ["identity > service-account"],
@@ -1798,20 +1965,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/create": {
+ },"/identity/project/create": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > project"],
"summary": "Create",
"operationId" : "",
- "description": "### Description \nYou can create user. after create user you have to binding role to user.\nSee role-binding create api.\nExternal type user do not need password.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |backend|LOCAL, EXTERNAL |string|True|\n |domain_id||string|True|\n |password|When backend is LOCAL, password is required. |string||\n |name||string||\n |email||string||\n |user_type|USER, API_USER |string||\n |language|en,ko |string||\n |timezone|UTC, Asia/Seoul |string||\n |tags||Struct||\n |reset_password|If reset_password is true, send email |boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |project_group_id||string|True|\n |domain_id||string|True|\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"user_type" : {"type": "string","title": "USER_TYPE" },"backend" : {"type": "string","title": "BACKEND" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"password\": \"password\",\n \"name\": \"Wonny\",\n \"email\": \"example@cloudforet.com\",\n \"user_type\": \"USER\",\n \"backend\": \"LOCAL\",\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\"\n }\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1820,29 +1987,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/update": {
+ },"/identity/project/update": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > project"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdate user info by given user_id",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |password||string||\n |name||string||\n |email||string||\n |language||string||\n |timezone||string||\n |tags||Struct||\n |reset_password||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n |project_group_id||string||\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1851,27 +2016,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/verify-email": {
+ },"/identity/project/delete": {
"post": {
- "tags": ["identity > user"],
- "summary": "Verify Email",
+ "tags": ["identity > project"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |email||string||\n |force||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"email" : {"type": "string","title": "EMAIL" },"force" : {"type": "boolean","title": "FORCE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1883,18 +2046,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/confirm-email": {
+ },"/identity/project/get": {
"post": {
- "tags": ["identity > user"],
- "summary": "Confirm Email",
+ "tags": ["identity > project"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |verify_code||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"verify_code" : {"type": "string","title": "VERIFY_CODE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
},
"examples":{"Schema":{}
}
@@ -1905,50 +2068,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/reset-password": {
- "post": {
- "tags": ["identity > user"],
- "summary": "Reset Password",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- }
- },"/identity/user/set-required-actions": {
+ },"/identity/project/list": {
"post": {
- "tags": ["identity > user"],
- "summary": "Set Required Actions",
+ "tags": ["identity > project"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |actions| |array|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |query||Query||\n |project_id||string||\n |name||string||\n |project_group_id||string||\n |user_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"actions" : {"items": {}, "type": "array","title": "ACTIONS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"name" : {"type": "string","title": "NAME" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -1959,29 +2097,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/enable-mfa": {
+ },"/identity/project/stat": {
"post": {
- "tags": ["identity > user"],
- "summary": "Enable Mfa",
+ "tags": ["identity > project"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nEnable MFA for user. If this api is called, send email to user.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |mfa_type|EMAIL|string|True|\n |options|If mfa_type is EMAIL, email is required in options. options will be saved in mfa's options field.|Struct|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"mfa_type" : {"type": "string","title": "MFA_TYPE" },"options" : {"type": "object","title": "OPTIONS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"mfa_type\": \"EMAIL\",\n \"options\": {\"email\": \"wonny@cloudforet.com\"},\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1990,29 +2126,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/disable-mfa": {
+ },"/identity/project/add-member": {
"post": {
- "tags": ["identity > user"],
- "summary": "Disable Mfa",
+ "tags": ["identity > project"],
+ "summary": "Add Member",
"operationId" : "",
- "description": "### Description \nDisable MFA for user. If this api is called, send email to user.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |force|If this value true, disable MFA without verification for user. |boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |role_id||string||\n |labels||array||\n |tags||Struct||\n |is_external_user||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"force" : {"type": "boolean","title": "FORCE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"is_external_user" : {"type": "boolean","title": "IS_EXTERNAL_USER" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"force\": false,\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2021,29 +2155,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/confirm-mfa": {
+ },"/identity/project/modify-member": {
"post": {
- "tags": ["identity > user"],
- "summary": "Confirm Mfa",
+ "tags": ["identity > project"],
+ "summary": "Modify Member",
"operationId" : "",
- "description": "### Description \nConfirm MFA for user by given verify_code which is sent by your authentication method.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |verify_code||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"verify_code" : {"type": "string","title": "VERIFY_CODE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet\",\n \"verify_code\": \"123456\",\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2052,27 +2184,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/enable": {
+ },"/identity/project/remove-member": {
"post": {
- "tags": ["identity > user"],
- "summary": "Enable",
+ "tags": ["identity > project"],
+ "summary": "Remove Member",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |user_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2081,29 +2211,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/disable": {
+ },"/identity/project/list-members": {
"post": {
- "tags": ["identity > user"],
- "summary": "Disable",
+ "tags": ["identity > project"],
+ "summary": "List Members",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |domain_id||string|True|\n |query||Query||\n |user_id||string||\n |role_id||string||\n |include_parent_member||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"include_parent_member" : {"type": "boolean","title": "INCLUDE_PARENT_MEMBER" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2114,27 +2236,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectRoleBindingsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectRoleBindingsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/delete": {
+ },"/identity/policy/create": {
"post": {
- "tags": ["identity > user"],
- "summary": "Delete",
+ "tags": ["identity > policy"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |permissions||array|True|\n |domain_id||string|True|\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2143,21 +2263,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/PolicyInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/PolicyInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/get": {
+ },"/identity/policy/update": {
"post": {
- "tags": ["identity > user"],
- "summary": "Get",
+ "tags": ["identity > policy"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |policy_id||string|True|\n |domain_id||string|True|\n |name||string||\n |permissions||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
+ "properties": {"policy_id" : {"type": "string","title": "POLICY_ID" },"name" : {"type": "string","title": "NAME" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"tags" : {"type": "object","title": "TAGS" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2168,27 +2294,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/PolicyInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/PolicyInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/list": {
+ },"/identity/policy/delete": {
"post": {
- "tags": ["identity > user"],
- "summary": "List",
+ "tags": ["identity > policy"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_id||string||\n |name||string||\n |state||string||\n |email||string||\n |user_type|USER, API_USER |string||\n |backend|LOCAL, EXTERNAL |string||\n |domain_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |policy_id||string|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_id" : {"type": "string","title": "USER_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"email" : {"type": "string","title": "EMAIL" },"user_type" : {"type": "string","title": "USER_TYPE" },"backend" : {"type": "string","title": "BACKEND" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"policy_id" : {"type": "string","title": "POLICY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2197,27 +2321,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/UsersInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/UsersInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/stat": {
+ },"/identity/policy/get": {
"post": {
- "tags": ["identity > user"],
- "summary": "Stat",
+ "tags": ["identity > policy"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |policy_id||string|True|\n |domain_id||string|True|\n |only||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"policy_id" : {"type": "string","title": "POLICY_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
},
"examples":{"Schema":{}
}
@@ -2228,25 +2346,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/PolicyInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/PolicyInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/find": {
+ },"/identity/policy/list": {
"post": {
- "tags": ["identity > user"],
- "summary": "Find",
+ "tags": ["identity > policy"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |search||FindUserSearch|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |policy_id||string||\n |name||string||\n |domain_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"search" : {"$ref": "#/components/schemas/FindUserSearch","title": "SEARCH" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"policy_id" : {"type": "string","title": "POLICY_ID" },"name" : {"type": "string","title": "NAME" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2257,25 +2375,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/FindUsersInfo"},
+ "schema": {"$ref": "#/components/schemas/PoliciesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/FindUsersInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PoliciesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/sync": {
+ },"/identity/policy/stat": {
"post": {
- "tags": ["identity > user"],
- "summary": "Sync",
+ "tags": ["identity > policy"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2286,240 +2404,135 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"},"Default Example":{
- "value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"name\": \"Wonny\",\n \"state\": \"ENABLED\",\n \"email\": \"Wonny@cloudforet.com\",\n \"email_verified\" : true,\n \"mfa\": {\n \"mfa_type\": \"EMAIL\",\n \"state\" : \"ENABLED\",\n \"options\": {\n \"email\": \"example@cloudforet.com\"\n }\n },\n \"language\": \"en\",\n \"timezone\": \"UTC\",\n \"tags\": {\n \"Department\": \"Development\",\n \"Role\"\n },\n \"last_accessed_at\": \"2023-01-01T07:12:41.890Z\"\n \"created_at\": \"2023-01-01T15:23:31.705Z\"\n \"domain_id\": \"domain-xxxxxxxxxxxx\"\n}"
- }}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/domain-owner/update": {
- "post": {
- "tags": ["identity > domain-owner"],
- "summary": "Update",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |owner_id||string|True|\n |domain_id||string|True|\n |password||string||\n |name||string||\n |email||string||\n |language||string||\n |timezone||string||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"owner_id" : {"type": "string","title": "OWNER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/DomainOwnerInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/DomainOwnerInfo"}}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/domain-owner/get": {
- "post": {
- "tags": ["identity > domain-owner"],
- "summary": "Get",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |owner_id||string|True|\n |only||array||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"owner_id" : {"type": "string","title": "OWNER_ID" },"only" : {"items": {}, "type": "array","title": "ONLY" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/DomainOwnerInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainOwnerInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/token/issue": {
- "post": {
- "tags": ["identity > token"],
- "summary": "Issue",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |credentials||Struct|True|\n |domain_id||string|True|\n |user_id||string||\n |user_type|LOCAL, EXTERNAL |string||\n |timeout||int||\n |refresh_count||int||\n |verify_code|if MFA is enabled, verify_code is required |string||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"credentials" : {"type": "object","title": "CREDENTIALS" },"user_type" : {"type": "string","title": "USER_TYPE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"timeout" : {"type": "integer","title": "TIMEOUT" },"refresh_count" : {"type": "integer","title": "REFRESH_COUNT" },"verify_code" : {"type": "string","title": "VERIFY_CODE" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/TokenInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/TokenInfo"}}
- }
- }}
- }
- }
- },"/identity/token/refresh": {
- "post": {
- "tags": ["identity > token"],
- "summary": "Refresh",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "
",
- "content": {
- "application/json": {
- "schema": {
- "properties": { }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/TokenInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/TokenInfo"}}
- }
- }}
- }
- }
},"securitySchemes": {"HTTPBearer": {"type": "http","scheme": "bearer","bearerFormat": "JWT"}}
},
"components":{
"schemas": {
- "ChangeAuthRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"release_auth_plugin" : {"type": "boolean","title": "RELEASE_AUTH_PLUGIN"}},
+ "ConfirmEmailRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"verify_code" : {"type": "string","title": "VERIFY_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id"],
- "title": "ChangeAuthRequest"
+ "required": ["user_id","verify_code","domain_id"],
+ "title": "ConfirmEmailRequest"
}
- , "CreateDomainRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"config" : {"type": "object","title": "CONFIG"},"tags" : {"type": "object","title": "TAGS"}},
+ , "ConfirmMFARequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"verify_code" : {"type": "string","title": "VERIFY_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["name"],
- "title": "CreateDomainRequest"
+ "required": ["user_id","verify_code","domain_id"],
+ "title": "ConfirmMFARequest"
}
- , "DomainInfo": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"config" : {"type": "object","title": "CONFIG"},"tags" : {"type": "object","title": "TAGS"},"created_at" : {"type": "string","title": "CREATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
+ , "CreateUserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"user_type" : {"type": "string","title": "USER_TYPE"},"backend" : {"type": "string","title": "BACKEND"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
"type": "object",
- "required": ["domain_id","name","state","plugin_info","config","tags","created_at","deleted_at"],
- "title": "DomainInfo"
+ "required": ["user_id","backend","domain_id"],
+ "title": "CreateUserRequest"
}
- , "DomainQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"}},
+ , "DisableMFARequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"force" : {"type": "boolean","title": "FORCE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": [],
- "title": "DomainQuery"
+ "required": ["user_id","domain_id"],
+ "title": "DisableMFARequest"
}
- , "DomainRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "EnableMFARequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"mfa_type" : {"type": "string","title": "MFA_TYPE"},"options" : {"type": "object","title": "OPTIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id"],
- "title": "DomainRequest"
+ "required": ["user_id","mfa_type","options","domain_id"],
+ "title": "EnableMFARequest"
}
- , "DomainStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "FindUserInfo": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["query"],
- "title": "DomainStatQuery"
+ "required": ["user_id","name","email","tags"],
+ "title": "FindUserInfo"
}
- , "DomainsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DomainInfo"},
- "type": "array","$ref": "#/components/schemas/DomainInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "FindUserQuery": {
+ "properties" : {"search" : {"$ref": "#/components/schemas/FindUserSearch","title": "SEARCH"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["search","domain_id"],
+ "title": "FindUserQuery"
+ }
+ , "FindUserSearch": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"keyword" : {"type": "string","title": "KEYWORD"}},
+ "type": "object",
+ "required": ["user_id","keyword"],
+ "title": "FindUserSearch"
+ }
+ , "FindUsersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/FindUserInfo"},
+ "type": "array","$ref": "#/components/schemas/FindUserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "DomainsInfo"
+ "title": "FindUsersInfo"
}
- , "GetDomainRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
+ , "GetUserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
"type": "array","title": "ONLY"}},
"type": "object",
- "required": ["domain_id"],
- "title": "GetDomainRequest"
+ "required": ["user_id","domain_id"],
+ "title": "GetUserRequest"
}
- , "PluginInfo": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"secret_id" : {"type": "string","title": "SECRET_ID"},"options" : {"type": "object","title": "OPTIONS"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"metadata" : {"type": "object","title": "METADATA"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
+ , "MFA": {
+ "properties" : {"state" : {"type": "string","title": "STATE"},"mfa_type" : {"type": "string","title": "MFA_TYPE"},"options" : {"type": "object","title": "OPTIONS"}},
"type": "object",
- "required": ["plugin_id","version","secret_id","options","secret_data","schema_id","metadata","upgrade_mode"],
- "title": "PluginInfo"
+ "required": ["state","mfa_type","options"],
+ "title": "MFA"
}
- , "UpdateDomainRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"config" : {"type": "object","title": "CONFIG"},"tags" : {"type": "object","title": "TAGS"}},
+ , "SetRequiredActionsRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"actions" : {"items": {"type": "string"},
+ "type": "array","title": "ACTIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id"],
- "title": "UpdateDomainRequest"
+ "required": ["user_id","actions","domain_id"],
+ "title": "SetRequiredActionsRequest"
}
- , "UpdatePluginRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
+ , "UpdateUserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
"type": "object",
- "required": ["domain_id"],
- "title": "UpdatePluginRequest"
+ "required": ["user_id","domain_id"],
+ "title": "UpdateUserRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UserInfo": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"user_type" : {"type": "string","title": "USER_TYPE"},"backend" : {"type": "string","title": "BACKEND"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"required_actions" : {"items": {"type": "string"},
+ "type": "array","title": "REQUIRED_ACTIONS"},"tags" : {"type": "object","title": "TAGS"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"},"created_at" : {"type": "string","title": "CREATED_AT"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"email_verified" : {"type": "boolean","title": "EMAIL_VERIFIED"},"mfa" : {"$ref": "#/components/schemas/MFA","title": "MFA"}},
"type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
+ "required": ["user_id","name","state","email","user_type","backend","language","timezone","required_actions","tags","last_accessed_at","created_at","domain_id","email_verified","mfa"],
+ "title": "UserInfo"
}
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ , "UserQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"user_type" : {"type": "string","title": "USER_TYPE"},"backend" : {"type": "string","title": "BACKEND"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
+ "required": [],
+ "title": "UserQuery"
}
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "string","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ , "UserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
+ "required": ["user_id","domain_id"],
+ "title": "UserRequest"
}
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
+ , "UserStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
+ "required": ["query","domain_id"],
+ "title": "UserStatQuery"
}
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ , "UsersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserInfo"},
+ "type": "array","$ref": "#/components/schemas/UserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
+ "required": ["results","total_count"],
+ "title": "UsersInfo"
}
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ , "VerifyEmailRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"email" : {"type": "string","title": "EMAIL"},"force" : {"type": "boolean","title": "FORCE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["version"],
- "title": "VersionInfo"
+ "required": ["user_id","domain_id"],
+ "title": "VerifyEmailRequest"
}
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
@@ -2690,210 +2703,199 @@
"required": ["path","filter"],
"title": "Unwind"
}
- , "CreateRoleRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"},
- "type": "array","$ref": "#/components/schemas/RolePolicy","title": "POLICIES"},"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"},
- "type": "array","$ref": "#/components/schemas/PagePermission","title": "PAGE_PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["name","role_type","policies","domain_id"],
- "title": "CreateRoleRequest"
- }
- , "GetRoleRequest": {
- "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"}},
- "type": "object",
- "required": ["role_id","domain_id"],
- "title": "GetRoleRequest"
- }
- , "PagePermission": {
- "properties" : {"page" : {"type": "string","title": "PAGE"},"permission" : {"type": "string","title": "PERMISSION"}},
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["page","permission"],
- "title": "PagePermission"
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
}
- , "RoleInfo": {
- "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"},
- "type": "array","$ref": "#/components/schemas/RolePolicy","title": "POLICIES"},"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"},
- "type": "array","$ref": "#/components/schemas/PagePermission","title": "PAGE_PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
"type": "object",
- "required": ["role_id","name","role_type","policies","page_permissions","tags","domain_id","created_at","deleted_at"],
- "title": "RoleInfo"
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
}
- , "RolePolicy": {
- "properties" : {"policy_type" : {"type": "string","title": "POLICY_TYPE"},"policy_id" : {"type": "string","title": "POLICY_ID"}},
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "string","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
"type": "object",
- "required": ["policy_type","policy_id"],
- "title": "RolePolicy"
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
}
- , "RoleQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"policy_id" : {"type": "string","title": "POLICY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
"type": "object",
- "required": ["domain_id"],
- "title": "RoleQuery"
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
}
- , "RoleRequest": {
- "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
"type": "object",
- "required": ["role_id","domain_id"],
- "title": "RoleRequest"
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
}
- , "RoleStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["query","domain_id"],
- "title": "RoleStatQuery"
+ "required": ["version"],
+ "title": "VersionInfo"
}
- , "RolesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleInfo"},
- "type": "array","$ref": "#/components/schemas/RoleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "IssueTokenRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"credentials" : {"type": "object","title": "CREDENTIALS"},"user_type" : {"type": "string","title": "USER_TYPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"timeout" : {"type": "integer","title": "TIMEOUT"},"refresh_count" : {"type": "integer","title": "REFRESH_COUNT"},"verify_code" : {"type": "string","title": "VERIFY_CODE"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "RolesInfo"
+ "required": ["credentials","domain_id"],
+ "title": "IssueTokenRequest"
}
- , "UpdateRoleRequest": {
- "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"},
- "type": "array","$ref": "#/components/schemas/RolePolicy","title": "POLICIES"},"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"},
- "type": "array","$ref": "#/components/schemas/PagePermission","title": "PAGE_PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"release_page_permissions" : {"type": "boolean","title": "RELEASE_PAGE_PERMISSIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "TokenInfo": {
+ "properties" : {"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"refresh_token" : {"type": "string","title": "REFRESH_TOKEN"}},
"type": "object",
- "required": ["role_id","domain_id"],
- "title": "UpdateRoleRequest"
+ "required": ["access_token","refresh_token"],
+ "title": "TokenInfo"
}
- , "CreateRoleBindingRequest": {
- "properties" : {"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "CreateProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"template" : {"type": "object","title": "TEMPLATE"},"metadata" : {"type": "object","title": "METADATA"},"capability" : {"type": "object","title": "CAPABILITY"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["resource_type","resource_id","role_id","domain_id"],
- "title": "CreateRoleBindingRequest"
+ "required": ["provider","name","template","domain_id"],
+ "title": "CreateProviderRequest"
}
- , "GetRoleBindingRequest": {
- "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"}},
+ , "GetProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["role_binding_id","domain_id"],
- "title": "GetRoleBindingRequest"
+ "required": ["provider","domain_id"],
+ "title": "GetProviderRequest"
}
- , "RoleBindingInfo": {
- "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"role_info" : {"$ref": "#/components/schemas/RoleInfo","title": "ROLE_INFO"},"project_info" : {"$ref": "#/components/schemas/ProjectInfo","title": "PROJECT_INFO"},"project_group_info" : {"$ref": "#/components/schemas/ProjectGroupInfo","title": "PROJECT_GROUP_INFO"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "ProviderInfo": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"template" : {"type": "object","title": "TEMPLATE"},"metadata" : {"type": "object","title": "METADATA"},"capability" : {"type": "object","title": "CAPABILITY"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["role_binding_id","resource_type","resource_id","role_info","project_info","project_group_info","labels","tags","domain_id","created_at"],
- "title": "RoleBindingInfo"
+ "required": ["provider","name","order","template","metadata","capability","tags","domain_id","created_at"],
+ "title": "ProviderInfo"
}
- , "RoleBindingQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "ProviderQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
"required": ["domain_id"],
- "title": "RoleBindingQuery"
+ "title": "ProviderQuery"
}
- , "RoleBindingRequest": {
- "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "ProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["role_binding_id","domain_id"],
- "title": "RoleBindingRequest"
+ "required": ["provider","domain_id"],
+ "title": "ProviderRequest"
}
- , "RoleBindingStatQuery": {
+ , "ProviderStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
"required": ["query","domain_id"],
- "title": "RoleBindingStatQuery"
+ "title": "ProviderStatQuery"
}
- , "RoleBindingsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleBindingInfo"},
- "type": "array","$ref": "#/components/schemas/RoleBindingInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "ProvidersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProviderInfo"},
+ "type": "array","$ref": "#/components/schemas/ProviderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "RoleBindingsInfo"
+ "title": "ProvidersInfo"
}
- , "UpdateRoleBindingRequest": {
- "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UpdateProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"template" : {"type": "object","title": "TEMPLATE"},"metadata" : {"type": "object","title": "METADATA"},"capability" : {"type": "object","title": "CAPABILITY"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["role_binding_id","domain_id"],
- "title": "UpdateRoleBindingRequest"
+ "required": ["provider","domain_id"],
+ "title": "UpdateProviderRequest"
}
- , "AddProjectMemberRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"is_external_user" : {"type": "boolean","title": "IS_EXTERNAL_USER"}},
+ , "APIKeyInfo": {
+ "properties" : {"api_key_id" : {"type": "string","title": "API_KEY_ID"},"api_key" : {"type": "string","title": "API_KEY"},"state" : {"type": "string","title": "STATE"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["project_id","user_id","domain_id"],
- "title": "AddProjectMemberRequest"
+ "required": ["api_key_id","api_key","state","user_id","domain_id","last_accessed_at","created_at"],
+ "title": "APIKeyInfo"
}
- , "CreateProjectRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "APIKeyQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"api_key_id" : {"type": "string","title": "API_KEY_ID"},"state" : {"type": "string","title": "STATE"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["name","project_group_id","domain_id"],
- "title": "CreateProjectRequest"
+ "required": ["domain_id"],
+ "title": "APIKeyQuery"
}
- , "GetProjectRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"}},
+ , "APIKeyRequest": {
+ "properties" : {"api_key_id" : {"type": "string","title": "API_KEY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["project_id","domain_id"],
- "title": "GetProjectRequest"
+ "required": ["api_key_id","domain_id"],
+ "title": "APIKeyRequest"
}
- , "ModifyProjectMemberRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "APIKeyStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["project_id","user_id","domain_id"],
- "title": "ModifyProjectMemberRequest"
+ "required": ["query","domain_id"],
+ "title": "APIKeyStatQuery"
}
- , "ProjectInfo": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"project_group_info" : {"$ref": "#/components/schemas/ProjectGroupInfo","title": "PROJECT_GROUP_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_by" : {"type": "string","title": "CREATED_BY"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "APIKeysInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/APIKeyInfo"},
+ "type": "array","$ref": "#/components/schemas/APIKeyInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["project_id","name","tags","project_group_info","domain_id","created_by","created_at"],
- "title": "ProjectInfo"
+ "required": ["results","total_count"],
+ "title": "APIKeysInfo"
}
- , "ProjectMemberQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"include_parent_member" : {"type": "boolean","title": "INCLUDE_PARENT_MEMBER"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "CreateAPIKeyRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["project_id","domain_id"],
- "title": "ProjectMemberQuery"
+ "required": ["user_id","domain_id"],
+ "title": "CreateAPIKeyRequest"
}
- , "ProjectQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "GetAPIKeyRequest": {
+ "properties" : {"api_key_id" : {"type": "string","title": "API_KEY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"}},
+ "type": "object",
+ "required": ["api_key_id","domain_id"],
+ "title": "GetAPIKeyRequest"
+ }
+ , "CreateRoleBindingRequest": {
+ "properties" : {"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id"],
- "title": "ProjectQuery"
+ "required": ["resource_type","resource_id","role_id","domain_id"],
+ "title": "CreateRoleBindingRequest"
}
- , "ProjectRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "GetRoleBindingRequest": {
+ "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"}},
"type": "object",
- "required": ["project_id","domain_id"],
- "title": "ProjectRequest"
+ "required": ["role_binding_id","domain_id"],
+ "title": "GetRoleBindingRequest"
}
- , "ProjectRoleBindingInfo": {
+ , "RoleBindingInfo": {
"properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"role_info" : {"$ref": "#/components/schemas/RoleInfo","title": "ROLE_INFO"},"project_info" : {"$ref": "#/components/schemas/ProjectInfo","title": "PROJECT_INFO"},"project_group_info" : {"$ref": "#/components/schemas/ProjectGroupInfo","title": "PROJECT_GROUP_INFO"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
"required": ["role_binding_id","resource_type","resource_id","role_info","project_info","project_group_info","labels","tags","domain_id","created_at"],
- "title": "ProjectRoleBindingInfo"
+ "title": "RoleBindingInfo"
}
- , "ProjectRoleBindingsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"},
- "type": "array","$ref": "#/components/schemas/ProjectRoleBindingInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "RoleBindingQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "ProjectRoleBindingsInfo"
+ "required": ["domain_id"],
+ "title": "RoleBindingQuery"
}
- , "ProjectStatQuery": {
+ , "RoleBindingRequest": {
+ "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["role_binding_id","domain_id"],
+ "title": "RoleBindingRequest"
+ }
+ , "RoleBindingStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
"required": ["query","domain_id"],
- "title": "ProjectStatQuery"
+ "title": "RoleBindingStatQuery"
}
- , "ProjectsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectInfo"},
- "type": "array","$ref": "#/components/schemas/ProjectInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "RoleBindingsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleBindingInfo"},
+ "type": "array","$ref": "#/components/schemas/RoleBindingInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "ProjectsInfo"
- }
- , "RemoveProjectMemberRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["project_id","user_id","domain_id"],
- "title": "RemoveProjectMemberRequest"
+ "title": "RoleBindingsInfo"
}
- , "UpdateProjectRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UpdateRoleBindingRequest": {
+ "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["project_id","domain_id"],
- "title": "UpdateProjectRequest"
+ "required": ["role_binding_id","domain_id"],
+ "title": "UpdateRoleBindingRequest"
}
, "AddProjectGroupMemberRequest": {
"properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"is_external_user" : {"type": "boolean","title": "IS_EXTERNAL_USER"}},
@@ -3001,171 +3003,191 @@
"required": ["project_group_id","domain_id"],
"title": "UpdateProjectGroupRequest"
}
- , "APIKeyInfo": {
- "properties" : {"api_key_id" : {"type": "string","title": "API_KEY_ID"},"api_key" : {"type": "string","title": "API_KEY"},"state" : {"type": "string","title": "STATE"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "ChangeAuthRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"release_auth_plugin" : {"type": "boolean","title": "RELEASE_AUTH_PLUGIN"}},
"type": "object",
- "required": ["api_key_id","api_key","state","user_id","domain_id","last_accessed_at","created_at"],
- "title": "APIKeyInfo"
+ "required": ["domain_id"],
+ "title": "ChangeAuthRequest"
}
- , "APIKeyQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"api_key_id" : {"type": "string","title": "API_KEY_ID"},"state" : {"type": "string","title": "STATE"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "CreateDomainRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"config" : {"type": "object","title": "CONFIG"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["domain_id"],
- "title": "APIKeyQuery"
+ "required": ["name"],
+ "title": "CreateDomainRequest"
}
- , "APIKeyRequest": {
- "properties" : {"api_key_id" : {"type": "string","title": "API_KEY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "DomainInfo": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"config" : {"type": "object","title": "CONFIG"},"tags" : {"type": "object","title": "TAGS"},"created_at" : {"type": "string","title": "CREATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
"type": "object",
- "required": ["api_key_id","domain_id"],
- "title": "APIKeyRequest"
+ "required": ["domain_id","name","state","plugin_info","config","tags","created_at","deleted_at"],
+ "title": "DomainInfo"
}
- , "APIKeyStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "DomainQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"}},
"type": "object",
- "required": ["query","domain_id"],
- "title": "APIKeyStatQuery"
+ "required": [],
+ "title": "DomainQuery"
}
- , "APIKeysInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/APIKeyInfo"},
- "type": "array","$ref": "#/components/schemas/APIKeyInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "DomainRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "APIKeysInfo"
+ "required": ["domain_id"],
+ "title": "DomainRequest"
}
- , "CreateAPIKeyRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "DomainStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
- "required": ["user_id","domain_id"],
- "title": "CreateAPIKeyRequest"
+ "required": ["query"],
+ "title": "DomainStatQuery"
}
- , "GetAPIKeyRequest": {
- "properties" : {"api_key_id" : {"type": "string","title": "API_KEY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"}},
+ , "DomainsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DomainInfo"},
+ "type": "array","$ref": "#/components/schemas/DomainInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["api_key_id","domain_id"],
- "title": "GetAPIKeyRequest"
+ "required": ["results","total_count"],
+ "title": "DomainsInfo"
}
- , "CreateProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"template" : {"type": "object","title": "TEMPLATE"},"metadata" : {"type": "object","title": "METADATA"},"capability" : {"type": "object","title": "CAPABILITY"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "GetDomainRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"}},
"type": "object",
- "required": ["provider","name","template","domain_id"],
- "title": "CreateProviderRequest"
+ "required": ["domain_id"],
+ "title": "GetDomainRequest"
}
- , "GetProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "PluginInfo": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"secret_id" : {"type": "string","title": "SECRET_ID"},"options" : {"type": "object","title": "OPTIONS"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"metadata" : {"type": "object","title": "METADATA"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
"type": "object",
- "required": ["provider","domain_id"],
- "title": "GetProviderRequest"
+ "required": ["plugin_id","version","secret_id","options","secret_data","schema_id","metadata","upgrade_mode"],
+ "title": "PluginInfo"
}
- , "ProviderInfo": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"template" : {"type": "object","title": "TEMPLATE"},"metadata" : {"type": "object","title": "METADATA"},"capability" : {"type": "object","title": "CAPABILITY"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "UpdateDomainRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"config" : {"type": "object","title": "CONFIG"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["provider","name","order","template","metadata","capability","tags","domain_id","created_at"],
- "title": "ProviderInfo"
+ "required": ["domain_id"],
+ "title": "UpdateDomainRequest"
}
- , "ProviderQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UpdatePluginRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
"type": "object",
"required": ["domain_id"],
- "title": "ProviderQuery"
+ "title": "UpdatePluginRequest"
}
- , "ProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "CreateRoleRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"},
+ "type": "array","$ref": "#/components/schemas/RolePolicy","title": "POLICIES"},"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"},
+ "type": "array","$ref": "#/components/schemas/PagePermission","title": "PAGE_PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["provider","domain_id"],
- "title": "ProviderRequest"
+ "required": ["name","role_type","policies","domain_id"],
+ "title": "CreateRoleRequest"
}
- , "ProviderStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "GetRoleRequest": {
+ "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"}},
"type": "object",
- "required": ["query","domain_id"],
- "title": "ProviderStatQuery"
+ "required": ["role_id","domain_id"],
+ "title": "GetRoleRequest"
}
- , "ProvidersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProviderInfo"},
- "type": "array","$ref": "#/components/schemas/ProviderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "PagePermission": {
+ "properties" : {"page" : {"type": "string","title": "PAGE"},"permission" : {"type": "string","title": "PERMISSION"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "ProvidersInfo"
+ "required": ["page","permission"],
+ "title": "PagePermission"
}
- , "UpdateProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"template" : {"type": "object","title": "TEMPLATE"},"metadata" : {"type": "object","title": "METADATA"},"capability" : {"type": "object","title": "CAPABILITY"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "RoleInfo": {
+ "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"},
+ "type": "array","$ref": "#/components/schemas/RolePolicy","title": "POLICIES"},"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"},
+ "type": "array","$ref": "#/components/schemas/PagePermission","title": "PAGE_PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
"type": "object",
- "required": ["provider","domain_id"],
- "title": "UpdateProviderRequest"
+ "required": ["role_id","name","role_type","policies","page_permissions","tags","domain_id","created_at","deleted_at"],
+ "title": "RoleInfo"
}
- , "EndpointInfo": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"name" : {"type": "string","title": "NAME"},"endpoint" : {"type": "string","title": "ENDPOINT"},"state" : {"type": "string","title": "STATE"},"version" : {"type": "string","title": "VERSION"}},
+ , "RolePolicy": {
+ "properties" : {"policy_type" : {"type": "string","title": "POLICY_TYPE"},"policy_id" : {"type": "string","title": "POLICY_ID"}},
"type": "object",
- "required": ["service","name","endpoint","state","version"],
- "title": "EndpointInfo"
+ "required": ["policy_type","policy_id"],
+ "title": "RolePolicy"
}
- , "EndpointQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"service" : {"type": "string","title": "SERVICE"},"endpoint_type" : {"type": "string","title": "ENDPOINT_TYPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "RoleQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"policy_id" : {"type": "string","title": "POLICY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
"required": ["domain_id"],
- "title": "EndpointQuery"
+ "title": "RoleQuery"
}
- , "EndpointsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EndpointInfo"},
- "type": "array","$ref": "#/components/schemas/EndpointInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "RoleRequest": {
+ "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["role_id","domain_id"],
+ "title": "RoleRequest"
+ }
+ , "RoleStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["query","domain_id"],
+ "title": "RoleStatQuery"
+ }
+ , "RolesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleInfo"},
+ "type": "array","$ref": "#/components/schemas/RoleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "EndpointsInfo"
+ "title": "RolesInfo"
}
- , "CreatePolicyRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
- "type": "array","title": "PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UpdateRoleRequest": {
+ "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"policies" : {"items": {"$ref": "#/components/schemas/RolePolicy"},
+ "type": "array","$ref": "#/components/schemas/RolePolicy","title": "POLICIES"},"page_permissions" : {"items": {"$ref": "#/components/schemas/PagePermission"},
+ "type": "array","$ref": "#/components/schemas/PagePermission","title": "PAGE_PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"release_page_permissions" : {"type": "boolean","title": "RELEASE_PAGE_PERMISSIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["name","permissions","domain_id"],
- "title": "CreatePolicyRequest"
+ "required": ["role_id","domain_id"],
+ "title": "UpdateRoleRequest"
}
- , "GetPolicyRequest": {
- "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"}},
+ , "CreateDomainOwner": {
+ "properties" : {"owner_id" : {"type": "string","title": "OWNER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["policy_id","domain_id"],
- "title": "GetPolicyRequest"
+ "required": ["password","domain_id"],
+ "title": "CreateDomainOwner"
}
- , "PoliciesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PolicyInfo"},
- "type": "array","$ref": "#/components/schemas/PolicyInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "DomainOwnerInfo": {
+ "properties" : {"owner_id" : {"type": "string","title": "OWNER_ID"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"},"created_at" : {"type": "string","title": "CREATED_AT"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "PoliciesInfo"
+ "required": ["owner_id","name","email","language","timezone","last_accessed_at","created_at","domain_id"],
+ "title": "DomainOwnerInfo"
+ }
+ , "DomainOwnerRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"owner_id" : {"type": "string","title": "OWNER_ID"}},
+ "type": "object",
+ "required": ["domain_id","owner_id"],
+ "title": "DomainOwnerRequest"
}
- , "PolicyInfo": {
- "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
- "type": "array","title": "PERMISSIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"tags" : {"type": "object","title": "TAGS"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "GetDomainOwnerRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"owner_id" : {"type": "string","title": "OWNER_ID"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"}},
"type": "object",
- "required": ["policy_id","name","permissions","domain_id","tags","created_at"],
- "title": "PolicyInfo"
+ "required": ["domain_id","owner_id"],
+ "title": "GetDomainOwnerRequest"
}
- , "PolicyQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"policy_id" : {"type": "string","title": "POLICY_ID"},"name" : {"type": "string","title": "NAME"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UpdateDomainOwner": {
+ "properties" : {"owner_id" : {"type": "string","title": "OWNER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": [],
- "title": "PolicyQuery"
+ "required": ["owner_id","domain_id"],
+ "title": "UpdateDomainOwner"
}
- , "PolicyRequest": {
- "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "EndpointInfo": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"name" : {"type": "string","title": "NAME"},"endpoint" : {"type": "string","title": "ENDPOINT"},"state" : {"type": "string","title": "STATE"},"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["policy_id","domain_id"],
- "title": "PolicyRequest"
+ "required": ["service","name","endpoint","state","version"],
+ "title": "EndpointInfo"
}
- , "PolicyStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "EndpointQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"service" : {"type": "string","title": "SERVICE"},"endpoint_type" : {"type": "string","title": "ENDPOINT_TYPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["query","domain_id"],
- "title": "PolicyStatQuery"
+ "required": ["domain_id"],
+ "title": "EndpointQuery"
}
- , "UpdatePolicyRequest": {
- "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
- "type": "array","title": "PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "EndpointsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EndpointInfo"},
+ "type": "array","$ref": "#/components/schemas/EndpointInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["policy_id","domain_id"],
- "title": "UpdatePolicyRequest"
+ "required": ["results","total_count"],
+ "title": "EndpointsInfo"
}
, "CreateServiceAccountRequest": {
"properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"project_id" : {"type": "string","title": "PROJECT_ID"},"tags" : {"type": "object","title": "TAGS"},"service_account_type" : {"type": "string","title": "SERVICE_ACCOUNT_TYPE"},"trusted_service_account_id" : {"type": "string","title": "TRUSTED_SERVICE_ACCOUNT_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
@@ -3217,167 +3239,145 @@
"required": ["service_account_id","domain_id"],
"title": "UpdateServiceAccountRequest"
}
- , "ConfirmEmailRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"verify_code" : {"type": "string","title": "VERIFY_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["user_id","verify_code","domain_id"],
- "title": "ConfirmEmailRequest"
- }
- , "ConfirmMFARequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"verify_code" : {"type": "string","title": "VERIFY_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "AddProjectMemberRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"is_external_user" : {"type": "boolean","title": "IS_EXTERNAL_USER"}},
"type": "object",
- "required": ["user_id","verify_code","domain_id"],
- "title": "ConfirmMFARequest"
+ "required": ["project_id","user_id","domain_id"],
+ "title": "AddProjectMemberRequest"
}
- , "CreateUserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"user_type" : {"type": "string","title": "USER_TYPE"},"backend" : {"type": "string","title": "BACKEND"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
+ , "CreateProjectRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["user_id","backend","domain_id"],
- "title": "CreateUserRequest"
+ "required": ["name","project_group_id","domain_id"],
+ "title": "CreateProjectRequest"
}
- , "DisableMFARequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"force" : {"type": "boolean","title": "FORCE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "GetProjectRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"}},
"type": "object",
- "required": ["user_id","domain_id"],
- "title": "DisableMFARequest"
+ "required": ["project_id","domain_id"],
+ "title": "GetProjectRequest"
}
- , "EnableMFARequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"mfa_type" : {"type": "string","title": "MFA_TYPE"},"options" : {"type": "object","title": "OPTIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "ModifyProjectMemberRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["user_id","mfa_type","options","domain_id"],
- "title": "EnableMFARequest"
+ "required": ["project_id","user_id","domain_id"],
+ "title": "ModifyProjectMemberRequest"
}
- , "FindUserInfo": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"tags" : {"type": "object","title": "TAGS"}},
+ , "ProjectInfo": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"project_group_info" : {"$ref": "#/components/schemas/ProjectGroupInfo","title": "PROJECT_GROUP_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_by" : {"type": "string","title": "CREATED_BY"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["user_id","name","email","tags"],
- "title": "FindUserInfo"
+ "required": ["project_id","name","tags","project_group_info","domain_id","created_by","created_at"],
+ "title": "ProjectInfo"
}
- , "FindUserQuery": {
- "properties" : {"search" : {"$ref": "#/components/schemas/FindUserSearch","title": "SEARCH"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "ProjectMemberQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"include_parent_member" : {"type": "boolean","title": "INCLUDE_PARENT_MEMBER"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["search","domain_id"],
- "title": "FindUserQuery"
+ "required": ["project_id","domain_id"],
+ "title": "ProjectMemberQuery"
}
- , "FindUserSearch": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"keyword" : {"type": "string","title": "KEYWORD"}},
+ , "ProjectQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["user_id","keyword"],
- "title": "FindUserSearch"
+ "required": ["domain_id"],
+ "title": "ProjectQuery"
}
- , "FindUsersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/FindUserInfo"},
- "type": "array","$ref": "#/components/schemas/FindUserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "ProjectRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "FindUsersInfo"
+ "required": ["project_id","domain_id"],
+ "title": "ProjectRequest"
}
- , "GetUserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"}},
+ , "ProjectRoleBindingInfo": {
+ "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"role_info" : {"$ref": "#/components/schemas/RoleInfo","title": "ROLE_INFO"},"project_info" : {"$ref": "#/components/schemas/ProjectInfo","title": "PROJECT_INFO"},"project_group_info" : {"$ref": "#/components/schemas/ProjectGroupInfo","title": "PROJECT_GROUP_INFO"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["user_id","domain_id"],
- "title": "GetUserRequest"
+ "required": ["role_binding_id","resource_type","resource_id","role_info","project_info","project_group_info","labels","tags","domain_id","created_at"],
+ "title": "ProjectRoleBindingInfo"
}
- , "MFA": {
- "properties" : {"state" : {"type": "string","title": "STATE"},"mfa_type" : {"type": "string","title": "MFA_TYPE"},"options" : {"type": "object","title": "OPTIONS"}},
+ , "ProjectRoleBindingsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectRoleBindingInfo"},
+ "type": "array","$ref": "#/components/schemas/ProjectRoleBindingInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["state","mfa_type","options"],
- "title": "MFA"
+ "required": ["results","total_count"],
+ "title": "ProjectRoleBindingsInfo"
}
- , "SetRequiredActionsRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"actions" : {"items": {"type": "string"},
- "type": "array","title": "ACTIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "ProjectStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["user_id","actions","domain_id"],
- "title": "SetRequiredActionsRequest"
+ "required": ["query","domain_id"],
+ "title": "ProjectStatQuery"
}
- , "UpdateUserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
+ , "ProjectsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectInfo"},
+ "type": "array","$ref": "#/components/schemas/ProjectInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["user_id","domain_id"],
- "title": "UpdateUserRequest"
+ "required": ["results","total_count"],
+ "title": "ProjectsInfo"
}
- , "UserInfo": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"user_type" : {"type": "string","title": "USER_TYPE"},"backend" : {"type": "string","title": "BACKEND"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"required_actions" : {"items": {"type": "string"},
- "type": "array","title": "REQUIRED_ACTIONS"},"tags" : {"type": "object","title": "TAGS"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"},"created_at" : {"type": "string","title": "CREATED_AT"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"email_verified" : {"type": "boolean","title": "EMAIL_VERIFIED"},"mfa" : {"$ref": "#/components/schemas/MFA","title": "MFA"}},
+ , "RemoveProjectMemberRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["user_id","name","state","email","user_type","backend","language","timezone","required_actions","tags","last_accessed_at","created_at","domain_id","email_verified","mfa"],
- "title": "UserInfo"
+ "required": ["project_id","user_id","domain_id"],
+ "title": "RemoveProjectMemberRequest"
}
- , "UserQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"user_type" : {"type": "string","title": "USER_TYPE"},"backend" : {"type": "string","title": "BACKEND"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UpdateProjectRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": [],
- "title": "UserQuery"
+ "required": ["project_id","domain_id"],
+ "title": "UpdateProjectRequest"
}
- , "UserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "CreatePolicyRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
+ "type": "array","title": "PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["user_id","domain_id"],
- "title": "UserRequest"
+ "required": ["name","permissions","domain_id"],
+ "title": "CreatePolicyRequest"
}
- , "UserStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "GetPolicyRequest": {
+ "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"only" : {"items": {"type": "string"},
+ "type": "array","title": "ONLY"}},
"type": "object",
- "required": ["query","domain_id"],
- "title": "UserStatQuery"
+ "required": ["policy_id","domain_id"],
+ "title": "GetPolicyRequest"
}
- , "UsersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserInfo"},
- "type": "array","$ref": "#/components/schemas/UserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "PoliciesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PolicyInfo"},
+ "type": "array","$ref": "#/components/schemas/PolicyInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "UsersInfo"
- }
- , "VerifyEmailRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"email" : {"type": "string","title": "EMAIL"},"force" : {"type": "boolean","title": "FORCE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["user_id","domain_id"],
- "title": "VerifyEmailRequest"
- }
- , "CreateDomainOwner": {
- "properties" : {"owner_id" : {"type": "string","title": "OWNER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["password","domain_id"],
- "title": "CreateDomainOwner"
- }
- , "DomainOwnerInfo": {
- "properties" : {"owner_id" : {"type": "string","title": "OWNER_ID"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"},"created_at" : {"type": "string","title": "CREATED_AT"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["owner_id","name","email","language","timezone","last_accessed_at","created_at","domain_id"],
- "title": "DomainOwnerInfo"
+ "title": "PoliciesInfo"
}
- , "DomainOwnerRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"owner_id" : {"type": "string","title": "OWNER_ID"}},
+ , "PolicyInfo": {
+ "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
+ "type": "array","title": "PERMISSIONS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"tags" : {"type": "object","title": "TAGS"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["domain_id","owner_id"],
- "title": "DomainOwnerRequest"
+ "required": ["policy_id","name","permissions","domain_id","tags","created_at"],
+ "title": "PolicyInfo"
}
- , "GetDomainOwnerRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"owner_id" : {"type": "string","title": "OWNER_ID"},"only" : {"items": {"type": "string"},
- "type": "array","title": "ONLY"}},
+ , "PolicyQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"policy_id" : {"type": "string","title": "POLICY_ID"},"name" : {"type": "string","title": "NAME"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id","owner_id"],
- "title": "GetDomainOwnerRequest"
+ "required": [],
+ "title": "PolicyQuery"
}
- , "UpdateDomainOwner": {
- "properties" : {"owner_id" : {"type": "string","title": "OWNER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "PolicyRequest": {
+ "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["owner_id","domain_id"],
- "title": "UpdateDomainOwner"
+ "required": ["policy_id","domain_id"],
+ "title": "PolicyRequest"
}
- , "IssueTokenRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"credentials" : {"type": "object","title": "CREDENTIALS"},"user_type" : {"type": "string","title": "USER_TYPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"timeout" : {"type": "integer","title": "TIMEOUT"},"refresh_count" : {"type": "integer","title": "REFRESH_COUNT"},"verify_code" : {"type": "string","title": "VERIFY_CODE"}},
+ , "PolicyStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["credentials","domain_id"],
- "title": "IssueTokenRequest"
+ "required": ["query","domain_id"],
+ "title": "PolicyStatQuery"
}
- , "TokenInfo": {
- "properties" : {"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"refresh_token" : {"type": "string","title": "REFRESH_TOKEN"}},
+ , "UpdatePolicyRequest": {
+ "properties" : {"policy_id" : {"type": "string","title": "POLICY_ID"},"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
+ "type": "array","title": "PERMISSIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["access_token","refresh_token"],
- "title": "TokenInfo"
+ "required": ["policy_id","domain_id"],
+ "title": "UpdatePolicyRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/identity/v2/openapi.json b/dist/openapi/cloudforet/api/identity/v2/openapi.json
index b45d601a2..2b9b90da3 100755
--- a/dist/openapi/cloudforet/api/identity/v2/openapi.json
+++ b/dist/openapi/cloudforet/api/identity/v2/openapi.json
@@ -8,18 +8,18 @@
"title": "Identity API",
"version": "3.1.0"
},
- "paths":{"/identity/domain/create": {
+ "paths":{"/identity/user-group/create": {
"post": {
- "tags": ["identity > domain"],
+ "tags": ["identity > user-group"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |admin||Admin|True|\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"admin" : {"$ref": "#/components/schemas/Admin","title": "ADMIN" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -30,25 +30,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/update": {
+ },"/identity/user-group/update": {
"post": {
- "tags": ["identity > domain"],
+ "tags": ["identity > user-group"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -59,25 +59,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/delete": {
+ },"/identity/user-group/delete": {
"post": {
- "tags": ["identity > domain"],
+ "tags": ["identity > user-group"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" } }
},
"examples":{"Schema":{}
}
@@ -89,18 +89,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/enable": {
+ },"/identity/user-group/add-users": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Enable",
+ "tags": ["identity > user-group"],
+ "summary": "Add Users",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n |users||array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
},
"examples":{"Schema":{}
}
@@ -111,25 +111,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/disable": {
+ },"/identity/user-group/remove-users": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Disable",
+ "tags": ["identity > user-group"],
+ "summary": "Remove Users",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n |users||array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
},
"examples":{"Schema":{}
}
@@ -140,25 +140,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/get": {
+ },"/identity/user-group/get": {
"post": {
- "tags": ["identity > domain"],
+ "tags": ["identity > user-group"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" } }
},
"examples":{"Schema":{}
}
@@ -169,25 +169,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/domain/get-auth-info": {
+ },"/identity/user-group/list": {
"post": {
- "tags": ["identity > domain"],
- "summary": "Get Auth Info",
+ "tags": ["identity > user-group"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_group_id||string||\n |name||string||\n |user_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"user_id" : {"type": "string","title": "USER_ID" } }
},
"examples":{"Schema":{}
}
@@ -198,25 +198,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainAuthInfo"},
+ "schema": {"$ref": "#/components/schemas/UserGroupsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainAuthInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserGroupsInfo"}}
}
}}
}
- }
- },"/identity/domain/list": {
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/user-group/stat": {
"post": {
- "tags": ["identity > domain"],
- "summary": "List",
+ "tags": ["identity > user-group"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |domain_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -227,27 +227,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DomainsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DomainsInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/create": {
+ },"/identity/user/create": {
"post": {
- "tags": ["identity > role"],
+ "tags": ["identity > user"],
"summary": "Create",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nYou can create user. after create user you have to binding role to user.\nSee role-binding create api.\nExternal type user do not need password.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER, WORKSPACE_MEMBER |string|True|\n |permissions||array||\n |page_access||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |auth_type|LOCAL, EXTERNAL |string|True|\n |reset_password|If reset_password is true, send email|boolean|True|\n |password|When auth_type is LOCAL, password is required. |string||\n |name||string||\n |email||string||\n |language|en,ko |string||\n |timezone|UTC, Asia/Seoul |string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"page_access" : {"items": {}, "type": "array","title": "PAGE_ACCESS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "string","title": "AUTH_TYPE" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"wonny@cloudforet.io\",\n \"password\": \"Password1234!\",\n \"name\": \"Wonny\",\n \"email\": \"wonny@cloudforet.io\",\n \"auth_type\": \"LOCAL\",\n \"language\": \"en\",\n \"timezone\": \"UTC\"\n}"},"Schema":{}
}
}
},"required": true
@@ -256,25 +256,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/update": {
+ },"/identity/user/update": {
"post": {
- "tags": ["identity > role"],
+ "tags": ["identity > user"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nUpdate user info by given user_id",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |name||string||\n |permissions||array||\n |page_access||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |password||string||\n |name||string||\n |email||string||\n |language||string||\n |timezone||string||\n |tags||Struct||\n |reset_password||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"page_access" : {"items": {}, "type": "array","title": "PAGE_ACCESS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
},
"examples":{"Schema":{}
}
@@ -285,56 +285,50 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/enable": {
+ },"/identity/user/verify-email": {
"post": {
- "tags": ["identity > role"],
- "summary": "Enable",
+ "tags": ["identity > user"],
+ "summary": "Verify Email",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |email||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"email" : {"type": "string","title": "EMAIL" } }
},
- "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"email\": \"example@cloudforet.com\",\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/disable": {
+ },"/identity/user/disable-mfa": {
"post": {
- "tags": ["identity > role"],
- "summary": "Disable",
+ "tags": ["identity > user"],
+ "summary": "Disable Mfa",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDisable MFA for user. If this api is called, send email to user.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
}
}
},"required": true
@@ -343,50 +337,56 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/delete": {
+ },"/identity/user/set-required-actions": {
"post": {
- "tags": ["identity > role"],
- "summary": "Delete",
+ "tags": ["identity > user"],
+ "summary": "Set Required Actions",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |required_actions| |array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"required_actions" : {"items": {}, "type": "array","title": "REQUIRED_ACTIONS" } }
},
- "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"required_actions\": [\"UPDATE_PASSWORD\"]\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/UserInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/get": {
+ },"/identity/user/enable": {
"post": {
- "tags": ["identity > role"],
- "summary": "Get",
+ "tags": ["identity > user"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
}
}
},"required": true
@@ -395,27 +395,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/list": {
+ },"/identity/user/disable": {
"post": {
- "tags": ["identity > role"],
- "summary": "List",
+ "tags": ["identity > user"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |role_id||string||\n |name||string||\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER, WORKSPACE_MEMBER |string||\n |state|ENABLED, DISABLED |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"state" : {"type": "string","title": "STATE" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
}
}
},"required": true
@@ -424,56 +424,50 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RolesInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RolesInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role/stat": {
+ },"/identity/user/delete": {
"post": {
- "tags": ["identity > role"],
- "summary": "Stat",
+ "tags": ["identity > user"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/create": {
+ },"/identity/user/get": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "Create",
+ "tags": ["identity > user"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
}
}
},"required": true
@@ -482,25 +476,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/UserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/update": {
+ },"/identity/user/list": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "Update",
+ "tags": ["identity > user"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_id||string||\n |name||string||\n |state|ENABLED, DISABLED, PENDING |string||\n |email||string||\n |auth_type|LOCAL, EXTERNAL |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_id" : {"type": "string","title": "USER_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "string","title": "AUTH_TYPE" } }
},
"examples":{"Schema":{}
}
@@ -511,25 +505,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/UsersInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/UsersInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/delete": {
+ },"/identity/user/stat": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "Delete",
+ "tags": ["identity > user"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -538,23 +532,29 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/add-users": {
+ },"/identity/trusted-account/create": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "Add Users",
+ "tags": ["identity > trusted-account"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n |users||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data|Base Information of Trusted Account. It depends on provider.|Struct|True|\n |provider||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |schedule||Scheduled||\n |sync_options||Struct||\n |plugin_options||Struct||\n |tags||Struct||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"provider" : {"type": "string","title": "PROVIDER" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"sync_options" : {"type": "object","title": "SYNC_OPTIONS" },"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"Trusted Account\",\n \"data\": {\n \"account_id\": \"123456789\",\n }\n \"provider\": \"aws\",\n \"secret_schema_id\": \"aws-secret-access-key\",\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [3, 15]\n },\n \"resource_group\": \"DOMAIN\",\n \"workspace_id\": \"*\"\n}"},"Schema":{}
}
}
},"required": true
@@ -563,25 +563,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/remove-users": {
+ },"/identity/trusted-account/update": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "Remove Users",
+ "tags": ["identity > trusted-account"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n |users||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n |tags||Struct|True|\n |name||string||\n |data||Struct||\n |schedule||Scheduled||\n |sync_options||Struct||\n |plugin_options||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
+ "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"sync_options" : {"type": "object","title": "SYNC_OPTIONS" },"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -592,25 +592,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/get": {
+ },"/identity/trusted-account/update-secret-data": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "Get",
+ "tags": ["identity > trusted-account"],
+ "summary": "Update Secret Data",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_group_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_group_id" : {"type": "string","title": "USER_GROUP_ID" } }
+ "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" } }
},
"examples":{"Schema":{}
}
@@ -621,25 +621,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/list": {
+ },"/identity/trusted-account/delete": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "List",
+ "tags": ["identity > trusted-account"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_group_id||string||\n |name||string||\n |user_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_group_id" : {"type": "string","title": "USER_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -648,27 +648,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/UserGroupsInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/UserGroupsInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user-group/stat": {
+ },"/identity/trusted-account/sync": {
"post": {
- "tags": ["identity > user-group"],
- "summary": "Stat",
+ "tags": ["identity > trusted-account"],
+ "summary": "Sync",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -679,25 +673,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/JobInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
+ "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/create": {
+ },"/identity/trusted-account/get": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Create",
+ "tags": ["identity > trusted-account"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |role_id||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -708,25 +704,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/update-role": {
+ },"/identity/trusted-account/list": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Update Role",
+ "tags": ["identity > trusted-account"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |role_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |trusted_account_id||string||\n |name||string||\n |provider||string||\n |workspace_id||string||\n |secret_schema_id||string||\n |trusted_secret_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"role_id" : {"type": "string","title": "ROLE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" } }
},
"examples":{"Schema":{}
}
@@ -737,25 +733,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedAccountsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/TrustedAccountsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/delete": {
+ },"/identity/trusted-account/stat": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Delete",
+ "tags": ["identity > trusted-account"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -764,21 +760,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/get": {
+ },"/identity/workspace-user/create": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Get",
+ "tags": ["identity > workspace-user"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |auth_type||AuthType|True|\n |reset_password|If reset_password is true, send email|boolean|True|\n |role_id||string|True|\n |password|When auth_type is LOCAL, password is required. |string||\n |name||string||\n |email||string||\n |language|en,ko |string||\n |timezone|UTC, Asia/Seoul |string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "AuthType","title": "AUTH_TYPE" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" },"role_id" : {"type": "string","title": "ROLE_ID" } }
},
"examples":{"Schema":{}
}
@@ -789,25 +791,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/list": {
+ },"/identity/workspace-user/get": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "List",
+ "tags": ["identity > workspace-user"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |role_binding_id||string||\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER, WORKSPACE_MEMBER |string||\n |workspace_id||string||\n |role_id||string||\n |user_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |workspace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -818,25 +820,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RoleBindingsInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RoleBindingsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/role-binding/stat": {
+ },"/identity/workspace-user/find": {
"post": {
- "tags": ["identity > role-binding"],
- "summary": "Stat",
+ "tags": ["identity > workspace-user"],
+ "summary": "Find",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |keyword||string|True|\n |workspace_id||string|True|\n |state|ENABLED, DISABLED, PENDING |string||\n |page||Page||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"keyword" : {"type": "string","title": "KEYWORD" },"state" : {"type": "string","title": "STATE" },"page" : {"$ref": "#/components/schemas/Page","title": "PAGE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -847,25 +849,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/UsersSummaryInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/UsersSummaryInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/schema/create": {
+ },"/identity/workspace-user/list": {
"post": {
- "tags": ["identity > schema"],
- "summary": "Create",
+ "tags": ["identity > workspace-user"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n |name||string|True|\n |schema_type|SERVICE_ACCOUNT, TRUSTED_ACCOUNT, SECRET, TRUSTING_SECRET |string|True|\n |provider||string|True|\n |schema||Struct||\n |related_schemas||array||\n |options||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |query||Query||\n |user_id||string||\n |name||string||\n |state|ENABLED, DISABLED, PENDING |string||\n |email||string||\n |auth_type||AuthType||\n |role_type||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" },"name" : {"type": "string","title": "NAME" },"schema_type" : {"type": "string","title": "SCHEMA_TYPE" },"schema" : {"type": "object","title": "SCHEMA" },"provider" : {"type": "string","title": "PROVIDER" },"related_schemas" : {"items": {}, "type": "array","title": "RELATED_SCHEMAS" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_id" : {"type": "string","title": "USER_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "AuthType","title": "AUTH_TYPE" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -876,25 +878,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/SchemaInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceUsersInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/SchemaInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceUsersInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/schema/update": {
+ },"/identity/workspace-user/stat": {
"post": {
- "tags": ["identity > schema"],
- "summary": "Update",
+ "tags": ["identity > workspace-user"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n |name||string||\n |schema||Struct||\n |related_schemas||array||\n |options||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |workspace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" },"name" : {"type": "string","title": "NAME" },"schema" : {"type": "object","title": "SCHEMA" },"related_schemas" : {"items": {}, "type": "array","title": "RELATED_SCHEMAS" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -905,25 +907,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/SchemaInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/SchemaInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/schema/delete": {
+ },"/identity/token/issue": {
"post": {
- "tags": ["identity > schema"],
- "summary": "Delete",
+ "tags": ["identity > token"],
+ "summary": "Issue",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |credentials||Struct|True|\n |domain_id||string|True|\n |auth_type|LOCAL, EXTERNAL, MFA LOCAL, EXTERNAL |string||\n |timeout||int||\n |verify_code|if MFA is enabled, verify_code is required |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" } }
+ "properties": {"credentials" : {"type": "object","title": "CREDENTIALS" },"auth_type" : {"type": "string","title": "AUTH_TYPE" },"timeout" : {"type": "integer","title": "TIMEOUT" },"verify_code" : {"type": "string","title": "VERIFY_CODE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -932,21 +934,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/TokenInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/TokenInfo"}}
+ }
+ }}
}
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/schema/get": {
+ }
+ },"/identity/token/grant": {
"post": {
- "tags": ["identity > schema"],
- "summary": "Get",
+ "tags": ["identity > token"],
+ "summary": "Grant",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |grant_type|REFRESH_TOKEN, SYSTEM_TOKEN |string|True|\n |token||string|True|\n |scope|SYSTEM, DOMAIN, WORKSPACE, PROJECT, USER |string|True|\n |timeout||int||\n |workspace_id||string||\n |domain_id||string||\n |permissions||array||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" } }
+ "properties": {"grant_type" : {"type": "string","title": "GRANT_TYPE" },"token" : {"type": "string","title": "TOKEN" },"scope" : {"type": "string","title": "SCOPE" },"timeout" : {"type": "integer","title": "TIMEOUT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" } }
},
"examples":{"Schema":{}
}
@@ -957,54 +965,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/SchemaInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/SchemaInfo"}}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/schema/list": {
- "post": {
- "tags": ["identity > schema"],
- "summary": "List",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |schema_id||string||\n |name||string||\n |schema_type|SERVICE_ACCOUNT, TRUSTED_ACCOUNT, SECRET, TRUSTING_SECRET |string||\n |provider||string||\n |related_schema_id||string||\n |is_managed||boolean||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"name" : {"type": "string","title": "NAME" },"schema_type" : {"type": "string","title": "SCHEMA_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"related_schema_id" : {"type": "string","title": "RELATED_SCHEMA_ID" },"is_managed" : {"type": "boolean","title": "IS_MANAGED" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/SchemasInfo"},
+ "schema": {"$ref": "#/components/schemas/GrantTokenInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/SchemasInfo"}}
+ "Schema": {"$ref": "#/components/schemas/GrantTokenInfo"}}
}
}}
}
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/schema/stat": {
+ }
+ },"/identity/external-auth/set": {
"post": {
- "tags": ["identity > schema"],
- "summary": "Stat",
+ "tags": ["identity > external-auth"],
+ "summary": "Set",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_info||PluginRequest|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"plugin_info" : {"type": "PluginRequest","title": "PLUGIN_INFO" } }
},
"examples":{"Schema":{}
}
@@ -1015,25 +994,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/ExternalAuthInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/ExternalAuthInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/create": {
+ },"/identity/external-auth/unset": {
"post": {
- "tags": ["identity > project"],
- "summary": "Create",
+ "tags": ["identity > external-auth"],
+ "summary": "Unset",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |project_type|PRIVATE, PUBLIC |string|True|\n |tags||Struct||\n |project_group_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"project_type" : {"type": "string","title": "PROJECT_TYPE" },"tags" : {"type": "object","title": "TAGS" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
+ "properties": { }
},
"examples":{"Schema":{}
}
@@ -1044,25 +1023,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/ExternalAuthInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ExternalAuthInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/update": {
+ },"/identity/external-auth/get": {
"post": {
- "tags": ["identity > project"],
- "summary": "Update",
+ "tags": ["identity > external-auth"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": { }
},
"examples":{"Schema":{}
}
@@ -1073,25 +1052,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/ExternalAuthInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ExternalAuthInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/update-project-type": {
+ },"/identity/workspace/create": {
"post": {
- "tags": ["identity > project"],
- "summary": "Update Project Type",
+ "tags": ["identity > workspace"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |project_type|PRIVATE, PUBLIC |string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"project_type" : {"type": "string","title": "PROJECT_TYPE" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1102,25 +1081,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/change-project-group": {
+ },"/identity/workspace/update": {
"post": {
- "tags": ["identity > project"],
- "summary": "Change Project Group",
+ "tags": ["identity > workspace"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |project_group_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
+ "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -1131,25 +1110,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/delete": {
+ },"/identity/workspace/delete": {
"post": {
- "tags": ["identity > project"],
+ "tags": ["identity > workspace"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |force||boolean|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"force" : {"type": "boolean","title": "FORCE" } }
},
"examples":{"Schema":{}
}
@@ -1161,18 +1140,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/add-users": {
+ },"/identity/workspace/enable": {
"post": {
- "tags": ["identity > project"],
- "summary": "Add Users",
+ "tags": ["identity > workspace"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |users||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
+ "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1183,25 +1162,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/remove-users": {
+ },"/identity/workspace/disable": {
"post": {
- "tags": ["identity > project"],
- "summary": "Remove Users",
+ "tags": ["identity > workspace"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |users||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
+ "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1212,25 +1191,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/get": {
+ },"/identity/workspace/get": {
"post": {
- "tags": ["identity > project"],
+ "tags": ["identity > workspace"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1241,25 +1220,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/list": {
+ },"/identity/workspace/list": {
"post": {
- "tags": ["identity > project"],
+ "tags": ["identity > workspace"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |project_id||string||\n |name||string||\n |project_type|PRIVATE, PUBLIC |string||\n |created_by||string||\n |include_children||boolean||\n |workspace_id||string||\n |project_group_id||string||\n |user_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |workspace_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |created_by||string||\n |is_managed||boolean||\n |is_dormant||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"name" : {"type": "string","title": "NAME" },"project_type" : {"type": "string","title": "PROJECT_TYPE" },"created_by" : {"type": "string","title": "CREATED_BY" },"include_children" : {"type": "boolean","title": "INCLUDE_CHILDREN" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"created_by" : {"type": "string","title": "CREATED_BY" },"is_managed" : {"type": "boolean","title": "IS_MANAGED" },"is_dormant" : {"type": "boolean","title": "IS_DORMANT" } }
},
"examples":{"Schema":{}
}
@@ -1270,16 +1249,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectsInfo"},
+ "schema": {"$ref": "#/components/schemas/WorkspacesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/WorkspacesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project/stat": {
+ },"/identity/workspace/stat": {
"post": {
- "tags": ["identity > project"],
+ "tags": ["identity > workspace"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -1306,20 +1285,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/agent/create": {
+ },"/identity/provider/create": {
"post": {
- "tags": ["identity > agent"],
+ "tags": ["identity > provider"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n |options||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |name||string|True|\n |alias||string||\n |plugin_info|If plugin_info is not empty, your provider support trusted account and support auto sync for Cloudforet. These two options are located in options field. not in plugin_info. |PluginInfo||\n |color||string||\n |icon||string||\n |order||int||\n |options||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"options" : {"type": "object","title": "OPTIONS" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"alias" : {"type": "string","title": "ALIAS" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"color" : {"type": "string","title": "COLOR" },"icon" : {"type": "string","title": "ICON" },"order" : {"type": "integer","title": "ORDER" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\",\n \"name\": \"AWS\",\n \"alias\": \"AWS\",\n \"color\": \"#FF9900\",\n \"icon\": \"https://cloudforet.io/icons/aws.svg\",\n \"order\": 1,\n \"options\": {\n \"supported_trusted_account\": false\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -1328,27 +1307,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AgentInfo"},
+ "schema": {"$ref": "#/components/schemas/ProviderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/agent/enable": {
+ },"/identity/provider/update": {
"post": {
- "tags": ["identity > agent"],
- "summary": "Enable",
+ "tags": ["identity > provider"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |name||string||\n |alias||string||\n |plugin_info||PluginInfo||\n |color||string||\n |icon||string||\n |order||int||\n |options||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"alias" : {"type": "string","title": "ALIAS" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"color" : {"type": "string","title": "COLOR" },"icon" : {"type": "string","title": "ICON" },"order" : {"type": "integer","title": "ORDER" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\",\n \"name\": \"AWS\",\n \"alias\": \"AWS\",\n \"color\": \"#FF9900\",\n \"icon\": \"https://cloudforet.io/icons/aws.svg\",\n \"order\": 2,\n \"options\": {\n \"supported_trusted_account\": false\n },\n}"},"Schema":{}
}
}
},"required": true
@@ -1357,27 +1336,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AgentInfo"},
+ "schema": {"$ref": "#/components/schemas/ProviderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/agent/disable": {
+ },"/identity/provider/update-plugin": {
"post": {
- "tags": ["identity > agent"],
- "summary": "Disable",
+ "tags": ["identity > provider"],
+ "summary": "Update Plugin",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider|Managed provider are aws, azure, google_cloud and kubernetes. Maybe more in the future.|string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\",\n \"version\": \"1.0.0\",\n \"options\": {},\n \"upgrade_mode\": \"AUTO\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1386,77 +1365,77 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AgentInfo"},
+ "schema": {"$ref": "#/components/schemas/ProviderInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/agent/regenerate": {
+ },"/identity/provider/delete": {
"post": {
- "tags": ["identity > agent"],
- "summary": "Regenerate",
+ "tags": ["identity > provider"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/AgentInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/agent/delete": {
+ },"/identity/provider/get": {
"post": {
- "tags": ["identity > agent"],
- "summary": "Delete",
+ "tags": ["identity > provider"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"provider" : {"type": "string","title": "PROVIDER" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/agent/get": {
+ },"/identity/provider/list": {
"post": {
- "tags": ["identity > agent"],
- "summary": "Get",
+ "tags": ["identity > provider"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |provider||string||\n |name||string||\n |alias||string||\n |is_managed||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"alias" : {"type": "string","title": "ALIAS" },"is_managed" : {"type": "boolean","title": "IS_MANAGED" } }
},
"examples":{"Schema":{}
}
@@ -1467,25 +1446,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AgentInfo"},
+ "schema": {"$ref": "#/components/schemas/ProvidersInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProvidersInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/agent/list": {
+ },"/identity/provider/stat": {
"post": {
- "tags": ["identity > agent"],
- "summary": "List",
+ "tags": ["identity > provider"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |agent_id||string||\n |service_account_id||string||\n |state|ENABLED, DISABLED, EXPIRED |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"agent_id" : {"type": "string","title": "AGENT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"state" : {"type": "string","title": "STATE" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -1496,25 +1475,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AgentsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AgentsInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/create": {
+ },"/identity/agent/create": {
"post": {
- "tags": ["identity > project-group"],
+ "tags": ["identity > agent"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct||\n |parent_group_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n |options||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" },"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"options" : {"type": "object","title": "OPTIONS" } }
},
"examples":{"Schema":{}
}
@@ -1525,25 +1504,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/AgentInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/update": {
+ },"/identity/agent/enable": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Update",
+ "tags": ["identity > agent"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -1554,25 +1533,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/AgentInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/change-parent-group": {
+ },"/identity/agent/disable": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Change Parent Group",
+ "tags": ["identity > agent"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |parent_group_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -1583,48 +1562,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/AgentInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/delete": {
- "post": {
- "tags": ["identity > project-group"],
- "summary": "Delete",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/add-users": {
+ },"/identity/agent/regenerate": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Add Users",
+ "tags": ["identity > agent"],
+ "summary": "Regenerate",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |users||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -1635,25 +1591,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/AgentInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/remove-users": {
+ },"/identity/agent/delete": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Remove Users",
+ "tags": ["identity > agent"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |users||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -1662,27 +1618,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/get": {
+ },"/identity/agent/get": {
"post": {
- "tags": ["identity > project-group"],
+ "tags": ["identity > agent"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -1693,25 +1643,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "schema": {"$ref": "#/components/schemas/AgentInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AgentInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/list": {
+ },"/identity/agent/list": {
"post": {
- "tags": ["identity > project-group"],
+ "tags": ["identity > agent"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |project_group_id||string||\n |name||string||\n |workspace_id||string||\n |parent_group_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |agent_id||string||\n |service_account_id||string||\n |state|ENABLED, DISABLED, EXPIRED |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"agent_id" : {"type": "string","title": "AGENT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"state" : {"type": "string","title": "STATE" } }
},
"examples":{"Schema":{}
}
@@ -1722,25 +1672,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"},
+ "schema": {"$ref": "#/components/schemas/AgentsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AgentsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/project-group/stat": {
+ },"/identity/role-binding/create": {
"post": {
- "tags": ["identity > project-group"],
- "summary": "Stat",
+ "tags": ["identity > role-binding"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |role_id||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"user_id" : {"type": "string","title": "USER_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1751,25 +1701,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace-user/create": {
+ },"/identity/role-binding/update-role": {
"post": {
- "tags": ["identity > workspace-user"],
- "summary": "Create",
+ "tags": ["identity > role-binding"],
+ "summary": "Update Role",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |auth_type||AuthType|True|\n |reset_password|If reset_password is true, send email|boolean|True|\n |role_id||string|True|\n |password|When auth_type is LOCAL, password is required. |string||\n |name||string||\n |email||string||\n |language|en,ko |string||\n |timezone|UTC, Asia/Seoul |string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n |role_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "AuthType","title": "AUTH_TYPE" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" },"role_id" : {"type": "string","title": "ROLE_ID" } }
+ "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"role_id" : {"type": "string","title": "ROLE_ID" } }
},
"examples":{"Schema":{}
}
@@ -1780,25 +1730,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace-user/get": {
+ },"/identity/role-binding/delete": {
"post": {
- "tags": ["identity > workspace-user"],
- "summary": "Get",
+ "tags": ["identity > role-binding"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |workspace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" } }
},
"examples":{"Schema":{}
}
@@ -1807,27 +1757,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceUserInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace-user/find": {
+ },"/identity/role-binding/get": {
"post": {
- "tags": ["identity > workspace-user"],
- "summary": "Find",
+ "tags": ["identity > role-binding"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |keyword||string|True|\n |workspace_id||string|True|\n |state|ENABLED, DISABLED, PENDING |string||\n |page||Page||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_binding_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"keyword" : {"type": "string","title": "KEYWORD" },"state" : {"type": "string","title": "STATE" },"page" : {"$ref": "#/components/schemas/Page","title": "PAGE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" } }
},
"examples":{"Schema":{}
}
@@ -1838,25 +1782,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UsersSummaryInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UsersSummaryInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace-user/list": {
+ },"/identity/role-binding/list": {
"post": {
- "tags": ["identity > workspace-user"],
+ "tags": ["identity > role-binding"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |query||Query||\n |user_id||string||\n |name||string||\n |state|ENABLED, DISABLED, PENDING |string||\n |email||string||\n |auth_type||AuthType||\n |role_type||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |role_binding_id||string||\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER, WORKSPACE_MEMBER |string||\n |workspace_id||string||\n |role_id||string||\n |user_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_id" : {"type": "string","title": "USER_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "AuthType","title": "AUTH_TYPE" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"user_id" : {"type": "string","title": "USER_ID" } }
},
"examples":{"Schema":{}
}
@@ -1867,25 +1811,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceUsersInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleBindingsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceUsersInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleBindingsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace-user/stat": {
+ },"/identity/role-binding/stat": {
"post": {
- "tags": ["identity > workspace-user"],
+ "tags": ["identity > role-binding"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |workspace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -1903,20 +1847,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/create": {
+ },"/identity/project-group/create": {
"post": {
- "tags": ["identity > provider"],
+ "tags": ["identity > project-group"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |name||string|True|\n |alias||string||\n |plugin_info|If plugin_info is not empty, your provider support trusted account and support auto sync for Cloudforet. These two options are located in options field. not in plugin_info. |PluginInfo||\n |color||string||\n |icon||string||\n |order||int||\n |options||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct||\n |parent_group_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"alias" : {"type": "string","title": "ALIAS" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"color" : {"type": "string","title": "COLOR" },"icon" : {"type": "string","title": "ICON" },"order" : {"type": "integer","title": "ORDER" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" },"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\",\n \"name\": \"AWS\",\n \"alias\": \"AWS\",\n \"color\": \"#FF9900\",\n \"icon\": \"https://cloudforet.io/icons/aws.svg\",\n \"order\": 1,\n \"options\": {\n \"supported_trusted_account\": false\n }\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1925,27 +1869,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/update": {
+ },"/identity/project-group/update": {
"post": {
- "tags": ["identity > provider"],
+ "tags": ["identity > project-group"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n |name||string||\n |alias||string||\n |plugin_info||PluginInfo||\n |color||string||\n |icon||string||\n |order||int||\n |options||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"alias" : {"type": "string","title": "ALIAS" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"color" : {"type": "string","title": "COLOR" },"icon" : {"type": "string","title": "ICON" },"order" : {"type": "integer","title": "ORDER" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\",\n \"name\": \"AWS\",\n \"alias\": \"AWS\",\n \"color\": \"#FF9900\",\n \"icon\": \"https://cloudforet.io/icons/aws.svg\",\n \"order\": 2,\n \"options\": {\n \"supported_trusted_account\": false\n },\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1954,27 +1898,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/update-plugin": {
+ },"/identity/project-group/change-parent-group": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Update Plugin",
+ "tags": ["identity > project-group"],
+ "summary": "Change Parent Group",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider|Managed provider are aws, azure, google_cloud and kubernetes. Maybe more in the future.|string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |parent_group_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\",\n \"version\": \"1.0.0\",\n \"options\": {},\n \"upgrade_mode\": \"AUTO\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1983,27 +1927,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/delete": {
+ },"/identity/project-group/delete": {
"post": {
- "tags": ["identity > provider"],
+ "tags": ["identity > project-group"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2013,20 +1957,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/get": {
+ },"/identity/project-group/add-users": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Get",
+ "tags": ["identity > project-group"],
+ "summary": "Add Users",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |provider||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |users||array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"provider" : {"type": "string","title": "PROVIDER" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
},
- "examples":{"Default Example":{"value": "{\n \"provider\": \"aws\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2035,25 +1979,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProviderInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProviderInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/list": {
+ },"/identity/project-group/remove-users": {
"post": {
- "tags": ["identity > provider"],
- "summary": "List",
+ "tags": ["identity > project-group"],
+ "summary": "Remove Users",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |provider||string||\n |name||string||\n |alias||string||\n |is_managed||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n |users||array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"provider" : {"type": "string","title": "PROVIDER" },"name" : {"type": "string","title": "NAME" },"alias" : {"type": "string","title": "ALIAS" },"is_managed" : {"type": "boolean","title": "IS_MANAGED" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
},
"examples":{"Schema":{}
}
@@ -2064,25 +2008,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProvidersInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProvidersInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/provider/stat": {
+ },"/identity/project-group/get": {
"post": {
- "tags": ["identity > provider"],
- "summary": "Stat",
+ "tags": ["identity > project-group"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_group_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
},
"examples":{"Schema":{}
}
@@ -2093,25 +2037,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/endpoint/list": {
+ },"/identity/project-group/list": {
"post": {
- "tags": ["identity > endpoint"],
+ "tags": ["identity > project-group"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |service||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |project_group_id||string||\n |name||string||\n |workspace_id||string||\n |parent_group_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"service" : {"type": "string","title": "SERVICE" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID" } }
},
"examples":{"Schema":{}
}
@@ -2122,13 +2066,42 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EndpointsInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EndpointsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectGroupsInfo"}}
}
}}
}
- }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/project-group/stat": {
+ "post": {
+ "tags": ["identity > project-group"],
+ "summary": "Stat",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
},"/identity/user-profile/update": {
"post": {
"tags": ["identity > user-profile"],
@@ -2378,18 +2351,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/create": {
+ },"/identity/domain/create": {
"post": {
- "tags": ["identity > service-account"],
+ "tags": ["identity > domain"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data||Struct|True|\n |provider||string|True|\n |project_id||string|True|\n |secret_schema_id||string||\n |secret_data||Struct||\n |tags||Struct||\n |trusted_account_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |admin||Admin|True|\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"provider" : {"type": "string","title": "PROVIDER" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" },"tags" : {"type": "object","title": "TAGS" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"admin" : {"$ref": "#/components/schemas/Admin","title": "ADMIN" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -2400,25 +2373,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/update": {
+ },"/identity/domain/update": {
"post": {
- "tags": ["identity > service-account"],
+ "tags": ["identity > domain"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n |name||string||\n |data||Struct||\n |tags||Struct||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"tags" : {"type": "object","title": "TAGS" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -2429,25 +2402,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/update-secret-data": {
+ },"/identity/domain/delete": {
"post": {
- "tags": ["identity > service-account"],
- "summary": "Update Secret Data",
+ "tags": ["identity > domain"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n |trusted_account_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2456,27 +2429,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/delete-secret-data": {
+ },"/identity/domain/enable": {
"post": {
- "tags": ["identity > service-account"],
- "summary": "Delete Secret Data",
+ "tags": ["identity > domain"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2487,25 +2454,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/delete": {
+ },"/identity/domain/disable": {
"post": {
- "tags": ["identity > service-account"],
- "summary": "Delete",
+ "tags": ["identity > domain"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2514,21 +2481,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/get": {
+ },"/identity/domain/get": {
"post": {
- "tags": ["identity > service-account"],
+ "tags": ["identity > domain"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
+ "properties": {"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
"examples":{"Schema":{}
}
@@ -2539,25 +2512,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/DomainInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DomainInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/list": {
+ },"/identity/domain/get-auth-info": {
"post": {
- "tags": ["identity > service-account"],
- "summary": "List",
+ "tags": ["identity > domain"],
+ "summary": "Get Auth Info",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |service_account_id||string||\n |name||string||\n |state||string||\n |provider||string||\n |workspace_id||string||\n |project_id||string||\n |trusted_account_id||string||\n |secret_schema_id||string||\n |secret_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" } }
},
"examples":{"Schema":{}
}
@@ -2568,25 +2541,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ServiceAccountsInfo"},
+ "schema": {"$ref": "#/components/schemas/DomainAuthInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ServiceAccountsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/DomainAuthInfo"}}
}
}}
}
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/service-account/stat": {
+ }
+ },"/identity/domain/list": {
"post": {
- "tags": ["identity > service-account"],
- "summary": "Stat",
+ "tags": ["identity > domain"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |domain_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" } }
},
"examples":{"Schema":{}
}
@@ -2597,56 +2570,50 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/DomainsInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/DomainsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/create": {
+ },"/identity/job/delete": {
"post": {
- "tags": ["identity > user"],
- "summary": "Create",
+ "tags": ["identity > job"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \nYou can create user. after create user you have to binding role to user.\nSee role-binding create api.\nExternal type user do not need password.",
+ "description": "### Description \nDeletes a specific Job. You must specify the `job_id` of the Job to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |auth_type|LOCAL, EXTERNAL |string|True|\n |reset_password|If reset_password is true, send email|boolean|True|\n |password|When auth_type is LOCAL, password is required. |string||\n |name||string||\n |email||string||\n |language|en,ko |string||\n |timezone|UTC, Asia/Seoul |string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "string","title": "AUTH_TYPE" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
+ "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"wonny@cloudforet.io\",\n \"password\": \"Password1234!\",\n \"name\": \"Wonny\",\n \"email\": \"wonny@cloudforet.io\",\n \"auth_type\": \"LOCAL\",\n \"language\": \"en\",\n \"timezone\": \"UTC\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/update": {
+ },"/identity/job/get": {
"post": {
- "tags": ["identity > user"],
- "summary": "Update",
+ "tags": ["identity > job"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nUpdate user info by given user_id",
+ "description": "### Description \nGets a specific Job. Prints detailed information about the Job, including its state.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |password||string||\n |name||string||\n |email||string||\n |language||string||\n |timezone||string||\n |tags||Struct||\n |reset_password||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"password" : {"type": "string","title": "PASSWORD" },"name" : {"type": "string","title": "NAME" },"email" : {"type": "string","title": "EMAIL" },"language" : {"type": "string","title": "LANGUAGE" },"timezone" : {"type": "string","title": "TIMEZONE" },"tags" : {"type": "object","title": "TAGS" },"reset_password" : {"type": "boolean","title": "RESET_PASSWORD" } }
+ "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
@@ -2655,50 +2622,89 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/JobInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"}}
+ "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
+ "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/verify-email": {
+ },"/identity/job/list": {
"post": {
- "tags": ["identity > user"],
- "summary": "Verify Email",
+ "tags": ["identity > job"],
+ "summary": "List",
+ "operationId" : "",
+ "description": "### Description \nGets a list of all Jobs. You can use a query to get a filtered list of Jobs.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_id||string||\n |status|PENDING, IN_PROGRESS, FAILURE, SUCCESS, CANCELED |string||\n |workspace_id||string||\n |trusted_account_id||string||\n |plugin_id||string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_id" : {"type": "string","title": "JOB_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/JobsInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/JobsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"job_id\": \"job-3b124006c2d2\",\n \"status\": \"SUCCESS\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-3b124006c2d2\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:01.225Z\",\n \"updated_at\": \"2022-06-17T08:00:01.225Z\",\n \"finished_at\": \"2022-06-17T08:00:15.197Z\"\n },\n {\n \"job_id\": \"job-587a3d3b4db3\",\n \"status\": \"SUCCESS\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-587a3d3b4db3\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.407Z\",\n \"updated_at\": \"2022-06-17T08:00:00.407Z\",\n \"finished_at\": \"2022-06-17T08:07:32.023Z\"\n }\n ],\n \"total_count\": 2\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/job/stat": {
+ "post": {
+ "tags": ["identity > job"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |email||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"email" : {"type": "string","title": "EMAIL" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"email\": \"example@cloudforet.com\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/disable-mfa": {
+ },"/identity/role/create": {
"post": {
- "tags": ["identity > user"],
- "summary": "Disable Mfa",
+ "tags": ["identity > role"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nDisable MFA for user. If this api is called, send email to user.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER, WORKSPACE_MEMBER |string|True|\n |permissions||array||\n |page_access||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"page_access" : {"items": {}, "type": "array","title": "PAGE_ACCESS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2707,27 +2713,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/set-required-actions": {
+ },"/identity/role/update": {
"post": {
- "tags": ["identity > user"],
- "summary": "Set Required Actions",
+ "tags": ["identity > role"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n |required_actions| |array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n |name||string||\n |permissions||array||\n |page_access||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" },"required_actions" : {"items": {}, "type": "array","title": "REQUIRED_ACTIONS" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" },"page_access" : {"items": {}, "type": "array","title": "PAGE_ACCESS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\",\n \"required_actions\": [\"UPDATE_PASSWORD\"]\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2736,27 +2742,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/enable": {
+ },"/identity/role/enable": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > role"],
"summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2765,27 +2771,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/disable": {
+ },"/identity/role/disable": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > role"],
"summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2794,27 +2800,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/delete": {
+ },"/identity/role/delete": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > role"],
"summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2824,20 +2830,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/get": {
+ },"/identity/role/get": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > role"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |role_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_id" : {"type": "string","title": "USER_ID" } }
+ "properties": {"role_id" : {"type": "string","title": "ROLE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_id\": \"example@cloudforet.com\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"role_id\": \"role-a12335a6a4fe\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2846,25 +2852,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserInfo"},
+ "schema": {"$ref": "#/components/schemas/RoleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RoleInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/list": {
+ },"/identity/role/list": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > role"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_id||string||\n |name||string||\n |state|ENABLED, DISABLED, PENDING |string||\n |email||string||\n |auth_type|LOCAL, EXTERNAL |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |role_id||string||\n |name||string||\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER, WORKSPACE_MEMBER |string||\n |state|ENABLED, DISABLED |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_id" : {"type": "string","title": "USER_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"email" : {"type": "string","title": "EMAIL" },"auth_type" : {"type": "string","title": "AUTH_TYPE" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"role_id" : {"type": "string","title": "ROLE_ID" },"name" : {"type": "string","title": "NAME" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"state" : {"type": "string","title": "STATE" } }
},
"examples":{"Schema":{}
}
@@ -2875,16 +2881,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UsersInfo"},
+ "schema": {"$ref": "#/components/schemas/RolesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UsersInfo"}}
+ "Schema": {"$ref": "#/components/schemas/RolesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/user/stat": {
+ },"/identity/role/stat": {
"post": {
- "tags": ["identity > user"],
+ "tags": ["identity > role"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -2911,18 +2917,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/create": {
+ },"/identity/schema/create": {
"post": {
- "tags": ["identity > app"],
+ "tags": ["identity > schema"],
"summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |role_id||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |tags||Struct||\n |expired_at||string||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n |name||string|True|\n |schema_type|SERVICE_ACCOUNT, TRUSTED_ACCOUNT, SECRET, TRUSTING_SECRET |string|True|\n |provider||string|True|\n |schema||Struct||\n |related_schemas||array||\n |options||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"role_id" : {"type": "string","title": "ROLE_ID" },"tags" : {"type": "object","title": "TAGS" },"expired_at" : {"type": "string","title": "EXPIRED_AT" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" },"name" : {"type": "string","title": "NAME" },"schema_type" : {"type": "string","title": "SCHEMA_TYPE" },"schema" : {"type": "object","title": "SCHEMA" },"provider" : {"type": "string","title": "PROVIDER" },"related_schemas" : {"items": {}, "type": "array","title": "RELATED_SCHEMAS" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -2933,25 +2939,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AppInfo"},
+ "schema": {"$ref": "#/components/schemas/SchemaInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AppInfo"}}
+ "Schema": {"$ref": "#/components/schemas/SchemaInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/update": {
+ },"/identity/schema/update": {
"post": {
- "tags": ["identity > app"],
+ "tags": ["identity > schema"],
"summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n |name||string||\n |schema||Struct||\n |related_schemas||array||\n |options||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"app_id" : {"type": "string","title": "APP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" },"name" : {"type": "string","title": "NAME" },"schema" : {"type": "object","title": "SCHEMA" },"related_schemas" : {"items": {}, "type": "array","title": "RELATED_SCHEMAS" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -2962,25 +2968,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AppInfo"},
+ "schema": {"$ref": "#/components/schemas/SchemaInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AppInfo"}}
+ "Schema": {"$ref": "#/components/schemas/SchemaInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/generate-client-secret": {
+ },"/identity/schema/delete": {
"post": {
- "tags": ["identity > app"],
- "summary": "Generate Client Secret",
+ "tags": ["identity > schema"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n |expired_at||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"app_id" : {"type": "string","title": "APP_ID" },"expired_at" : {"type": "string","title": "EXPIRED_AT" } }
+ "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" } }
},
"examples":{"Schema":{}
}
@@ -2989,27 +2995,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/AppInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/AppInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/enable": {
+ },"/identity/schema/get": {
"post": {
- "tags": ["identity > app"],
- "summary": "Enable",
+ "tags": ["identity > schema"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |schema_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
+ "properties": {"schema_id" : {"type": "string","title": "SCHEMA_ID" } }
},
"examples":{"Schema":{}
}
@@ -3020,25 +3020,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AppInfo"},
+ "schema": {"$ref": "#/components/schemas/SchemaInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AppInfo"}}
+ "Schema": {"$ref": "#/components/schemas/SchemaInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/disable": {
+ },"/identity/schema/list": {
"post": {
- "tags": ["identity > app"],
- "summary": "Disable",
+ "tags": ["identity > schema"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |schema_id||string||\n |name||string||\n |schema_type|SERVICE_ACCOUNT, TRUSTED_ACCOUNT, SECRET, TRUSTING_SECRET |string||\n |provider||string||\n |related_schema_id||string||\n |is_managed||boolean||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"name" : {"type": "string","title": "NAME" },"schema_type" : {"type": "string","title": "SCHEMA_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"related_schema_id" : {"type": "string","title": "RELATED_SCHEMA_ID" },"is_managed" : {"type": "boolean","title": "IS_MANAGED" } }
},
"examples":{"Schema":{}
}
@@ -3049,25 +3049,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AppInfo"},
+ "schema": {"$ref": "#/components/schemas/SchemasInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AppInfo"}}
+ "Schema": {"$ref": "#/components/schemas/SchemasInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/delete": {
+ },"/identity/schema/stat": {
"post": {
- "tags": ["identity > app"],
- "summary": "Delete",
+ "tags": ["identity > schema"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -3076,21 +3076,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/get": {
+ },"/identity/app/create": {
"post": {
"tags": ["identity > app"],
- "summary": "Get",
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |role_id||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |tags||Struct||\n |expired_at||string||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"role_id" : {"type": "string","title": "ROLE_ID" },"tags" : {"type": "object","title": "TAGS" },"expired_at" : {"type": "string","title": "EXPIRED_AT" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -3108,18 +3114,18 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/list": {
+ },"/identity/app/update": {
"post": {
"tags": ["identity > app"],
- "summary": "List",
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |app_id||string||\n |name||string||\n |state|ENABLED, DISABLED, EXPIRED |string||\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER |string||\n |workspace_id||string||\n |role_id||string||\n |client_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"app_id" : {"type": "string","title": "APP_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"client_id" : {"type": "string","title": "CLIENT_ID" } }
+ "properties": {"app_id" : {"type": "string","title": "APP_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -3130,25 +3136,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AppsInfo"},
+ "schema": {"$ref": "#/components/schemas/AppInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AppsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AppInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/app/stat": {
+ },"/identity/app/generate-client-secret": {
"post": {
"tags": ["identity > app"],
- "summary": "Stat",
+ "summary": "Generate Client Secret",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n |expired_at||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"app_id" : {"type": "string","title": "APP_ID" },"expired_at" : {"type": "string","title": "EXPIRED_AT" } }
},
"examples":{"Schema":{}
}
@@ -3159,25 +3165,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/AppInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/AppInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/external-auth/set": {
+ },"/identity/app/enable": {
"post": {
- "tags": ["identity > external-auth"],
- "summary": "Set",
+ "tags": ["identity > app"],
+ "summary": "Enable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_info||PluginRequest|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"plugin_info" : {"type": "PluginRequest","title": "PLUGIN_INFO" } }
+ "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
},
"examples":{"Schema":{}
}
@@ -3188,25 +3194,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ExternalAuthInfo"},
+ "schema": {"$ref": "#/components/schemas/AppInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ExternalAuthInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AppInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/external-auth/unset": {
+ },"/identity/app/disable": {
"post": {
- "tags": ["identity > external-auth"],
- "summary": "Unset",
+ "tags": ["identity > app"],
+ "summary": "Disable",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": { }
+ "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
},
"examples":{"Schema":{}
}
@@ -3217,25 +3223,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ExternalAuthInfo"},
+ "schema": {"$ref": "#/components/schemas/AppInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ExternalAuthInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AppInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/external-auth/get": {
+ },"/identity/app/delete": {
"post": {
- "tags": ["identity > external-auth"],
- "summary": "Get",
+ "tags": ["identity > app"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": { }
+ "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
},
"examples":{"Schema":{}
}
@@ -3244,27 +3250,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/ExternalAuthInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/ExternalAuthInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/token/issue": {
+ },"/identity/app/get": {
"post": {
- "tags": ["identity > token"],
- "summary": "Issue",
+ "tags": ["identity > app"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |credentials||Struct|True|\n |domain_id||string|True|\n |auth_type|LOCAL, EXTERNAL, MFA LOCAL, EXTERNAL |string||\n |timeout||int||\n |verify_code|if MFA is enabled, verify_code is required |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |app_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"credentials" : {"type": "object","title": "CREDENTIALS" },"auth_type" : {"type": "string","title": "AUTH_TYPE" },"timeout" : {"type": "integer","title": "TIMEOUT" },"verify_code" : {"type": "string","title": "VERIFY_CODE" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"app_id" : {"type": "string","title": "APP_ID" } }
},
"examples":{"Schema":{}
}
@@ -3275,25 +3275,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TokenInfo"},
+ "schema": {"$ref": "#/components/schemas/AppInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TokenInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AppInfo"}}
}
}}
}
- }
- },"/identity/token/grant": {
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/app/list": {
"post": {
- "tags": ["identity > token"],
- "summary": "Grant",
+ "tags": ["identity > app"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |grant_type|REFRESH_TOKEN, SYSTEM_TOKEN |string|True|\n |token||string|True|\n |scope|SYSTEM, DOMAIN, WORKSPACE, PROJECT, USER |string|True|\n |timeout||int||\n |workspace_id||string||\n |domain_id||string||\n |permissions||array||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |app_id||string||\n |name||string||\n |state|ENABLED, DISABLED, EXPIRED |string||\n |role_type|DOMAIN_ADMIN, WORKSPACE_OWNER |string||\n |workspace_id||string||\n |role_id||string||\n |client_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"grant_type" : {"type": "string","title": "GRANT_TYPE" },"token" : {"type": "string","title": "TOKEN" },"scope" : {"type": "string","title": "SCOPE" },"timeout" : {"type": "integer","title": "TIMEOUT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"domain_id" : {"type": "string","title": "DOMAIN_ID" },"permissions" : {"items": {}, "type": "array","title": "PERMISSIONS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"app_id" : {"type": "string","title": "APP_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"role_type" : {"type": "string","title": "ROLE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"role_id" : {"type": "string","title": "ROLE_ID" },"client_id" : {"type": "string","title": "CLIENT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3304,25 +3304,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/GrantTokenInfo"},
+ "schema": {"$ref": "#/components/schemas/AppsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/GrantTokenInfo"}}
+ "Schema": {"$ref": "#/components/schemas/AppsInfo"}}
}
}}
}
- }
- },"/identity/workspace/create": {
+ ,"security": [{"HTTPBearer": []}] }
+ },"/identity/app/stat": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "Create",
+ "tags": ["identity > app"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |tags||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -3333,25 +3333,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace/update": {
+ },"/identity/endpoint/list": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "Update",
+ "tags": ["identity > endpoint"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |service||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"service" : {"type": "string","title": "SERVICE" } }
},
"examples":{"Schema":{}
}
@@ -3362,25 +3362,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
+ "schema": {"$ref": "#/components/schemas/EndpointsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
+ "Schema": {"$ref": "#/components/schemas/EndpointsInfo"}}
}
}}
}
- ,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace/delete": {
+ }
+ },"/identity/service-account/create": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "Delete",
+ "tags": ["identity > service-account"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n |force||boolean|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data||Struct|True|\n |provider||string|True|\n |project_id||string|True|\n |secret_schema_id||string||\n |secret_data||Struct||\n |tags||Struct||\n |trusted_account_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"force" : {"type": "boolean","title": "FORCE" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"provider" : {"type": "string","title": "PROVIDER" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" },"tags" : {"type": "object","title": "TAGS" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3389,21 +3389,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace/enable": {
+ },"/identity/service-account/update": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "Enable",
+ "tags": ["identity > service-account"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n |name||string||\n |data||Struct||\n |tags||Struct||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"tags" : {"type": "object","title": "TAGS" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3414,25 +3420,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
+ "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace/disable": {
+ },"/identity/service-account/update-secret-data": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "Disable",
+ "tags": ["identity > service-account"],
+ "summary": "Update Secret Data",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n |trusted_account_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3443,25 +3449,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
+ "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace/get": {
+ },"/identity/service-account/delete-secret-data": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "Get",
+ "tags": ["identity > service-account"],
+ "summary": "Delete Secret Data",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |workspace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3472,25 +3478,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspaceInfo"},
+ "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspaceInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace/list": {
+ },"/identity/service-account/delete": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "List",
+ "tags": ["identity > service-account"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |workspace_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |created_by||string||\n |is_managed||boolean||\n |is_dormant||boolean||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"created_by" : {"type": "string","title": "CREATED_BY" },"is_managed" : {"type": "boolean","title": "IS_MANAGED" },"is_dormant" : {"type": "boolean","title": "IS_DORMANT" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3499,27 +3505,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/WorkspacesInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/WorkspacesInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/workspace/stat": {
+ },"/identity/service-account/get": {
"post": {
- "tags": ["identity > workspace"],
- "summary": "Stat",
+ "tags": ["identity > service-account"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service_account_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3530,27 +3530,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/ServiceAccountInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/ServiceAccountInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/create": {
+ },"/identity/service-account/list": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "Create",
+ "tags": ["identity > service-account"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data|Base Information of Trusted Account. It depends on provider.|Struct|True|\n |provider||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |schedule||Scheduled||\n |sync_options||Struct||\n |plugin_options||Struct||\n |tags||Struct||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |service_account_id||string||\n |name||string||\n |state||string||\n |provider||string||\n |workspace_id||string||\n |project_id||string||\n |trusted_account_id||string||\n |secret_schema_id||string||\n |secret_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"provider" : {"type": "string","title": "PROVIDER" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"sync_options" : {"type": "object","title": "SYNC_OPTIONS" },"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"Trusted Account\",\n \"data\": {\n \"account_id\": \"123456789\",\n }\n \"provider\": \"aws\",\n \"secret_schema_id\": \"aws-secret-access-key\",\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [3, 15]\n },\n \"resource_group\": \"DOMAIN\",\n \"workspace_id\": \"*\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -3559,25 +3559,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/ServiceAccountsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ServiceAccountsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/update": {
+ },"/identity/service-account/stat": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "Update",
+ "tags": ["identity > service-account"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n |tags||Struct|True|\n |name||string||\n |data||Struct||\n |schedule||Scheduled||\n |sync_options||Struct||\n |plugin_options||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"sync_options" : {"type": "object","title": "SYNC_OPTIONS" },"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -3588,25 +3588,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/update-secret-data": {
+ },"/identity/project/create": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "Update Secret Data",
+ "tags": ["identity > project"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n |secret_schema_id||string|True|\n |secret_data||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |project_type|PRIVATE, PUBLIC |string|True|\n |tags||Struct||\n |project_group_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"secret_data" : {"type": "object","title": "SECRET_DATA" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"project_type" : {"type": "string","title": "PROJECT_TYPE" },"tags" : {"type": "object","title": "TAGS" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
},
"examples":{"Schema":{}
}
@@ -3617,25 +3617,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/delete": {
+ },"/identity/project/update": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "Delete",
+ "tags": ["identity > project"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Schema":{}
}
@@ -3644,21 +3644,27 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/sync": {
+ },"/identity/project/update-project-type": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "Sync",
+ "tags": ["identity > project"],
+ "summary": "Update Project Type",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |project_type|PRIVATE, PUBLIC |string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"project_type" : {"type": "string","title": "PROJECT_TYPE" } }
},
"examples":{"Schema":{}
}
@@ -3669,27 +3675,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
- "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/get": {
+ },"/identity/project/change-project-group": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "Get",
+ "tags": ["identity > project"],
+ "summary": "Change Project Group",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_account_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |project_group_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
},
"examples":{"Schema":{}
}
@@ -3700,25 +3704,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedAccountInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedAccountInfo"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/list": {
+ },"/identity/project/delete": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "List",
+ "tags": ["identity > project"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |trusted_account_id||string||\n |name||string||\n |provider||string||\n |workspace_id||string||\n |secret_schema_id||string||\n |trusted_secret_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"name" : {"type": "string","title": "NAME" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID" },"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
"examples":{"Schema":{}
}
@@ -3727,27 +3731,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedAccountsInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedAccountsInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/trusted-account/stat": {
+ },"/identity/project/add-users": {
"post": {
- "tags": ["identity > trusted-account"],
- "summary": "Stat",
+ "tags": ["identity > project"],
+ "summary": "Add Users",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |users||array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
},
"examples":{"Schema":{}
}
@@ -3758,50 +3756,56 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/job/delete": {
+ },"/identity/project/remove-users": {
"post": {
- "tags": ["identity > job"],
- "summary": "Delete",
+ "tags": ["identity > project"],
+ "summary": "Remove Users",
"operationId" : "",
- "description": "### Description \nDeletes a specific Job. You must specify the `job_id` of the Job to delete.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |users||array|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"users" : {"items": {}, "type": "array","title": "USERS" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/job/get": {
+ },"/identity/project/get": {
"post": {
- "tags": ["identity > job"],
+ "tags": ["identity > project"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a specific Job. Prints detailed information about the Job, including its state.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -3810,29 +3814,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
- "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/job/list": {
+ },"/identity/project/list": {
"post": {
- "tags": ["identity > job"],
+ "tags": ["identity > project"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Jobs. You can use a query to get a filtered list of Jobs.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_id||string||\n |status|PENDING, IN_PROGRESS, FAILURE, SUCCESS, CANCELED |string||\n |workspace_id||string||\n |trusted_account_id||string||\n |plugin_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |project_id||string||\n |name||string||\n |project_type|PRIVATE, PUBLIC |string||\n |created_by||string||\n |include_children||boolean||\n |workspace_id||string||\n |project_group_id||string||\n |user_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_id" : {"type": "string","title": "JOB_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"name" : {"type": "string","title": "NAME" },"project_type" : {"type": "string","title": "PROJECT_TYPE" },"created_by" : {"type": "string","title": "CREATED_BY" },"include_children" : {"type": "boolean","title": "INCLUDE_CHILDREN" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" },"user_id" : {"type": "string","title": "USER_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -3841,18 +3843,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobsInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"job_id\": \"job-3b124006c2d2\",\n \"status\": \"SUCCESS\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-3b124006c2d2\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:01.225Z\",\n \"updated_at\": \"2022-06-17T08:00:01.225Z\",\n \"finished_at\": \"2022-06-17T08:00:15.197Z\"\n },\n {\n \"job_id\": \"job-587a3d3b4db3\",\n \"status\": \"SUCCESS\",\n \"resource_group\": \"DOMAIN\",\n \"plugin_id\": \"plugin-aws-cloud-service-inven-collector\",\n \"trusted_account_id\": \"ta-587a3d3b4db3\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.407Z\",\n \"updated_at\": \"2022-06-17T08:00:00.407Z\",\n \"finished_at\": \"2022-06-17T08:07:32.023Z\"\n }\n ],\n \"total_count\": 2\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ProjectsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/identity/job/stat": {
+ },"/identity/project/stat": {
"post": {
- "tags": ["identity > job"],
+ "tags": ["identity > project"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -3883,135 +3883,87 @@
},
"components":{
"schemas": {
- "Admin": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"password" : {"type": "string","title": "PASSWORD"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
- "type": "object",
- "required": ["user_id","name","password"],
- "title": "Admin"
- }
- , "CreateDomainRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"admin" : {"$ref": "#/components/schemas/Admin","title": "ADMIN"},"tags" : {"type": "object","title": "TAGS"}},
+ "CreateUserGroupRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["name","admin"],
- "title": "CreateDomainRequest"
+ "required": ["name"],
+ "title": "CreateUserGroupRequest"
}
- , "DomainAuthInfo": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"external_auth_state" : {"type": "string","title": "EXTERNAL_AUTH_STATE"},"metadata" : {"type": "object","title": "METADATA"},"config" : {"type": "object","title": "CONFIG"}},
+ , "UpdateUserGroupRequest": {
+ "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["domain_id","name","external_auth_state","metadata","config"],
- "title": "DomainAuthInfo"
+ "required": ["user_group_id"],
+ "title": "UpdateUserGroupRequest"
}
- , "DomainInfo": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"tags" : {"type": "object","title": "TAGS"},"created_at" : {"type": "string","title": "CREATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
+ , "UserGroupInfo": {
+ "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"users" : {"items": {"type": "string"},
+ "type": "array","title": "USERS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["domain_id","name","state","tags","created_at","deleted_at"],
- "title": "DomainInfo"
+ "required": ["user_group_id","name","users","tags","domain_id","workspace_id","created_at"],
+ "title": "UserGroupInfo"
}
- , "DomainRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "UserGroupRequest": {
+ "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"}},
"type": "object",
- "required": ["domain_id"],
- "title": "DomainRequest"
+ "required": ["user_group_id"],
+ "title": "UserGroupRequest"
}
- , "DomainSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"}},
+ , "UserGroupSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"user_id" : {"type": "string","title": "USER_ID"}},
"type": "object",
"required": [],
- "title": "DomainSearchQuery"
+ "title": "UserGroupSearchQuery"
}
- , "DomainStatQuery": {
+ , "UserGroupStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "DomainStatQuery"
+ "title": "UserGroupStatQuery"
}
- , "DomainsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DomainInfo"},
- "type": "array","$ref": "#/components/schemas/DomainInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "UserGroupsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserGroupInfo"},
+ "type": "array","$ref": "#/components/schemas/UserGroupInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "DomainsInfo"
+ "title": "UserGroupsInfo"
}
- , "GetDomainAuthRequest": {
+ , "UsersUserGroupRequest": {
+ "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"users" : {"items": {"type": "string"},
+ "type": "array","title": "USERS"}},
+ "type": "object",
+ "required": ["user_group_id","users"],
+ "title": "UsersUserGroupRequest"
+ }
+ , "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
"required": ["name"],
- "title": "GetDomainAuthRequest"
+ "title": "AggregateCount"
}
- , "UpdateDomainRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "AggregateGroup": {
+ "properties" : {"keys" : {"items": {"$ref": "#/components/schemas/AggregateGroupKey"},
+ "type": "array","$ref": "#/components/schemas/AggregateGroupKey","title": "KEYS"},"fields" : {"items": {"$ref": "#/components/schemas/AggregateGroupField"},
+ "type": "array","$ref": "#/components/schemas/AggregateGroupField","title": "FIELDS"}},
"type": "object",
- "required": ["domain_id"],
- "title": "UpdateDomainRequest"
+ "required": ["keys","fields"],
+ "title": "AggregateGroup"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "AggregateGroupField": {
+ "properties" : {"key" : {"type": "string","title": "KEY"},"k" : {"type": "string","title": "K"},"name" : {"type": "string","title": "NAME"},"n" : {"type": "string","title": "N"},"operator" : {"type": "string","title": "OPERATOR"},"o" : {"type": "string","title": "O"},"fields" : {"items": {"$ref": "#/components/schemas/AggregateGroupSubField"},
+ "type": "array","$ref": "#/components/schemas/AggregateGroupSubField","title": "FIELDS"},"conditions" : {"items": {"$ref": "#/components/schemas/AggregateSubCondition"},
+ "type": "array","$ref": "#/components/schemas/AggregateSubCondition","title": "CONDITIONS"}},
"type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
+ "required": ["key","k","name","n","operator","o","fields","conditions"],
+ "title": "AggregateGroupField"
}
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ , "AggregateGroupKey": {
+ "properties" : {"key" : {"type": "string","title": "KEY"},"k" : {"type": "string","title": "K"},"name" : {"type": "string","title": "NAME"},"n" : {"type": "string","title": "N"},"date_format" : {"type": "string","title": "DATE_FORMAT"}},
"type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
+ "required": ["key","k","name","n","date_format"],
+ "title": "AggregateGroupKey"
}
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "string","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
- , "AggregateCount": {
- "properties" : {"name" : {"type": "string","title": "NAME"}},
- "type": "object",
- "required": ["name"],
- "title": "AggregateCount"
- }
- , "AggregateGroup": {
- "properties" : {"keys" : {"items": {"$ref": "#/components/schemas/AggregateGroupKey"},
- "type": "array","$ref": "#/components/schemas/AggregateGroupKey","title": "KEYS"},"fields" : {"items": {"$ref": "#/components/schemas/AggregateGroupField"},
- "type": "array","$ref": "#/components/schemas/AggregateGroupField","title": "FIELDS"}},
- "type": "object",
- "required": ["keys","fields"],
- "title": "AggregateGroup"
- }
- , "AggregateGroupField": {
- "properties" : {"key" : {"type": "string","title": "KEY"},"k" : {"type": "string","title": "K"},"name" : {"type": "string","title": "NAME"},"n" : {"type": "string","title": "N"},"operator" : {"type": "string","title": "OPERATOR"},"o" : {"type": "string","title": "O"},"fields" : {"items": {"$ref": "#/components/schemas/AggregateGroupSubField"},
- "type": "array","$ref": "#/components/schemas/AggregateGroupSubField","title": "FIELDS"},"conditions" : {"items": {"$ref": "#/components/schemas/AggregateSubCondition"},
- "type": "array","$ref": "#/components/schemas/AggregateSubCondition","title": "CONDITIONS"}},
- "type": "object",
- "required": ["key","k","name","n","operator","o","fields","conditions"],
- "title": "AggregateGroupField"
- }
- , "AggregateGroupKey": {
- "properties" : {"key" : {"type": "string","title": "KEY"},"k" : {"type": "string","title": "K"},"name" : {"type": "string","title": "NAME"},"n" : {"type": "string","title": "N"},"date_format" : {"type": "string","title": "DATE_FORMAT"}},
- "type": "object",
- "required": ["key","k","name","n","date_format"],
- "title": "AggregateGroupKey"
- }
- , "AggregateGroupSubField": {
- "properties" : {"key" : {"type": "string","title": "KEY"},"k" : {"type": "string","title": "K"},"name" : {"type": "string","title": "NAME"},"n" : {"type": "string","title": "N"}},
+ , "AggregateGroupSubField": {
+ "properties" : {"key" : {"type": "string","title": "KEY"},"k" : {"type": "string","title": "K"},"name" : {"type": "string","title": "NAME"},"n" : {"type": "string","title": "N"}},
"type": "object",
"required": ["key","k","name","n"],
"title": "AggregateGroupSubField"
@@ -4151,475 +4103,515 @@
"required": ["path","filter"],
"title": "Unwind"
}
- , "CreateRoleRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"permissions" : {"items": {"type": "string"},
- "type": "array","title": "PERMISSIONS"},"page_access" : {"items": {"type": "string"},
- "type": "array","title": "PAGE_ACCESS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["name","role_type"],
- "title": "CreateRoleRequest"
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
}
- , "RoleInfo": {
- "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"permissions" : {"items": {"type": "string"},
- "type": "array","title": "PERMISSIONS"},"page_access" : {"items": {"type": "string"},
- "type": "array","title": "PAGE_ACCESS"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"state" : {"type": "string","title": "STATE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
"type": "object",
- "required": ["role_id","name","role_type","permissions","page_access","tags","is_managed","state","domain_id","created_at","updated_at"],
- "title": "RoleInfo"
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
}
- , "RoleRequest": {
- "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"}},
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "string","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
"type": "object",
- "required": ["role_id"],
- "title": "RoleRequest"
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
}
- , "RoleSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"state" : {"type": "string","title": "STATE"}},
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
"type": "object",
- "required": [],
- "title": "RoleSearchQuery"
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
}
- , "RoleStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
"type": "object",
- "required": ["query"],
- "title": "RoleStatQuery"
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
}
- , "RolesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleInfo"},
- "type": "array","$ref": "#/components/schemas/RoleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "RolesInfo"
+ "required": ["version"],
+ "title": "VersionInfo"
}
- , "UpdateRoleRequest": {
- "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
- "type": "array","title": "PERMISSIONS"},"page_access" : {"items": {"type": "string"},
- "type": "array","title": "PAGE_ACCESS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "CreateUserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "string","title": "AUTH_TYPE"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
"type": "object",
- "required": ["role_id"],
- "title": "UpdateRoleRequest"
+ "required": ["user_id","auth_type","reset_password"],
+ "title": "CreateUserRequest"
}
- , "CreateUserGroupRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "DisableUserMFARequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"}},
"type": "object",
- "required": ["name"],
- "title": "CreateUserGroupRequest"
+ "required": ["user_id"],
+ "title": "DisableUserMFARequest"
}
- , "UpdateUserGroupRequest": {
- "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "MFA": {
+ "properties" : {"state" : {"type": "string","title": "STATE"},"mfa_type" : {"type": "string","title": "MFA_TYPE"},"options" : {"type": "object","title": "OPTIONS"}},
"type": "object",
- "required": ["user_group_id"],
- "title": "UpdateUserGroupRequest"
+ "required": ["state","mfa_type","options"],
+ "title": "MFA"
}
- , "UserGroupInfo": {
- "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"users" : {"items": {"type": "string"},
- "type": "array","title": "USERS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "SetRequiredActionsRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"required_actions" : {"items": {"type": "string"},
+ "type": "array","title": "REQUIRED_ACTIONS"}},
"type": "object",
- "required": ["user_group_id","name","users","tags","domain_id","workspace_id","created_at"],
- "title": "UserGroupInfo"
+ "required": ["user_id","required_actions"],
+ "title": "SetRequiredActionsRequest"
}
- , "UserGroupRequest": {
- "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"}},
+ , "UpdateUserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
"type": "object",
- "required": ["user_group_id"],
- "title": "UserGroupRequest"
+ "required": ["user_id"],
+ "title": "UpdateUserRequest"
}
- , "UserGroupSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"user_id" : {"type": "string","title": "USER_ID"}},
+ , "UserInfo": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"email_verified" : {"type": "boolean","title": "EMAIL_VERIFIED"},"auth_type" : {"type": "string","title": "AUTH_TYPE"},"role_id" : {"type": "string","title": "ROLE_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"mfa" : {"$ref": "#/components/schemas/MFA","title": "MFA"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"required_actions" : {"items": {"type": "string"},
+ "type": "array","title": "REQUIRED_ACTIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"}},
+ "type": "object",
+ "required": ["user_id","name","state","email","email_verified","auth_type","role_id","role_type","mfa","language","timezone","required_actions","tags","domain_id","created_at","last_accessed_at"],
+ "title": "UserInfo"
+ }
+ , "UserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"}},
+ "type": "object",
+ "required": ["user_id"],
+ "title": "UserRequest"
+ }
+ , "UserSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "string","title": "AUTH_TYPE"}},
"type": "object",
"required": [],
- "title": "UserGroupSearchQuery"
+ "title": "UserSearchQuery"
}
- , "UserGroupStatQuery": {
+ , "UserStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "UserGroupStatQuery"
+ "title": "UserStatQuery"
}
- , "UserGroupsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserGroupInfo"},
- "type": "array","$ref": "#/components/schemas/UserGroupInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "UsersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserInfo"},
+ "type": "array","$ref": "#/components/schemas/UserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "UserGroupsInfo"
+ "title": "UsersInfo"
}
- , "UsersUserGroupRequest": {
- "properties" : {"user_group_id" : {"type": "string","title": "USER_GROUP_ID"},"users" : {"items": {"type": "string"},
- "type": "array","title": "USERS"}},
+ , "VerifyUserEmailRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"email" : {"type": "string","title": "EMAIL"}},
"type": "object",
- "required": ["user_group_id","users"],
- "title": "UsersUserGroupRequest"
+ "required": ["user_id"],
+ "title": "VerifyUserEmailRequest"
}
- , "CreateRoleBindingRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "CreateTrustedAccountRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"sync_options" : {"type": "object","title": "SYNC_OPTIONS"},"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["user_id","role_id","resource_group"],
- "title": "CreateRoleBindingRequest"
+ "required": ["name","data","provider","secret_schema_id","secret_data","resource_group"],
+ "title": "CreateTrustedAccountRequest"
}
- , "RoleBindingInfo": {
- "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "Scheduled": {
+ "properties" : {"state" : {"type": "string","title": "STATE"},"hours" : {"items": {"type": "integer"},
+ "type": "array","title": "HOURS"}},
"type": "object",
- "required": ["role_binding_id","role_type","resource_group","domain_id","workspace_id","role_id","user_id","created_at"],
- "title": "RoleBindingInfo"
+ "required": ["state","hours"],
+ "title": "Scheduled"
}
- , "RoleBindingRequest": {
- "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"}},
+ , "TrustedAccountInfo": {
+ "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"sync_options" : {"type": "object","title": "SYNC_OPTIONS"},"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["role_binding_id"],
- "title": "RoleBindingRequest"
+ "required": ["trusted_account_id","name","data","provider","schedule","sync_options","plugin_options","tags","resource_group","domain_id","workspace_id","secret_schema_id","trusted_secret_id","created_at"],
+ "title": "TrustedAccountInfo"
}
- , "RoleBindingSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"user_id" : {"type": "string","title": "USER_ID"}},
+ , "TrustedAccountRequest": {
+ "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
+ "type": "object",
+ "required": ["trusted_account_id"],
+ "title": "TrustedAccountRequest"
+ }
+ , "TrustedAccountSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"}},
"type": "object",
"required": [],
- "title": "RoleBindingSearchQuery"
+ "title": "TrustedAccountSearchQuery"
}
- , "RoleBindingStatQuery": {
+ , "TrustedAccountStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "RoleBindingStatQuery"
+ "title": "TrustedAccountStatQuery"
}
- , "RoleBindingsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleBindingInfo"},
- "type": "array","$ref": "#/components/schemas/RoleBindingInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "TrustedAccountsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/TrustedAccountInfo"},
+ "type": "array","$ref": "#/components/schemas/TrustedAccountInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "RoleBindingsInfo"
+ "title": "TrustedAccountsInfo"
}
- , "UpdateRoleBindingRequest": {
- "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"role_id" : {"type": "string","title": "ROLE_ID"}},
+ , "UpdateTrustedAccountRequest": {
+ "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"sync_options" : {"type": "object","title": "SYNC_OPTIONS"},"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["role_binding_id","role_id"],
- "title": "UpdateRoleBindingRequest"
+ "required": ["trusted_account_id","tags"],
+ "title": "UpdateTrustedAccountRequest"
}
- , "CreateSchemaRequest": {
- "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema_type" : {"type": "string","title": "SCHEMA_TYPE"},"schema" : {"type": "object","title": "SCHEMA"},"provider" : {"type": "string","title": "PROVIDER"},"related_schemas" : {"items": {"type": "string"},
- "type": "array","title": "RELATED_SCHEMAS"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "UpdateTrustedAccountSecretRequest": {
+ "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"}},
"type": "object",
- "required": ["schema_id","name","schema_type","provider"],
- "title": "CreateSchemaRequest"
+ "required": ["trusted_account_id","secret_schema_id","secret_data"],
+ "title": "UpdateTrustedAccountSecretRequest"
}
- , "SchemaInfo": {
- "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema_type" : {"type": "string","title": "SCHEMA_TYPE"},"schema" : {"type": "object","title": "SCHEMA"},"provider" : {"type": "string","title": "PROVIDER"},"related_schemas" : {"items": {"type": "string"},
- "type": "array","title": "RELATED_SCHEMAS"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "CreateWorkspaceUserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "AuthType","title": "AUTH_TYPE"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"},"role_id" : {"type": "string","title": "ROLE_ID"}},
"type": "object",
- "required": ["schema_id","name","schema_type","schema","provider","related_schemas","options","tags","is_managed","domain_id","created_at","updated_at"],
- "title": "SchemaInfo"
+ "required": ["user_id","auth_type","reset_password","role_id"],
+ "title": "CreateWorkspaceUserRequest"
}
- , "SchemaRequest": {
- "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"}},
+ , "UserSummaryInfo": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"}},
"type": "object",
- "required": ["schema_id"],
- "title": "SchemaRequest"
+ "required": ["user_id","name","state"],
+ "title": "UserSummaryInfo"
}
- , "SchemaSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema_type" : {"type": "string","title": "SCHEMA_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"related_schema_id" : {"type": "string","title": "RELATED_SCHEMA_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"}},
+ , "UsersSummaryInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserSummaryInfo"},
+ "type": "array","$ref": "#/components/schemas/UserSummaryInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": [],
- "title": "SchemaSearchQuery"
+ "required": ["results","total_count"],
+ "title": "UsersSummaryInfo"
}
- , "SchemaStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "WorkspaceUserFindRequest": {
+ "properties" : {"keyword" : {"type": "string","title": "KEYWORD"},"state" : {"type": "string","title": "STATE"},"page" : {"$ref": "#/components/schemas/Page","title": "PAGE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["query"],
- "title": "SchemaStatQuery"
+ "required": ["keyword","workspace_id"],
+ "title": "WorkspaceUserFindRequest"
}
- , "SchemasInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/SchemaInfo"},
- "type": "array","$ref": "#/components/schemas/SchemaInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "WorkspaceUserInfo": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "AuthType","title": "AUTH_TYPE"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"api_key_count" : {"type": "integer","title": "API_KEY_COUNT"},"tags" : {"type": "object","title": "TAGS"},"role_binding_info" : {"$ref": "#/components/schemas/RoleBindingInfo","title": "ROLE_BINDING_INFO"},"email_verified" : {"type": "boolean","title": "EMAIL_VERIFIED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"}},
+ "type": "object",
+ "required": ["user_id","name","state","email","auth_type","role_type","language","timezone","api_key_count","tags","role_binding_info","email_verified","domain_id","created_at","last_accessed_at"],
+ "title": "WorkspaceUserInfo"
+ }
+ , "WorkspaceUserRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": ["user_id","workspace_id"],
+ "title": "WorkspaceUserRequest"
+ }
+ , "WorkspaceUserSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "AuthType","title": "AUTH_TYPE"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": ["workspace_id"],
+ "title": "WorkspaceUserSearchQuery"
+ }
+ , "WorkspaceUserStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": ["query","workspace_id"],
+ "title": "WorkspaceUserStatQuery"
+ }
+ , "WorkspaceUsersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/WorkspaceUserInfo"},
+ "type": "array","$ref": "#/components/schemas/WorkspaceUserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "SchemasInfo"
+ "title": "WorkspaceUsersInfo"
}
- , "UpdateSchemaRequest": {
- "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema" : {"type": "object","title": "SCHEMA"},"related_schemas" : {"items": {"type": "string"},
- "type": "array","title": "RELATED_SCHEMAS"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "GrantTokenInfo": {
+ "properties" : {"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"role_id" : {"type": "string","title": "ROLE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["schema_id"],
- "title": "UpdateSchemaRequest"
+ "required": ["access_token","role_type","role_id","domain_id","workspace_id"],
+ "title": "GrantTokenInfo"
}
- , "ChangeProjectGroupRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
+ , "GrantTokenRequest": {
+ "properties" : {"grant_type" : {"type": "string","title": "GRANT_TYPE"},"token" : {"type": "string","title": "TOKEN"},"scope" : {"type": "string","title": "SCOPE"},"timeout" : {"type": "integer","title": "TIMEOUT"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"permissions" : {"items": {"type": "string"},
+ "type": "array","title": "PERMISSIONS"}},
"type": "object",
- "required": ["project_id","project_group_id"],
- "title": "ChangeProjectGroupRequest"
+ "required": ["grant_type","token","scope"],
+ "title": "GrantTokenRequest"
}
- , "CreateProjectRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"project_type" : {"type": "string","title": "PROJECT_TYPE"},"tags" : {"type": "object","title": "TAGS"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
+ , "IssueTokenRequest": {
+ "properties" : {"credentials" : {"type": "object","title": "CREDENTIALS"},"auth_type" : {"type": "string","title": "AUTH_TYPE"},"timeout" : {"type": "integer","title": "TIMEOUT"},"verify_code" : {"type": "string","title": "VERIFY_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["name","project_type"],
- "title": "CreateProjectRequest"
+ "required": ["credentials","domain_id"],
+ "title": "IssueTokenRequest"
}
- , "ProjectInfo": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"project_type" : {"type": "string","title": "PROJECT_TYPE"},"tags" : {"type": "object","title": "TAGS"},"users" : {"items": {"type": "string"},
- "type": "array","title": "USERS"},"created_by" : {"type": "string","title": "CREATED_BY"},"reference_id" : {"type": "string","title": "REFERENCE_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"}},
+ , "TokenInfo": {
+ "properties" : {"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"refresh_token" : {"type": "string","title": "REFRESH_TOKEN"}},
"type": "object",
- "required": ["project_id","name","project_type","tags","users","created_by","reference_id","is_managed","domain_id","workspace_id","project_group_id","trusted_account_id","created_at","last_synced_at"],
- "title": "ProjectInfo"
+ "required": ["access_token","refresh_token"],
+ "title": "TokenInfo"
}
- , "ProjectRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "ExternalAuthInfo": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"state" : {"type": "string","title": "STATE"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["project_id"],
- "title": "ProjectRequest"
+ "required": ["domain_id","state","plugin_info","updated_at"],
+ "title": "ExternalAuthInfo"
}
- , "ProjectSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"project_type" : {"type": "string","title": "PROJECT_TYPE"},"created_by" : {"type": "string","title": "CREATED_BY"},"include_children" : {"type": "boolean","title": "INCLUDE_CHILDREN"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"}},
+ , "ExternalAuthRequest": {
+ "properties" : {},
"type": "object",
"required": [],
- "title": "ProjectSearchQuery"
+ "title": "ExternalAuthRequest"
}
- , "ProjectStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "SetExternalAuthRequest": {
+ "properties" : {"plugin_info" : {"type": "PluginRequest","title": "PLUGIN_INFO"}},
"type": "object",
- "required": ["query"],
- "title": "ProjectStatQuery"
+ "required": ["plugin_info"],
+ "title": "SetExternalAuthRequest"
}
- , "ProjectsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectInfo"},
- "type": "array","$ref": "#/components/schemas/ProjectInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "CreateWorkSpaceRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "ProjectsInfo"
+ "required": ["name","tags"],
+ "title": "CreateWorkSpaceRequest"
}
- , "UpdateProjectRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "UpdateWorkSpaceRequest": {
+ "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["project_id"],
- "title": "UpdateProjectRequest"
+ "required": ["workspace_id"],
+ "title": "UpdateWorkSpaceRequest"
}
- , "UpdateProjectTypeRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"project_type" : {"type": "string","title": "PROJECT_TYPE"}},
+ , "WorkspaceCheckRequest": {
+ "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["project_id","project_type"],
- "title": "UpdateProjectTypeRequest"
+ "required": ["workspace_id","domain_id"],
+ "title": "WorkspaceCheckRequest"
}
- , "UsersProjectRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"users" : {"items": {"type": "string"},
- "type": "array","title": "USERS"}},
+ , "WorkspaceCostInfo": {
+ "properties" : {"day" : {"type": "float","title": "DAY"},"month" : {"type": "float","title": "MONTH"}},
"type": "object",
- "required": ["project_id","users"],
- "title": "UsersProjectRequest"
+ "required": ["day","month"],
+ "title": "WorkspaceCostInfo"
}
- , "AgentInfo": {
- "properties" : {"agent_id" : {"type": "string","title": "AGENT_ID"},"options" : {"type": "object","title": "OPTIONS"},"client_secret" : {"type": "string","title": "CLIENT_SECRET"},"state" : {"type": "string","title": "STATE"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"app_id" : {"type": "string","title": "APP_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"client_id" : {"type": "string","title": "CLIENT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"expired_at" : {"type": "string","title": "EXPIRED_AT"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"}},
+ , "WorkspaceDeleteRequest": {
+ "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"force" : {"type": "boolean","title": "FORCE"}},
"type": "object",
- "required": ["agent_id","options","client_secret","state","is_managed","role_type","domain_id","workspace_id","project_id","service_account_id","app_id","role_id","client_id","created_at","expired_at","last_accessed_at"],
- "title": "AgentInfo"
+ "required": ["workspace_id","force"],
+ "title": "WorkspaceDeleteRequest"
}
- , "AgentRequest": {
- "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
+ , "WorkspaceInfo": {
+ "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"tags" : {"type": "object","title": "TAGS"},"created_by" : {"type": "string","title": "CREATED_BY"},"references" : {"items": {"type": "string"},
+ "type": "array","title": "REFERENCES"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"is_dormant" : {"type": "boolean","title": "IS_DORMANT"},"dormant_ttl" : {"type": "integer","title": "DORMANT_TTL"},"service_account_count" : {"type": "integer","title": "SERVICE_ACCOUNT_COUNT"},"cost_info" : {"$ref": "#/components/schemas/WorkspaceCostInfo","title": "COST_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"},"dormant_updated_at" : {"type": "string","title": "DORMANT_UPDATED_AT"}},
"type": "object",
- "required": ["service_account_id"],
- "title": "AgentRequest"
+ "required": ["workspace_id","name","state","tags","created_by","references","is_managed","is_dormant","dormant_ttl","service_account_count","cost_info","domain_id","trusted_account_id","created_at","last_synced_at","dormant_updated_at"],
+ "title": "WorkspaceInfo"
}
- , "AgentSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"agent_id" : {"type": "string","title": "AGENT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"state" : {"type": "string","title": "STATE"}},
+ , "WorkspaceRequest": {
+ "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": ["workspace_id"],
+ "title": "WorkspaceRequest"
+ }
+ , "WorkspaceSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"created_by" : {"type": "string","title": "CREATED_BY"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"is_dormant" : {"type": "boolean","title": "IS_DORMANT"}},
"type": "object",
"required": [],
- "title": "AgentSearchQuery"
+ "title": "WorkspaceSearchQuery"
}
- , "AgentsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/AgentInfo"},
- "type": "array","$ref": "#/components/schemas/AgentInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "WorkspaceStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "AgentsInfo"
+ "required": ["query"],
+ "title": "WorkspaceStatQuery"
}
- , "CreateAgentRequest": {
- "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"options" : {"type": "object","title": "OPTIONS"}},
+ , "WorkspacesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/WorkspaceInfo"},
+ "type": "array","$ref": "#/components/schemas/WorkspaceInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["service_account_id","options"],
- "title": "CreateAgentRequest"
+ "required": ["results","total_count"],
+ "title": "WorkspacesInfo"
}
- , "ChangeParentGroupRequest": {
- "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"}},
+ , "CreateProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"color" : {"type": "string","title": "COLOR"},"icon" : {"type": "string","title": "ICON"},"order" : {"type": "integer","title": "ORDER"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["project_group_id","parent_group_id"],
- "title": "ChangeParentGroupRequest"
+ "required": ["provider","name"],
+ "title": "CreateProviderRequest"
}
- , "CreateProjectGroupRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"}},
+ , "PluginInfo": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"},"options" : {"type": "object","title": "OPTIONS"},"metadata" : {"type": "object","title": "METADATA"}},
"type": "object",
- "required": ["name"],
- "title": "CreateProjectGroupRequest"
+ "required": ["plugin_id","version","upgrade_mode","options","metadata"],
+ "title": "PluginInfo"
}
- , "ProjectGroupInfo": {
- "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"users" : {"items": {"type": "string"},
- "type": "array","title": "USERS"},"reference_id" : {"type": "string","title": "REFERENCE_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"}},
+ , "ProviderInfo": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"color" : {"type": "string","title": "COLOR"},"icon" : {"type": "string","title": "ICON"},"order" : {"type": "integer","title": "ORDER"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["project_group_id","name","tags","users","reference_id","is_managed","domain_id","workspace_id","parent_group_id","trusted_account_id","created_at","last_synced_at"],
- "title": "ProjectGroupInfo"
+ "required": ["provider","name","alias","plugin_info","color","icon","order","options","tags","is_managed","domain_id","created_at","updated_at"],
+ "title": "ProviderInfo"
}
- , "ProjectGroupRequest": {
- "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
+ , "ProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"}},
"type": "object",
- "required": ["project_group_id"],
- "title": "ProjectGroupRequest"
+ "required": ["provider"],
+ "title": "ProviderRequest"
}
- , "ProjectGroupSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"}},
+ , "ProviderSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"}},
"type": "object",
"required": [],
- "title": "ProjectGroupSearchQuery"
+ "title": "ProviderSearchQuery"
}
- , "ProjectGroupStatQuery": {
+ , "ProviderStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "ProjectGroupStatQuery"
+ "title": "ProviderStatQuery"
}
- , "ProjectGroupsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectGroupInfo"},
- "type": "array","$ref": "#/components/schemas/ProjectGroupInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "ProvidersInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProviderInfo"},
+ "type": "array","$ref": "#/components/schemas/ProviderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "ProjectGroupsInfo"
+ "title": "ProvidersInfo"
}
- , "UpdateProjectGroupRequest": {
- "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "UpdatePluginProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
"type": "object",
- "required": ["project_group_id"],
- "title": "UpdateProjectGroupRequest"
+ "required": ["provider"],
+ "title": "UpdatePluginProviderRequest"
}
- , "UsersProjectGroupRequest": {
- "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"users" : {"items": {"type": "string"},
- "type": "array","title": "USERS"}},
+ , "UpdateProviderRequest": {
+ "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"color" : {"type": "string","title": "COLOR"},"icon" : {"type": "string","title": "ICON"},"order" : {"type": "integer","title": "ORDER"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["project_group_id","users"],
- "title": "UsersProjectGroupRequest"
+ "required": ["provider"],
+ "title": "UpdateProviderRequest"
}
- , "CreateWorkspaceUserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "AuthType","title": "AUTH_TYPE"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"},"role_id" : {"type": "string","title": "ROLE_ID"}},
+ , "AgentInfo": {
+ "properties" : {"agent_id" : {"type": "string","title": "AGENT_ID"},"options" : {"type": "object","title": "OPTIONS"},"client_secret" : {"type": "string","title": "CLIENT_SECRET"},"state" : {"type": "string","title": "STATE"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"app_id" : {"type": "string","title": "APP_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"client_id" : {"type": "string","title": "CLIENT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"expired_at" : {"type": "string","title": "EXPIRED_AT"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"}},
"type": "object",
- "required": ["user_id","auth_type","reset_password","role_id"],
- "title": "CreateWorkspaceUserRequest"
+ "required": ["agent_id","options","client_secret","state","is_managed","role_type","domain_id","workspace_id","project_id","service_account_id","app_id","role_id","client_id","created_at","expired_at","last_accessed_at"],
+ "title": "AgentInfo"
}
- , "UserSummaryInfo": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"}},
+ , "AgentRequest": {
+ "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
"type": "object",
- "required": ["user_id","name","state"],
- "title": "UserSummaryInfo"
+ "required": ["service_account_id"],
+ "title": "AgentRequest"
}
- , "UsersSummaryInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserSummaryInfo"},
- "type": "array","$ref": "#/components/schemas/UserSummaryInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "AgentSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"agent_id" : {"type": "string","title": "AGENT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"state" : {"type": "string","title": "STATE"}},
+ "type": "object",
+ "required": [],
+ "title": "AgentSearchQuery"
+ }
+ , "AgentsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/AgentInfo"},
+ "type": "array","$ref": "#/components/schemas/AgentInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "UsersSummaryInfo"
+ "title": "AgentsInfo"
}
- , "WorkspaceUserFindRequest": {
- "properties" : {"keyword" : {"type": "string","title": "KEYWORD"},"state" : {"type": "string","title": "STATE"},"page" : {"$ref": "#/components/schemas/Page","title": "PAGE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "CreateAgentRequest": {
+ "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"options" : {"type": "object","title": "OPTIONS"}},
"type": "object",
- "required": ["keyword","workspace_id"],
- "title": "WorkspaceUserFindRequest"
+ "required": ["service_account_id","options"],
+ "title": "CreateAgentRequest"
}
- , "WorkspaceUserInfo": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "AuthType","title": "AUTH_TYPE"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"api_key_count" : {"type": "integer","title": "API_KEY_COUNT"},"tags" : {"type": "object","title": "TAGS"},"role_binding_info" : {"$ref": "#/components/schemas/RoleBindingInfo","title": "ROLE_BINDING_INFO"},"email_verified" : {"type": "boolean","title": "EMAIL_VERIFIED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"}},
+ , "CreateRoleBindingRequest": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["user_id","name","state","email","auth_type","role_type","language","timezone","api_key_count","tags","role_binding_info","email_verified","domain_id","created_at","last_accessed_at"],
- "title": "WorkspaceUserInfo"
+ "required": ["user_id","role_id","resource_group"],
+ "title": "CreateRoleBindingRequest"
}
- , "WorkspaceUserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "RoleBindingInfo": {
+ "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["user_id","workspace_id"],
- "title": "WorkspaceUserRequest"
+ "required": ["role_binding_id","role_type","resource_group","domain_id","workspace_id","role_id","user_id","created_at"],
+ "title": "RoleBindingInfo"
}
- , "WorkspaceUserSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "AuthType","title": "AUTH_TYPE"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "RoleBindingRequest": {
+ "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"}},
"type": "object",
- "required": ["workspace_id"],
- "title": "WorkspaceUserSearchQuery"
+ "required": ["role_binding_id"],
+ "title": "RoleBindingRequest"
}
- , "WorkspaceUserStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "RoleBindingSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"role_id" : {"type": "string","title": "ROLE_ID"},"user_id" : {"type": "string","title": "USER_ID"}},
"type": "object",
- "required": ["query","workspace_id"],
- "title": "WorkspaceUserStatQuery"
+ "required": [],
+ "title": "RoleBindingSearchQuery"
}
- , "WorkspaceUsersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/WorkspaceUserInfo"},
- "type": "array","$ref": "#/components/schemas/WorkspaceUserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "RoleBindingStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "RoleBindingStatQuery"
+ }
+ , "RoleBindingsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleBindingInfo"},
+ "type": "array","$ref": "#/components/schemas/RoleBindingInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "WorkspaceUsersInfo"
+ "title": "RoleBindingsInfo"
}
- , "CreateProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"color" : {"type": "string","title": "COLOR"},"icon" : {"type": "string","title": "ICON"},"order" : {"type": "integer","title": "ORDER"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "UpdateRoleBindingRequest": {
+ "properties" : {"role_binding_id" : {"type": "string","title": "ROLE_BINDING_ID"},"role_id" : {"type": "string","title": "ROLE_ID"}},
"type": "object",
- "required": ["provider","name"],
- "title": "CreateProviderRequest"
+ "required": ["role_binding_id","role_id"],
+ "title": "UpdateRoleBindingRequest"
}
- , "PluginInfo": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"},"options" : {"type": "object","title": "OPTIONS"},"metadata" : {"type": "object","title": "METADATA"}},
+ , "ChangeParentGroupRequest": {
+ "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"}},
"type": "object",
- "required": ["plugin_id","version","upgrade_mode","options","metadata"],
- "title": "PluginInfo"
+ "required": ["project_group_id","parent_group_id"],
+ "title": "ChangeParentGroupRequest"
+ }
+ , "CreateProjectGroupRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"}},
+ "type": "object",
+ "required": ["name"],
+ "title": "CreateProjectGroupRequest"
}
- , "ProviderInfo": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"color" : {"type": "string","title": "COLOR"},"icon" : {"type": "string","title": "ICON"},"order" : {"type": "integer","title": "ORDER"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "ProjectGroupInfo": {
+ "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"},"users" : {"items": {"type": "string"},
+ "type": "array","title": "USERS"},"reference_id" : {"type": "string","title": "REFERENCE_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"}},
"type": "object",
- "required": ["provider","name","alias","plugin_info","color","icon","order","options","tags","is_managed","domain_id","created_at","updated_at"],
- "title": "ProviderInfo"
+ "required": ["project_group_id","name","tags","users","reference_id","is_managed","domain_id","workspace_id","parent_group_id","trusted_account_id","created_at","last_synced_at"],
+ "title": "ProjectGroupInfo"
}
- , "ProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"}},
+ , "ProjectGroupRequest": {
+ "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
"type": "object",
- "required": ["provider"],
- "title": "ProviderRequest"
+ "required": ["project_group_id"],
+ "title": "ProjectGroupRequest"
}
- , "ProviderSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"}},
+ , "ProjectGroupSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"parent_group_id" : {"type": "string","title": "PARENT_GROUP_ID"}},
"type": "object",
"required": [],
- "title": "ProviderSearchQuery"
+ "title": "ProjectGroupSearchQuery"
}
- , "ProviderStatQuery": {
+ , "ProjectGroupStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "ProviderStatQuery"
+ "title": "ProjectGroupStatQuery"
}
- , "ProvidersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProviderInfo"},
- "type": "array","$ref": "#/components/schemas/ProviderInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "ProjectGroupsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectGroupInfo"},
+ "type": "array","$ref": "#/components/schemas/ProjectGroupInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "ProvidersInfo"
- }
- , "UpdatePluginProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
- "type": "object",
- "required": ["provider"],
- "title": "UpdatePluginProviderRequest"
- }
- , "UpdateProviderRequest": {
- "properties" : {"provider" : {"type": "string","title": "PROVIDER"},"name" : {"type": "string","title": "NAME"},"alias" : {"type": "string","title": "ALIAS"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"color" : {"type": "string","title": "COLOR"},"icon" : {"type": "string","title": "ICON"},"order" : {"type": "integer","title": "ORDER"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["provider"],
- "title": "UpdateProviderRequest"
- }
- , "EndpointInfo": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"service" : {"type": "string","title": "SERVICE"},"endpoint" : {"type": "string","title": "ENDPOINT"},"state" : {"type": "string","title": "STATE"},"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["name","service","endpoint","state","version"],
- "title": "EndpointInfo"
+ "title": "ProjectGroupsInfo"
}
- , "EndpointSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"service" : {"type": "string","title": "SERVICE"}},
+ , "UpdateProjectGroupRequest": {
+ "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": [],
- "title": "EndpointSearchQuery"
+ "required": ["project_group_id"],
+ "title": "UpdateProjectGroupRequest"
}
- , "EndpointsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EndpointInfo"},
- "type": "array","$ref": "#/components/schemas/EndpointInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "UsersProjectGroupRequest": {
+ "properties" : {"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"users" : {"items": {"type": "string"},
+ "type": "array","title": "USERS"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "EndpointsInfo"
+ "required": ["project_group_id","users"],
+ "title": "UsersProjectGroupRequest"
}
, "ConfirmEmailRequest": {
"properties" : {"verify_code" : {"type": "string","title": "VERIFY_CODE"}},
@@ -4682,54 +4674,66 @@
"required": [],
"title": "VerifyEmailRequest"
}
- , "CreateServiceAccountRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"tags" : {"type": "object","title": "TAGS"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "Admin": {
+ "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"password" : {"type": "string","title": "PASSWORD"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
"type": "object",
- "required": ["name","data","provider","project_id"],
- "title": "CreateServiceAccountRequest"
+ "required": ["user_id","name","password"],
+ "title": "Admin"
}
- , "ServiceAccountInfo": {
- "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"},"reference_id" : {"type": "string","title": "REFERENCE_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"},"inactivated_at" : {"type": "string","title": "INACTIVATED_AT"}},
+ , "CreateDomainRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"admin" : {"$ref": "#/components/schemas/Admin","title": "ADMIN"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["service_account_id","name","state","data","provider","tags","reference_id","is_managed","domain_id","workspace_id","project_id","trusted_account_id","secret_schema_id","secret_id","created_at","last_synced_at","deleted_at","inactivated_at"],
- "title": "ServiceAccountInfo"
+ "required": ["name","admin"],
+ "title": "CreateDomainRequest"
}
- , "ServiceAccountRequest": {
- "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
+ , "DomainAuthInfo": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"external_auth_state" : {"type": "string","title": "EXTERNAL_AUTH_STATE"},"metadata" : {"type": "object","title": "METADATA"},"config" : {"type": "object","title": "CONFIG"}},
"type": "object",
- "required": ["service_account_id"],
- "title": "ServiceAccountRequest"
+ "required": ["domain_id","name","external_auth_state","metadata","config"],
+ "title": "DomainAuthInfo"
}
- , "ServiceAccountSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
+ , "DomainInfo": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"tags" : {"type": "object","title": "TAGS"},"created_at" : {"type": "string","title": "CREATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
+ "type": "object",
+ "required": ["domain_id","name","state","tags","created_at","deleted_at"],
+ "title": "DomainInfo"
+ }
+ , "DomainRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "DomainRequest"
+ }
+ , "DomainSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"}},
"type": "object",
"required": [],
- "title": "ServiceAccountSearchQuery"
+ "title": "DomainSearchQuery"
}
- , "ServiceAccountStatQuery": {
+ , "DomainStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "ServiceAccountStatQuery"
+ "title": "DomainStatQuery"
}
- , "ServiceAccountsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ServiceAccountInfo"},
- "type": "array","$ref": "#/components/schemas/ServiceAccountInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "DomainsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DomainInfo"},
+ "type": "array","$ref": "#/components/schemas/DomainInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "ServiceAccountsInfo"
+ "title": "DomainsInfo"
}
- , "UpdateServiceAccountRequest": {
- "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "GetDomainAuthRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
- "required": ["service_account_id"],
- "title": "UpdateServiceAccountRequest"
+ "required": ["name"],
+ "title": "GetDomainAuthRequest"
}
- , "UpdateServiceAccountSecretRequest": {
- "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
+ , "UpdateDomainRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["service_account_id","secret_schema_id","secret_data"],
- "title": "UpdateServiceAccountSecretRequest"
+ "required": ["domain_id"],
+ "title": "UpdateDomainRequest"
}
, "SystemInfo": {
"properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"name" : {"type": "string","title": "NAME"},"system_token" : {"type": "string","title": "SYSTEM_TOKEN"}},
@@ -4743,74 +4747,131 @@
"required": ["admin","force"],
"title": "SystemInitRequest"
}
- , "CreateUserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "string","title": "AUTH_TYPE"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
+ , "JobInfo": {
+ "properties" : {"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"options" : {"type": "object","title": "OPTIONS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"error_message" : {"type": "string","title": "ERROR_MESSAGE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
"type": "object",
- "required": ["user_id","auth_type","reset_password"],
- "title": "CreateUserRequest"
+ "required": ["job_id","status","options","resource_group","error_message","domain_id","workspace_id","trusted_account_id","plugin_id","created_at","updated_at","finished_at"],
+ "title": "JobInfo"
}
- , "DisableUserMFARequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"}},
+ , "JobRequest": {
+ "properties" : {"job_id" : {"type": "string","title": "JOB_ID"}},
"type": "object",
- "required": ["user_id"],
- "title": "DisableUserMFARequest"
+ "required": ["job_id"],
+ "title": "JobRequest"
}
- , "MFA": {
- "properties" : {"state" : {"type": "string","title": "STATE"},"mfa_type" : {"type": "string","title": "MFA_TYPE"},"options" : {"type": "object","title": "OPTIONS"}},
+ , "JobStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
- "required": ["state","mfa_type","options"],
- "title": "MFA"
+ "required": ["query"],
+ "title": "JobStatQuery"
}
- , "SetRequiredActionsRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"required_actions" : {"items": {"type": "string"},
- "type": "array","title": "REQUIRED_ACTIONS"}},
+ , "JobsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobInfo"},
+ "type": "array","$ref": "#/components/schemas/JobInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["user_id","required_actions"],
- "title": "SetRequiredActionsRequest"
+ "required": ["results","total_count"],
+ "title": "JobsInfo"
}
- , "UpdateUserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"password" : {"type": "string","title": "PASSWORD"},"name" : {"type": "string","title": "NAME"},"email" : {"type": "string","title": "EMAIL"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"tags" : {"type": "object","title": "TAGS"},"reset_password" : {"type": "boolean","title": "RESET_PASSWORD"}},
+ , "JobsQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
"type": "object",
- "required": ["user_id"],
- "title": "UpdateUserRequest"
+ "required": [],
+ "title": "JobsQuery"
}
- , "UserInfo": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"email_verified" : {"type": "boolean","title": "EMAIL_VERIFIED"},"auth_type" : {"type": "string","title": "AUTH_TYPE"},"role_id" : {"type": "string","title": "ROLE_ID"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"mfa" : {"$ref": "#/components/schemas/MFA","title": "MFA"},"language" : {"type": "string","title": "LANGUAGE"},"timezone" : {"type": "string","title": "TIMEZONE"},"required_actions" : {"items": {"type": "string"},
- "type": "array","title": "REQUIRED_ACTIONS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_accessed_at" : {"type": "string","title": "LAST_ACCESSED_AT"}},
+ , "CreateRoleRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"permissions" : {"items": {"type": "string"},
+ "type": "array","title": "PERMISSIONS"},"page_access" : {"items": {"type": "string"},
+ "type": "array","title": "PAGE_ACCESS"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["user_id","name","state","email","email_verified","auth_type","role_id","role_type","mfa","language","timezone","required_actions","tags","domain_id","created_at","last_accessed_at"],
- "title": "UserInfo"
+ "required": ["name","role_type"],
+ "title": "CreateRoleRequest"
}
- , "UserRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"}},
+ , "RoleInfo": {
+ "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"permissions" : {"items": {"type": "string"},
+ "type": "array","title": "PERMISSIONS"},"page_access" : {"items": {"type": "string"},
+ "type": "array","title": "PAGE_ACCESS"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"state" : {"type": "string","title": "STATE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["user_id"],
- "title": "UserRequest"
+ "required": ["role_id","name","role_type","permissions","page_access","tags","is_managed","state","domain_id","created_at","updated_at"],
+ "title": "RoleInfo"
+ }
+ , "RoleRequest": {
+ "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"}},
+ "type": "object",
+ "required": ["role_id"],
+ "title": "RoleRequest"
+ }
+ , "RoleSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"state" : {"type": "string","title": "STATE"}},
+ "type": "object",
+ "required": [],
+ "title": "RoleSearchQuery"
+ }
+ , "RoleStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "RoleStatQuery"
+ }
+ , "RolesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RoleInfo"},
+ "type": "array","$ref": "#/components/schemas/RoleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "RolesInfo"
+ }
+ , "UpdateRoleRequest": {
+ "properties" : {"role_id" : {"type": "string","title": "ROLE_ID"},"name" : {"type": "string","title": "NAME"},"permissions" : {"items": {"type": "string"},
+ "type": "array","title": "PERMISSIONS"},"page_access" : {"items": {"type": "string"},
+ "type": "array","title": "PAGE_ACCESS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["role_id"],
+ "title": "UpdateRoleRequest"
+ }
+ , "CreateSchemaRequest": {
+ "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema_type" : {"type": "string","title": "SCHEMA_TYPE"},"schema" : {"type": "object","title": "SCHEMA"},"provider" : {"type": "string","title": "PROVIDER"},"related_schemas" : {"items": {"type": "string"},
+ "type": "array","title": "RELATED_SCHEMAS"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["schema_id","name","schema_type","provider"],
+ "title": "CreateSchemaRequest"
+ }
+ , "SchemaInfo": {
+ "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema_type" : {"type": "string","title": "SCHEMA_TYPE"},"schema" : {"type": "object","title": "SCHEMA"},"provider" : {"type": "string","title": "PROVIDER"},"related_schemas" : {"items": {"type": "string"},
+ "type": "array","title": "RELATED_SCHEMAS"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["schema_id","name","schema_type","schema","provider","related_schemas","options","tags","is_managed","domain_id","created_at","updated_at"],
+ "title": "SchemaInfo"
+ }
+ , "SchemaRequest": {
+ "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"}},
+ "type": "object",
+ "required": ["schema_id"],
+ "title": "SchemaRequest"
}
- , "UserSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_id" : {"type": "string","title": "USER_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"email" : {"type": "string","title": "EMAIL"},"auth_type" : {"type": "string","title": "AUTH_TYPE"}},
+ , "SchemaSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema_type" : {"type": "string","title": "SCHEMA_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"related_schema_id" : {"type": "string","title": "RELATED_SCHEMA_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"}},
"type": "object",
"required": [],
- "title": "UserSearchQuery"
+ "title": "SchemaSearchQuery"
}
- , "UserStatQuery": {
+ , "SchemaStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "UserStatQuery"
+ "title": "SchemaStatQuery"
}
- , "UsersInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserInfo"},
- "type": "array","$ref": "#/components/schemas/UserInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "SchemasInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/SchemaInfo"},
+ "type": "array","$ref": "#/components/schemas/SchemaInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "UsersInfo"
+ "title": "SchemasInfo"
}
- , "VerifyUserEmailRequest": {
- "properties" : {"user_id" : {"type": "string","title": "USER_ID"},"email" : {"type": "string","title": "EMAIL"}},
+ , "UpdateSchemaRequest": {
+ "properties" : {"schema_id" : {"type": "string","title": "SCHEMA_ID"},"name" : {"type": "string","title": "NAME"},"schema" : {"type": "object","title": "SCHEMA"},"related_schemas" : {"items": {"type": "string"},
+ "type": "array","title": "RELATED_SCHEMAS"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["user_id"],
- "title": "VerifyUserEmailRequest"
+ "required": ["schema_id"],
+ "title": "UpdateSchemaRequest"
}
, "AppCheckRequest": {
"properties" : {"client_id" : {"type": "string","title": "CLIENT_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
@@ -4874,197 +4935,136 @@
"required": ["app_id"],
"title": "UpdateAppRequest"
}
- , "ExternalAuthInfo": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"state" : {"type": "string","title": "STATE"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "EndpointInfo": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"service" : {"type": "string","title": "SERVICE"},"endpoint" : {"type": "string","title": "ENDPOINT"},"state" : {"type": "string","title": "STATE"},"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["domain_id","state","plugin_info","updated_at"],
- "title": "ExternalAuthInfo"
+ "required": ["name","service","endpoint","state","version"],
+ "title": "EndpointInfo"
}
- , "ExternalAuthRequest": {
- "properties" : {},
+ , "EndpointSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"service" : {"type": "string","title": "SERVICE"}},
"type": "object",
"required": [],
- "title": "ExternalAuthRequest"
- }
- , "SetExternalAuthRequest": {
- "properties" : {"plugin_info" : {"type": "PluginRequest","title": "PLUGIN_INFO"}},
- "type": "object",
- "required": ["plugin_info"],
- "title": "SetExternalAuthRequest"
- }
- , "GrantTokenInfo": {
- "properties" : {"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"role_type" : {"type": "string","title": "ROLE_TYPE"},"role_id" : {"type": "string","title": "ROLE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
- "type": "object",
- "required": ["access_token","role_type","role_id","domain_id","workspace_id"],
- "title": "GrantTokenInfo"
- }
- , "GrantTokenRequest": {
- "properties" : {"grant_type" : {"type": "string","title": "GRANT_TYPE"},"token" : {"type": "string","title": "TOKEN"},"scope" : {"type": "string","title": "SCOPE"},"timeout" : {"type": "integer","title": "TIMEOUT"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"permissions" : {"items": {"type": "string"},
- "type": "array","title": "PERMISSIONS"}},
- "type": "object",
- "required": ["grant_type","token","scope"],
- "title": "GrantTokenRequest"
- }
- , "IssueTokenRequest": {
- "properties" : {"credentials" : {"type": "object","title": "CREDENTIALS"},"auth_type" : {"type": "string","title": "AUTH_TYPE"},"timeout" : {"type": "integer","title": "TIMEOUT"},"verify_code" : {"type": "string","title": "VERIFY_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["credentials","domain_id"],
- "title": "IssueTokenRequest"
- }
- , "TokenInfo": {
- "properties" : {"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"refresh_token" : {"type": "string","title": "REFRESH_TOKEN"}},
- "type": "object",
- "required": ["access_token","refresh_token"],
- "title": "TokenInfo"
- }
- , "CreateWorkSpaceRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["name","tags"],
- "title": "CreateWorkSpaceRequest"
- }
- , "UpdateWorkSpaceRequest": {
- "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["workspace_id"],
- "title": "UpdateWorkSpaceRequest"
- }
- , "WorkspaceCheckRequest": {
- "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["workspace_id","domain_id"],
- "title": "WorkspaceCheckRequest"
+ "title": "EndpointSearchQuery"
}
- , "WorkspaceCostInfo": {
- "properties" : {"day" : {"type": "float","title": "DAY"},"month" : {"type": "float","title": "MONTH"}},
+ , "EndpointsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EndpointInfo"},
+ "type": "array","$ref": "#/components/schemas/EndpointInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["day","month"],
- "title": "WorkspaceCostInfo"
+ "required": ["results","total_count"],
+ "title": "EndpointsInfo"
}
- , "WorkspaceDeleteRequest": {
- "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"force" : {"type": "boolean","title": "FORCE"}},
+ , "CreateServiceAccountRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"tags" : {"type": "object","title": "TAGS"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["workspace_id","force"],
- "title": "WorkspaceDeleteRequest"
+ "required": ["name","data","provider","project_id"],
+ "title": "CreateServiceAccountRequest"
}
- , "WorkspaceInfo": {
- "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"tags" : {"type": "object","title": "TAGS"},"created_by" : {"type": "string","title": "CREATED_BY"},"references" : {"items": {"type": "string"},
- "type": "array","title": "REFERENCES"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"is_dormant" : {"type": "boolean","title": "IS_DORMANT"},"dormant_ttl" : {"type": "integer","title": "DORMANT_TTL"},"service_account_count" : {"type": "integer","title": "SERVICE_ACCOUNT_COUNT"},"cost_info" : {"$ref": "#/components/schemas/WorkspaceCostInfo","title": "COST_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"},"dormant_updated_at" : {"type": "string","title": "DORMANT_UPDATED_AT"}},
+ , "ServiceAccountInfo": {
+ "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"},"reference_id" : {"type": "string","title": "REFERENCE_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"},"inactivated_at" : {"type": "string","title": "INACTIVATED_AT"}},
"type": "object",
- "required": ["workspace_id","name","state","tags","created_by","references","is_managed","is_dormant","dormant_ttl","service_account_count","cost_info","domain_id","trusted_account_id","created_at","last_synced_at","dormant_updated_at"],
- "title": "WorkspaceInfo"
+ "required": ["service_account_id","name","state","data","provider","tags","reference_id","is_managed","domain_id","workspace_id","project_id","trusted_account_id","secret_schema_id","secret_id","created_at","last_synced_at","deleted_at","inactivated_at"],
+ "title": "ServiceAccountInfo"
}
- , "WorkspaceRequest": {
- "properties" : {"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "ServiceAccountRequest": {
+ "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"}},
"type": "object",
- "required": ["workspace_id"],
- "title": "WorkspaceRequest"
+ "required": ["service_account_id"],
+ "title": "ServiceAccountRequest"
}
- , "WorkspaceSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"created_by" : {"type": "string","title": "CREATED_BY"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"is_dormant" : {"type": "boolean","title": "IS_DORMANT"}},
+ , "ServiceAccountSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
"type": "object",
"required": [],
- "title": "WorkspaceSearchQuery"
+ "title": "ServiceAccountSearchQuery"
}
- , "WorkspaceStatQuery": {
+ , "ServiceAccountStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "WorkspaceStatQuery"
+ "title": "ServiceAccountStatQuery"
}
- , "WorkspacesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/WorkspaceInfo"},
- "type": "array","$ref": "#/components/schemas/WorkspaceInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "ServiceAccountsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ServiceAccountInfo"},
+ "type": "array","$ref": "#/components/schemas/ServiceAccountInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "WorkspacesInfo"
- }
- , "CreateTrustedAccountRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"sync_options" : {"type": "object","title": "SYNC_OPTIONS"},"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
- "type": "object",
- "required": ["name","data","provider","secret_schema_id","secret_data","resource_group"],
- "title": "CreateTrustedAccountRequest"
- }
- , "Scheduled": {
- "properties" : {"state" : {"type": "string","title": "STATE"},"hours" : {"items": {"type": "integer"},
- "type": "array","title": "HOURS"}},
- "type": "object",
- "required": ["state","hours"],
- "title": "Scheduled"
+ "title": "ServiceAccountsInfo"
}
- , "TrustedAccountInfo": {
- "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"provider" : {"type": "string","title": "PROVIDER"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"sync_options" : {"type": "object","title": "SYNC_OPTIONS"},"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "UpdateServiceAccountRequest": {
+ "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"tags" : {"type": "object","title": "TAGS"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["trusted_account_id","name","data","provider","schedule","sync_options","plugin_options","tags","resource_group","domain_id","workspace_id","secret_schema_id","trusted_secret_id","created_at"],
- "title": "TrustedAccountInfo"
+ "required": ["service_account_id"],
+ "title": "UpdateServiceAccountRequest"
}
- , "TrustedAccountRequest": {
- "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
+ , "UpdateServiceAccountSecretRequest": {
+ "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
"type": "object",
- "required": ["trusted_account_id"],
- "title": "TrustedAccountRequest"
+ "required": ["service_account_id","secret_schema_id","secret_data"],
+ "title": "UpdateServiceAccountSecretRequest"
}
- , "TrustedAccountSearchQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"}},
+ , "ChangeProjectGroupRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
"type": "object",
- "required": [],
- "title": "TrustedAccountSearchQuery"
+ "required": ["project_id","project_group_id"],
+ "title": "ChangeProjectGroupRequest"
}
- , "TrustedAccountStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "CreateProjectRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"project_type" : {"type": "string","title": "PROJECT_TYPE"},"tags" : {"type": "object","title": "TAGS"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
"type": "object",
- "required": ["query"],
- "title": "TrustedAccountStatQuery"
+ "required": ["name","project_type"],
+ "title": "CreateProjectRequest"
}
- , "TrustedAccountsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/TrustedAccountInfo"},
- "type": "array","$ref": "#/components/schemas/TrustedAccountInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "ProjectInfo": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"project_type" : {"type": "string","title": "PROJECT_TYPE"},"tags" : {"type": "object","title": "TAGS"},"users" : {"items": {"type": "string"},
+ "type": "array","title": "USERS"},"created_by" : {"type": "string","title": "CREATED_BY"},"reference_id" : {"type": "string","title": "REFERENCE_ID"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_synced_at" : {"type": "string","title": "LAST_SYNCED_AT"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "TrustedAccountsInfo"
+ "required": ["project_id","name","project_type","tags","users","created_by","reference_id","is_managed","domain_id","workspace_id","project_group_id","trusted_account_id","created_at","last_synced_at"],
+ "title": "ProjectInfo"
}
- , "UpdateTrustedAccountRequest": {
- "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"sync_options" : {"type": "object","title": "SYNC_OPTIONS"},"plugin_options" : {"type": "object","title": "PLUGIN_OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "ProjectRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["trusted_account_id","tags"],
- "title": "UpdateTrustedAccountRequest"
+ "required": ["project_id"],
+ "title": "ProjectRequest"
}
- , "UpdateTrustedAccountSecretRequest": {
- "properties" : {"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"secret_schema_id" : {"type": "string","title": "SECRET_SCHEMA_ID"},"secret_data" : {"type": "object","title": "SECRET_DATA"}},
+ , "ProjectSearchQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"project_type" : {"type": "string","title": "PROJECT_TYPE"},"created_by" : {"type": "string","title": "CREATED_BY"},"include_children" : {"type": "boolean","title": "INCLUDE_CHILDREN"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"}},
"type": "object",
- "required": ["trusted_account_id","secret_schema_id","secret_data"],
- "title": "UpdateTrustedAccountSecretRequest"
+ "required": [],
+ "title": "ProjectSearchQuery"
}
- , "JobInfo": {
- "properties" : {"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"options" : {"type": "object","title": "OPTIONS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"error_message" : {"type": "string","title": "ERROR_MESSAGE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
+ , "ProjectStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
- "required": ["job_id","status","options","resource_group","error_message","domain_id","workspace_id","trusted_account_id","plugin_id","created_at","updated_at","finished_at"],
- "title": "JobInfo"
+ "required": ["query"],
+ "title": "ProjectStatQuery"
}
- , "JobRequest": {
- "properties" : {"job_id" : {"type": "string","title": "JOB_ID"}},
+ , "ProjectsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectInfo"},
+ "type": "array","$ref": "#/components/schemas/ProjectInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["job_id"],
- "title": "JobRequest"
+ "required": ["results","total_count"],
+ "title": "ProjectsInfo"
}
- , "JobStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "UpdateProjectRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["query"],
- "title": "JobStatQuery"
+ "required": ["project_id"],
+ "title": "UpdateProjectRequest"
}
- , "JobsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobInfo"},
- "type": "array","$ref": "#/components/schemas/JobInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "UpdateProjectTypeRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"project_type" : {"type": "string","title": "PROJECT_TYPE"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "JobsInfo"
+ "required": ["project_id","project_type"],
+ "title": "UpdateProjectTypeRequest"
}
- , "JobsQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
+ , "UsersProjectRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"users" : {"items": {"type": "string"},
+ "type": "array","title": "USERS"}},
"type": "object",
- "required": [],
- "title": "JobsQuery"
+ "required": ["project_id","users"],
+ "title": "UsersProjectRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/inventory/v1/openapi.json b/dist/openapi/cloudforet/api/inventory/v1/openapi.json
index d0d63fb93..71e62248b 100755
--- a/dist/openapi/cloudforet/api/inventory/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/inventory/v1/openapi.json
@@ -8,20 +8,20 @@
"title": "Inventory API",
"version": "3.1.0"
},
- "paths":{"/inventory/change-history/list": {
+ "paths":{"/inventory/namespace/create": {
"post": {
- "tags": ["inventory > change-history"],
- "summary": "List",
+ "tags": ["inventory > namespace"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n |query||Query||\n |action|CREATE, UPDATE, DELETE |string||\n |user_id||string||\n |collector_id||string||\n |job_id||string||\n |updated_by||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |category||string|True|\n |resource_type||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |namespace_id||string||\n |group||string||\n |icon||string||\n |tags||Struct||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"action" : {"type": "string","title": "ACTION" },"user_id" : {"type": "string","title": "USER_ID" },"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"job_id" : {"type": "string","title": "JOB_ID" },"updated_by" : {"type": "string","title": "UPDATED_BY" } }
+ "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"name" : {"type": "string","title": "NAME" },"category" : {"type": "string","title": "CATEGORY" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"group" : {"type": "string","title": "GROUP" },"icon" : {"type": "string","title": "ICON" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -30,27 +30,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ChangeHistoryInfo"},
+ "schema": {"$ref": "#/components/schemas/NamespaceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ChangeHistoryInfo"}}
+ "Schema": {"$ref": "#/components/schemas/NamespaceInfo"},"Default Example":{
+ "value": "{\n\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/change-history/stat": {
+ },"/inventory/namespace/update": {
"post": {
- "tags": ["inventory > change-history"],
- "summary": "Stat",
+ "tags": ["inventory > namespace"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |cloud_service_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |namespace_id||string|True|\n |name||string||\n |icon||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" } }
+ "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"name" : {"type": "string","title": "NAME" },"icon" : {"type": "string","title": "ICON" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -59,58 +61,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/NamespaceInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/NamespaceInfo"},"Default Example":{
+ "value": "{\n\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-type/create": {
+ },"/inventory/namespace/delete": {
"post": {
- "tags": ["inventory > cloud-service-type"],
- "summary": "Create",
+ "tags": ["inventory > namespace"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \nCreates a new CloudServiceType. You must specify the `name`, `provider`, and `group` parameters to create a CloudServiceType. One or several CloudServiceTypes exist in a specific `group`, and each CloudServiceType is identified by the `name` parameter.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |provider||string|True|\n |group||string|True|\n |service_code||string||\n |is_primary||boolean||\n |is_major||boolean||\n |resource_type||string||\n |metadata||Struct||\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |namespace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"provider" : {"type": "string","title": "PROVIDER" },"group" : {"type": "string","title": "GROUP" },"service_code" : {"type": "string","title": "SERVICE_CODE" },"is_primary" : {"type": "boolean","title": "IS_PRIMARY" },"is_major" : {"type": "boolean","title": "IS_MAJOR" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"metadata" : {"type": "object","title": "METADATA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"labels\": [\n \"Networking\"\n ],\n \"tags\": {\n \"a\": \"b\"\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},"Default Example":{
- "value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API-TEST\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2022-06-22T01:38:16.301Z\"\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-type/update": {
+ },"/inventory/namespace/get": {
"post": {
- "tags": ["inventory > cloud-service-type"],
- "summary": "Update",
+ "tags": ["inventory > namespace"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nUpdates a specific CloudServiceType. You can make changes in CloudServiceType settings, except for `name`, `provider` and `group`. In particular, you can set the CloudServiceType's priority in a `group`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type_id||string|True|\n |service_code||string||\n |is_primary||boolean||\n |is_major||boolean||\n |resource_type||string||\n |metadata||Struct||\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |namespace_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" },"service_code" : {"type": "string","title": "SERVICE_CODE" },"is_primary" : {"type": "boolean","title": "IS_PRIMARY" },"is_major" : {"type": "boolean","title": "IS_MAJOR" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"metadata" : {"type": "object","title": "METADATA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"service_code\": \"AmazonApi\",\n \"metadata\": {},\n \"labels\": [\n \"Networking2\"\n ],\n \"tags\": {\n \"b\": \"c\"\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -119,52 +115,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},
+ "schema": {"$ref": "#/components/schemas/NamespaceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},"Default Example":{
- "value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API-TEST\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2022-06-22T01:38:16.301Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/NamespaceInfo"},"Default Example":{
+ "value": "{\n\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-type/delete": {
- "post": {
- "tags": ["inventory > cloud-service-type"],
- "summary": "Delete",
- "operationId" : "",
- "description": "### Description \nDeletes a specific CloudServiceType. You must specify the `cloud_service_type_id` of the CloudServiceType to delete.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" } }
- },
- "examples":{"Default Example":{"value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\"\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-type/get": {
+ },"/inventory/namespace/list": {
"post": {
- "tags": ["inventory > cloud-service-type"],
- "summary": "Get",
+ "tags": ["inventory > namespace"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nGets a specific CloudServiceType. Prints detailed information about the CloudServiceType.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |namespace_id||string||\n |category||string||\n |resource_type||string||\n |group||string||\n |is_managed||string||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"category" : {"type": "string","title": "CATEGORY" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"group" : {"type": "string","title": "GROUP" },"is_managed" : {"type": "string","title": "IS_MANAGED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -173,29 +146,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},
+ "schema": {"$ref": "#/components/schemas/NamespacesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},"Default Example":{
- "value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API-TEST\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2022-06-22T01:38:16.301Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/NamespacesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-type/list": {
+ },"/inventory/namespace/stat": {
"post": {
- "tags": ["inventory > cloud-service-type"],
- "summary": "List",
+ "tags": ["inventory > namespace"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nGets a list of all CloudServiceTypes. You can use a query to get a filtered list of CloudServiceTypes.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cloud_service_type_id||string||\n |name||string||\n |provider||string||\n |group||string||\n |cloud_service_type_key||string||\n |service_code||string||\n |is_primary||boolean||\n |is_major||boolean||\n |resource_type||string||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" },"name" : {"type": "string","title": "NAME" },"provider" : {"type": "string","title": "PROVIDER" },"group" : {"type": "string","title": "GROUP" },"cloud_service_type_key" : {"type": "string","title": "CLOUD_SERVICE_TYPE_KEY" },"service_code" : {"type": "string","title": "SERVICE_CODE" },"is_primary" : {"type": "boolean","title": "IS_PRIMARY" },"is_major" : {"type": "boolean","title": "IS_MAJOR" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {\n \"filter\": [\n {\n \"key\": \"provider\",\n \"value\": \"aws\",\n \"operator\": \"eq\"\n }\n ]\n }\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -204,27 +175,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceTypesInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceTypesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"cloud_service_type_id\": \"cloud-svc-type-7e1c113b39ff\",\n \"name\": \"API\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {\n },\n \"tags\": {\n \"spaceone:icon\": \"https://spaceone.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/aws/Amazon-API-Gateway.svg\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2021-06-03T02:29:32.690Z\",\n \"updated_at\": \"2022-06-22T00:04:45.477Z\"\n },\n {\n \"cloud_service_type_id\": \"cloud-svc-type-64a0de601371\",\n \"name\": \"Certificate\",\n \"provider\": \"aws\",\n \"group\": \"CertificateManager\",\n \"cloud_service_type_key\": \"aws.CertificateManager.Certificate\",\n \"service_code\": \"AWSCertificateManager\",\n \"is_primary\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {\n },\n \"tags\": {\n \"spaceone:icon\": \"https://spaceone.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/aws/AWS-Certificate-Manager.svg\"\n },\n \"labels\": [\n \"Security\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2021-06-03T02:29:53.052Z\",\n \"updated_at\": \"2022-06-22T00:05:41.252Z\"\n }\n ],\n \"total_count\": 2\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-type/stat": {
+ },"/inventory/cloud-service-report/create": {
"post": {
- "tags": ["inventory > cloud-service-type"],
- "summary": "Stat",
+ "tags": ["inventory > cloud-service-report"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |options||array|True|\n |schedule||ReportSchedule|True|\n |target||Struct|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |file_format|EXCEL, CSV |string||\n |timezone||string||\n |language||string||\n |tags||Struct||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"options" : {"items": {"$ref": "#/components/schemas/ExportOption"}, "type": "array","title": "OPTIONS" },"file_format" : {"type": "string","title": "FILE_FORMAT" },"timezone" : {"type": "string","title": "TIMEZONE" },"language" : {"type": "string","title": "LANGUAGE" },"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE" },"target" : {"type": "object","title": "TARGET" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
"examples":{"Schema":{}
}
@@ -235,27 +204,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/namespace/create": {
+ },"/inventory/cloud-service-report/update": {
"post": {
- "tags": ["inventory > namespace"],
- "summary": "Create",
+ "tags": ["inventory > cloud-service-report"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |category||string|True|\n |resource_type||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |namespace_id||string||\n |group||string||\n |icon||string||\n |tags||Struct||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n |name||string||\n |options||array||\n |file_format|EXCEL, CSV |string||\n |timezone||string||\n |language||string||\n |schedule||ReportSchedule||\n |target||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"name" : {"type": "string","title": "NAME" },"category" : {"type": "string","title": "CATEGORY" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"group" : {"type": "string","title": "GROUP" },"icon" : {"type": "string","title": "ICON" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"report_id" : {"type": "string","title": "REPORT_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"items": {"$ref": "#/components/schemas/ExportOption"}, "type": "array","title": "OPTIONS" },"file_format" : {"type": "string","title": "FILE_FORMAT" },"timezone" : {"type": "string","title": "TIMEZONE" },"language" : {"type": "string","title": "LANGUAGE" },"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE" },"target" : {"type": "object","title": "TARGET" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -264,60 +233,50 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NamespaceInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NamespaceInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/namespace/update": {
+ },"/inventory/cloud-service-report/delete": {
"post": {
- "tags": ["inventory > namespace"],
- "summary": "Update",
+ "tags": ["inventory > cloud-service-report"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |namespace_id||string|True|\n |name||string||\n |icon||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"name" : {"type": "string","title": "NAME" },"icon" : {"type": "string","title": "ICON" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"report_id" : {"type": "string","title": "REPORT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/NamespaceInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/NamespaceInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/namespace/delete": {
+ },"/inventory/cloud-service-report/send": {
"post": {
- "tags": ["inventory > namespace"],
- "summary": "Delete",
+ "tags": ["inventory > cloud-service-report"],
+ "summary": "Send",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |namespace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
+ "properties": {"report_id" : {"type": "string","title": "REPORT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -327,20 +286,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/namespace/get": {
+ },"/inventory/cloud-service-report/get": {
"post": {
- "tags": ["inventory > namespace"],
+ "tags": ["inventory > cloud-service-report"],
"summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |namespace_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
+ "properties": {"report_id" : {"type": "string","title": "REPORT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -349,29 +308,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NamespaceInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NamespaceInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/namespace/list": {
+ },"/inventory/cloud-service-report/list": {
"post": {
- "tags": ["inventory > namespace"],
+ "tags": ["inventory > cloud-service-report"],
"summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |namespace_id||string||\n |category||string||\n |resource_type||string||\n |group||string||\n |is_managed||string||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |report_id||string||\n |name||string||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"category" : {"type": "string","title": "CATEGORY" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"group" : {"type": "string","title": "GROUP" },"is_managed" : {"type": "string","title": "IS_MANAGED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"report_id" : {"type": "string","title": "REPORT_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -380,16 +337,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NamespacesInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceReportsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NamespacesInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceReportsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/namespace/stat": {
+ },"/inventory/cloud-service-report/stat": {
"post": {
- "tags": ["inventory > namespace"],
+ "tags": ["inventory > cloud-service-report"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -416,20 +373,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/create": {
+ },"/inventory/cloud-service-type/create": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
+ "tags": ["inventory > cloud-service-type"],
"summary": "Create",
"operationId" : "",
- "description": "### Description \nCreate a new query set. Periodic statistics data is created based on the query set.\n`query` parameters refer to AnalyzeQuery.",
+ "description": "### Description \nCreates a new CloudServiceType. You must specify the `name`, `provider`, and `group` parameters to create a CloudServiceType. One or several CloudServiceTypes exist in a specific `group`, and each CloudServiceType is identified by the `name` parameter.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |query_options||AnalyzeQuery|True|\n |provider||string|True|\n |cloud_service_group||string|True|\n |cloud_service_type||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |unit||Struct||\n |tags||Struct||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |provider||string|True|\n |group||string|True|\n |service_code||string||\n |is_primary||boolean||\n |is_major||boolean||\n |resource_type||string||\n |metadata||Struct||\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"unit" : {"type": "object","title": "UNIT" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"provider" : {"type": "string","title": "PROVIDER" },"group" : {"type": "string","title": "GROUP" },"service_code" : {"type": "string","title": "SERVICE_CODE" },"is_primary" : {"type": "boolean","title": "IS_PRIMARY" },"is_major" : {"type": "boolean","title": "IS_MAJOR" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"metadata" : {"type": "object","title": "METADATA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"EC2 Count by Instance Type\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"labels\": [\n \"Networking\"\n ],\n \"tags\": {\n \"a\": \"b\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -438,29 +395,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
- "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},"Default Example":{
+ "value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API-TEST\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2022-06-22T01:38:16.301Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/update": {
+ },"/inventory/cloud-service-type/update": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
+ "tags": ["inventory > cloud-service-type"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdate a specific query set. You can only update the query set of custom type.",
+ "description": "### Description \nUpdates a specific CloudServiceType. You can make changes in CloudServiceType settings, except for `name`, `provider` and `group`. In particular, you can set the CloudServiceType's priority in a `group`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n |name||string||\n |query_options||AnalyzeQuery||\n |unit||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type_id||string|True|\n |service_code||string||\n |is_primary||boolean||\n |is_major||boolean||\n |resource_type||string||\n |metadata||Struct||\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" },"name" : {"type": "string","title": "NAME" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"unit" : {"type": "object","title": "UNIT" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" },"service_code" : {"type": "string","title": "SERVICE_CODE" },"is_primary" : {"type": "boolean","title": "IS_PRIMARY" },"is_major" : {"type": "boolean","title": "IS_MAJOR" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"metadata" : {"type": "object","title": "METADATA" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"Changed Name\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"tags\": {\n \"changed_key\": \"changed_value\"\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"service_code\": \"AmazonApi\",\n \"metadata\": {},\n \"labels\": [\n \"Networking2\"\n ],\n \"tags\": {\n \"b\": \"c\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -469,29 +426,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
- "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},"Default Example":{
+ "value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API-TEST\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2022-06-22T01:38:16.301Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/delete": {
+ },"/inventory/cloud-service-type/delete": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
+ "tags": ["inventory > cloud-service-type"],
"summary": "Delete",
"operationId" : "",
- "description": "### Description \nDelete a specific query set.",
+ "description": "### Description \nDeletes a specific CloudServiceType. You must specify the `cloud_service_type_id` of the CloudServiceType to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\"\n}"},"Schema":{}
}
}
},"required": true
@@ -501,43 +458,51 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/run": {
+ },"/inventory/cloud-service-type/get": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
- "summary": "Run",
+ "tags": ["inventory > cloud-service-type"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nRun a specific query set and store the result in the statistics data.",
+ "description": "### Description \nGets a specific CloudServiceType. Prints detailed information about the CloudServiceType.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/CloudServiceTypeInfo"},"Default Example":{
+ "value": "{\n \"cloud_service_type_id\": \"cloud-svc-type-27dd73ac89f8\",\n \"name\": \"API-TEST\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API-TEST\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {},\n \"tags\": {\n \"a\": \"b\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2022-06-22T01:38:16.301Z\"\n}"
+ }}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/test": {
+ },"/inventory/cloud-service-type/list": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
- "summary": "Test",
+ "tags": ["inventory > cloud-service-type"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nRun a specific query set and store the result in the statistics data.",
+ "description": "### Description \nGets a list of all CloudServiceTypes. You can use a query to get a filtered list of CloudServiceTypes.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cloud_service_type_id||string||\n |name||string||\n |provider||string||\n |group||string||\n |cloud_service_type_key||string||\n |service_code||string||\n |is_primary||boolean||\n |is_major||boolean||\n |resource_type||string||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID" },"name" : {"type": "string","title": "NAME" },"provider" : {"type": "string","title": "PROVIDER" },"group" : {"type": "string","title": "GROUP" },"cloud_service_type_key" : {"type": "string","title": "CLOUD_SERVICE_TYPE_KEY" },"service_code" : {"type": "string","title": "SERVICE_CODE" },"is_primary" : {"type": "boolean","title": "IS_PRIMARY" },"is_major" : {"type": "boolean","title": "IS_MAJOR" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {\n \"filter\": [\n {\n \"key\": \"provider\",\n \"value\": \"aws\",\n \"operator\": \"eq\"\n }\n ]\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -546,27 +511,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceTypesInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceTypesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"cloud_service_type_id\": \"cloud-svc-type-7e1c113b39ff\",\n \"name\": \"API\",\n \"provider\": \"aws\",\n \"group\": \"APIGateway\",\n \"cloud_service_type_key\": \"aws.APIGateway.API\",\n \"service_code\": \"AmazonApiGateway\",\n \"is_primary\": true,\n \"is_major\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {\n },\n \"tags\": {\n \"spaceone:icon\": \"https://spaceone.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/aws/Amazon-API-Gateway.svg\"\n },\n \"labels\": [\n \"Networking\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2021-06-03T02:29:32.690Z\",\n \"updated_at\": \"2022-06-22T00:04:45.477Z\"\n },\n {\n \"cloud_service_type_id\": \"cloud-svc-type-64a0de601371\",\n \"name\": \"Certificate\",\n \"provider\": \"aws\",\n \"group\": \"CertificateManager\",\n \"cloud_service_type_key\": \"aws.CertificateManager.Certificate\",\n \"service_code\": \"AWSCertificateManager\",\n \"is_primary\": true,\n \"resource_type\": \"inventory.CloudService\",\n \"metadata\": {\n },\n \"tags\": {\n \"spaceone:icon\": \"https://spaceone.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/aws/AWS-Certificate-Manager.svg\"\n },\n \"labels\": [\n \"Security\"\n ],\n \"domain_id\": \"domain-58010aa2e451\",\n \"workspace_id\": \"workspace-abcde12345\",\n \"created_at\": \"2021-06-03T02:29:53.052Z\",\n \"updated_at\": \"2022-06-22T00:05:41.252Z\"\n }\n ],\n \"total_count\": 2\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/enable": {
+ },"/inventory/cloud-service-type/stat": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
- "summary": "Enable",
+ "tags": ["inventory > cloud-service-type"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nEnable a specific query set.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |domain_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"domain_id" : {"type": "string","title": "DOMAIN_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -575,29 +542,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
- "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/disable": {
+ },"/inventory/metric-data/list": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
- "summary": "Disable",
+ "tags": ["inventory > metric-data"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nDisable a specific query set. query set is not executed when disabled.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |query||Query||\n |workspace_id||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -606,29 +571,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricDatasInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
- "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/MetricDatasInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/get": {
+ },"/inventory/metric-data/stat": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
- "summary": "Get",
+ "tags": ["inventory > metric-data"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nGet a specific query set.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |metric_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -637,29 +600,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
- "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/list": {
+ },"/inventory/metric-data/analyze": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
- "summary": "List",
+ "tags": ["inventory > metric-data"],
+ "summary": "Analyze",
"operationId" : "",
- "description": "### Description \nGets a list of all query sets.\nYou can use a query to get a filtered list of query sets.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |query_set_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |query_type|MANAGED, CUSTOM |string||\n |provider||string||\n |cloud_service_group||string||\n |cloud_service_type||string||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |metric_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"query_type" : {"type": "string","title": "QUERY_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": \u003cSearchQuery\u003e,\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_type\": \"MANAGED\",\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"resource_group\": \"DOMAIN\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -668,29 +629,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_type\": \"MANAGED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n },\n {...}\n ],\n \"total_count\": 2\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-query-set/stat": {
+ },"/inventory/cloud-service-stats/list": {
"post": {
- "tags": ["inventory > cloud-service-query-set"],
- "summary": "Stat",
+ "tags": ["inventory > cloud-service-stats"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of raw statistics data.\nYou can use a query to get a filtered list of statistics data.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n |query||Query||\n |provider||string||\n |cloud_service_group||string||\n |cloud_service_type||string||\n |region_code||string||\n |account||string||\n |workspace_id||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"region_code" : {"type": "string","title": "REGION_CODE" },"account" : {"type": "string","title": "ACCOUNT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": \u003cSearchQuery\u003e,\n \"query_set_id\": \"query-set-abcd1234\",\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"region_code\": \"us-east-1\",\n \"account\": \"aws-account-id\",\n \"project_id\": \"project-abcd1234\"\n}"},"Schema":{}
}
}
},"required": true
@@ -699,27 +658,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceStatsInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceStatsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"query_set_id\": \"query-set-abcd1234\",\n \"key\": \"Disk Size\",\n \"data\": {\n \"Disk Size\": 1040,\n \"Memory Size\": 1024,\n \"CPU\": 2\n },\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"region_code\": \"us-east-1\",\n \"account\": \"aws-account-id\",\n \"additional_info\": {\n \"instance_type\": \"t2.micro\"\n },\n \"project_id\": \"project-abcd1234\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_date\": \"2022-06-22\"\n },\n {...}\n ],\n \"total_count\": 2\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/create": {
+ },"/inventory/cloud-service-stats/analyze": {
"post": {
- "tags": ["inventory > cloud-service"],
- "summary": "Create",
+ "tags": ["inventory > cloud-service-stats"],
+ "summary": "Analyze",
"operationId" : "",
- "description": "### Description \nCreates a new CloudService. A CloudService instance is created based on data including the `resource`'s attribute values. When creating, the classification information defined by CloudServiceType is also needed. The created CloudService has collection information which is the collection history for the `resource` by plugin.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type||string|True|\n |provider||string|True|\n |cloud_service_group||string|True|\n |data||Struct|True|\n |name||string||\n |account||string||\n |instance_type||string||\n |instance_size||float||\n |ip_addresses||array||\n |metadata||Struct||\n |reference||CloudServiceReference||\n |tags||Struct||\n |region_code||string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"name" : {"type": "string","title": "NAME" },"account" : {"type": "string","title": "ACCOUNT" },"instance_type" : {"type": "string","title": "INSTANCE_TYPE" },"instance_size" : {"type": "float","title": "INSTANCE_SIZE" },"ip_addresses" : {"items": {}, "type": "array","title": "IP_ADDRESSES" },"data" : {"type": "object","title": "DATA" },"metadata" : {"type": "object","title": "METADATA" },"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE" },"tags" : {"type": "object","title": "TAGS" },"region_code" : {"type": "string","title": "REGION_CODE" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cloud_service_type\": \"Key\",\n \"provider\": \"aws\",\n \"cloud_service_group\": \"KMS\",\n \"name\": \"cloud_service_test\",\n \"account\": \"251340636361\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\",\n \"ip_addresses\": [],\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {},\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"region_code\": \"ap-northeast-1\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -728,29 +689,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceInfo"},"Default Example":{
- "value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/update": {
+ },"/inventory/cloud-service-stats/stat": {
"post": {
- "tags": ["inventory > cloud-service"],
- "summary": "Update",
+ "tags": ["inventory > cloud-service-stats"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nUpdates a specific CloudService. You can make changes in CloudService settings, except for the classification system of CloudService and the information about the `resource` attribute value.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n |name||string||\n |account||string||\n |instance_type||string||\n |instance_size||float||\n |ip_addresses||array||\n |data||Struct||\n |metadata||Struct||\n |reference||CloudServiceReference||\n |tags||Struct||\n |region_code||string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |query_set_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"name" : {"type": "string","title": "NAME" },"account" : {"type": "string","title": "ACCOUNT" },"instance_type" : {"type": "string","title": "INSTANCE_TYPE" },"instance_size" : {"type": "float","title": "INSTANCE_SIZE" },"ip_addresses" : {"items": {}, "type": "array","title": "IP_ADDRESSES" },"data" : {"type": "object","title": "DATA" },"metadata" : {"type": "object","title": "METADATA" },"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE" },"tags" : {"type": "object","title": "TAGS" },"region_code" : {"type": "string","title": "REGION_CODE" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test2\",\n \"ip_addresses\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"tags\": {\n \"description\": \"spaceone\"\n },\n \"region_code\": \"ap-northeast-2\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -759,29 +718,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceInfo"},"Default Example":{
- "value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/delete": {
+ },"/inventory/job/delete": {
"post": {
- "tags": ["inventory > cloud-service"],
+ "tags": ["inventory > job"],
"summary": "Delete",
"operationId" : "",
- "description": "### Description \nDeletes a specific CloudService. You must specify the `cloud_service_id` of the CloudService to delete.",
+ "description": "### Description \nDeletes a specific Job. You must specify the `job_id` of the Job to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" } }
+ "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cloud_service_id\": \"cloud-svc-fea2b0d32141\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
@@ -791,20 +748,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/get": {
+ },"/inventory/job/get": {
"post": {
- "tags": ["inventory > cloud-service"],
+ "tags": ["inventory > job"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a specific CloudService. Prints detailed information about the CloudService, including its state, classification information, and attribute values.",
+ "description": "### Description \nGets a specific Job. Prints detailed information about the Job, including its state, total tasks, and collector info.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" } }
+ "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"cloud_service_id\": \"cloud-svc-fea2b0d32141\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
@@ -813,29 +770,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceInfo"},
+ "schema": {"$ref": "#/components/schemas/JobInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceInfo"},"Default Example":{
- "value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
+ "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"filter\": {},\n \"total_tasks\": 2,\n \"collector_info\": {\n \"collector_id\": \"collector-123456789012\",\n \"name\": \"Jenkins Collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-jenkins-inven-collector\",\n \"version\": \"0.1.1\"\n },\n \"provider\": \"jenkins\",\n \"capability\": {},\n \"is_public\": true\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/list": {
+ },"/inventory/job/list": {
"post": {
- "tags": ["inventory > cloud-service"],
+ "tags": ["inventory > job"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all CloudServices. You can use a query to get a filtered list of CloudServices.",
+ "description": "### Description \nGets a list of all Jobs. You can use a query to get a filtered list of Jobs.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cloud_service_id||string||\n |name||string||\n |state||string||\n |ip_address||string||\n |account||string||\n |instance_type||string||\n |cloud_service_type||string||\n |cloud_service_group||string||\n |provider||string||\n |region_code||string||\n |workspace_id||string||\n |project_id||string||\n |project_group_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_id||string||\n |status|CANCELED, IN_PROGRESS, SUCCESS, FAILURE, TIMEOUT |string||\n |workspace_id||string||\n |collector_id||string||\n |plugin_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"ip_address" : {"type": "string","title": "IP_ADDRESS" },"account" : {"type": "string","title": "ACCOUNT" },"instance_type" : {"type": "string","title": "INSTANCE_TYPE" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"provider" : {"type": "string","title": "PROVIDER" },"region_code" : {"type": "string","title": "REGION_CODE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_id" : {"type": "string","title": "JOB_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {\n \"filter\": [\n {\n \"key\": \"cloud_service_type\",\n \"value\": \"Key\",\n \"operator\": \"eq\"\n }\n ]\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -844,47 +801,18 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServicesInfo"},
+ "schema": {"$ref": "#/components/schemas/JobsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServicesInfo"},"Default Example":{
- "value": "{\n \"results\": [{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test2\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"description\": \"spaceone\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n }],\n \"total_count\": 1\n}"
+ "Schema": {"$ref": "#/components/schemas/JobsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"job_id\": \"job-3b124006c2d2\",\n \"status\": \"SUCCESS\",\n \"filter\": {},\n \"total_tasks\": 2,\n \"collector_info\": {\n \"collector_id\": \"collector-accd02663b3d\",\n \"name\": \"openstack-collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-openstack-inven-collector\",\n \"version\": \"0.4.2.20220616.134758\"\n },\n \"provider\": \"openstack\",\n \"capability\": {\n \"supported_schema\": [\n \"openstack_credentials\"\n ]\n },\n \"is_public\": true\n },\n \"resource_group\": \"DOMAIN\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:01.225Z\",\n \"updated_at\": \"2022-06-17T08:00:01.225Z\",\n \"finished_at\": \"2022-06-17T08:00:15.197Z\"\n },\n {\n \"job_id\": \"job-587a3d3b4db3\",\n \"status\": \"SUCCESS\",\n \"filter\": {},\n \"total_tasks\": 3,\n \"collector_info\": {\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS stat-kwon Collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13.20220610.143142\"\n },\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"is_public\": true\n },\n \"resource_group\": \"DOMAIN\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.407Z\",\n \"updated_at\": \"2022-06-17T08:00:00.407Z\",\n \"finished_at\": \"2022-06-17T08:07:32.023Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/export": {
- "post": {
- "tags": ["inventory > cloud-service"],
- "summary": "Export",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |options||array|True|\n |file_format|EXCEL, CSV |string||\n |file_name||string||\n |timezone||string||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"options" : {"items": {"$ref": "#/components/schemas/ExportOption"}, "type": "array","title": "OPTIONS" },"file_format" : {"type": "string","title": "FILE_FORMAT" },"file_name" : {"type": "string","title": "FILE_NAME" },"timezone" : {"type": "string","title": "TIMEZONE" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/analyze": {
+ },"/inventory/job/analyze": {
"post": {
- "tags": ["inventory > cloud-service"],
+ "tags": ["inventory > job"],
"summary": "Analyze",
"operationId" : "",
"description": "### Description \n",
@@ -911,9 +839,9 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service/stat": {
+ },"/inventory/job/stat": {
"post": {
- "tags": ["inventory > cloud-service"],
+ "tags": ["inventory > job"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -940,20 +868,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-example/create": {
+ },"/inventory/change-history/list": {
"post": {
- "tags": ["inventory > metric-example"],
- "summary": "Create",
+ "tags": ["inventory > change-history"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |name||string|True|\n |options||Struct|True|\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n |query||Query||\n |action|CREATE, UPDATE, DELETE |string||\n |user_id||string||\n |collector_id||string||\n |job_id||string||\n |updated_by||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"action" : {"type": "string","title": "ACTION" },"user_id" : {"type": "string","title": "USER_ID" },"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"job_id" : {"type": "string","title": "JOB_ID" },"updated_by" : {"type": "string","title": "UPDATED_BY" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -962,29 +890,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricExampleInfo"},
+ "schema": {"$ref": "#/components/schemas/ChangeHistoryInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricExampleInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/ChangeHistoryInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-example/update": {
+ },"/inventory/change-history/stat": {
"post": {
- "tags": ["inventory > metric-example"],
- "summary": "Update",
+ "tags": ["inventory > change-history"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |example_id||string|True|\n |name||string||\n |options||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |cloud_service_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"example_id" : {"type": "string","title": "EXAMPLE_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -993,29 +919,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricExampleInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricExampleInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-example/delete": {
+ },"/inventory/job-task/delete": {
"post": {
- "tags": ["inventory > metric-example"],
+ "tags": ["inventory > job-task"],
"summary": "Delete",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeletes a specific JobTask. You must specify the `job_task_id` of the JobTask to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |example_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_task_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"example_id" : {"type": "string","title": "EXAMPLE_ID" } }
+ "properties": {"job_task_id" : {"type": "string","title": "JOB_TASK_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_task_id\": \"job-task-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
@@ -1025,20 +949,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-example/get": {
+ },"/inventory/job-task/get": {
"post": {
- "tags": ["inventory > metric-example"],
+ "tags": ["inventory > job-task"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific JobTask. Prints detailed information about the JobTask, including its state, updated or failure counts, and error log.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |example_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_task_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"example_id" : {"type": "string","title": "EXAMPLE_ID" } }
+ "properties": {"job_task_id" : {"type": "string","title": "JOB_TASK_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"job_task_id\": \"job-task-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
@@ -1047,29 +971,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricExampleInfo"},
+ "schema": {"$ref": "#/components/schemas/JobTaskInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricExampleInfo"},"Default Example":{
- "value": "{\n\n}"
+ "Schema": {"$ref": "#/components/schemas/JobTaskInfo"},"Default Example":{
+ "value": "{\n \"job_task_id\": \"job-task-123456789012\",\n \"status\": \"FAILURE\",\n \"updated_count\": 199,\n \"failure_count\": 1,\n \"errors\": [\n {\n \"error_code\": \"ERROR_PLUGIN\",\n \"message\": \"{\\\"tags\\\": [\\\"Could not interpret the value as a list\\\"]}\",\n \"additional\": {\n \"domain_id\": \"domain-123456789012\",\n \"resource_id\": \"eventarc-us-central1-function\",\n \"resource_type\": \"inventory.CloudService\",\n \"cloud_service_group\": \"Pub/Sub\",\n \"cloud_service_type\": \"Subscription\",\n \"provider\": \"google_cloud\"\n }\n }\n ],\n \"job_id\": \"job-123456789012\",\n \"secret_id\": \"secret-123456789012\",\n \"provider\": \"google_cloud\",\n \"service_account_id\": \"sa-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T11:00:02.588Z\",\n \"started_at\": \"2022-01-01T11:00:02.819Z\",\n \"finished_at\": \"2022-01-01T11:00:34.398Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-example/list": {
+ },"/inventory/job-task/list": {
"post": {
- "tags": ["inventory > metric-example"],
+ "tags": ["inventory > job-task"],
"summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of all JobTasks in a specific Job. You can use a query to get a filtered list of JobTasks.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |example_id||string||\n |name||string||\n |metric_id||string||\n |namespace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_task_id||string||\n |status|PENDING, CANCELED, IN_PROGRESS, SUCCESS, FAILURE |string||\n |provider||string||\n |workspace_id||string||\n |project_id||string||\n |service_account_id||string||\n |job_id||string||\n |secret_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"example_id" : {"type": "string","title": "EXAMPLE_ID" },"name" : {"type": "string","title": "NAME" },"metric_id" : {"type": "string","title": "METRIC_ID" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_task_id" : {"type": "string","title": "JOB_TASK_ID" },"status" : {"type": "string","title": "STATUS" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"job_id" : {"type": "string","title": "JOB_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -1078,16 +1002,18 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricExamplesInfo"},
+ "schema": {"$ref": "#/components/schemas/JobTasksInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricExamplesInfo"}}
+ "Schema": {"$ref": "#/components/schemas/JobTasksInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"job_task_id\": \"job_task-69b301d0fbfc\",\n \"status\": \"SUCCESS\",\n \"updated_count\": 55,\n \"job_id\": \"job-587a3d3b4db3\",\n \"secret_id\": \"secret-957e407bfc15\",\n \"provider\": \"aws\",\n \"service_account_id\": \"sa-a41ff4765671\",\n \"project_id\": \"project-77dffd3f7cd3\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.680Z\",\n \"started_at\": \"2022-06-17T08:00:00.914Z\",\n \"finished_at\": \"2022-06-17T08:05:48.933Z\"\n },\n {\n \"job_task_id\": \"job_task-c5077338cf23\",\n \"status\": \"SUCCESS\",\n \"updated_count\": 1921,\n \"job_id\": \"job-587a3d3b4db3\",\n \"secret_id\": \"secret-1cd7417c1889\",\n \"provider\": \"aws\",\n \"service_account_id\": \"sa-5e186fcc7c91\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.582Z\",\n \"started_at\": \"2022-06-17T08:00:00.814Z\",\n \"finished_at\": \"2022-06-17T08:07:31.995Z\"\n }\n ],\n \"total_count\": 4839\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-example/stat": {
+ },"/inventory/job-task/stat": {
"post": {
- "tags": ["inventory > metric-example"],
+ "tags": ["inventory > job-task"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -1114,20 +1040,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-stats/list": {
+ },"/inventory/region/create": {
"post": {
- "tags": ["inventory > cloud-service-stats"],
- "summary": "List",
+ "tags": ["inventory > region"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nGets a list of raw statistics data.\nYou can use a query to get a filtered list of statistics data.",
+ "description": "### Description \nCreates a new Region. As the parameter `region_key`, which is automatically created when a Region is created, is in a form of `{provider}.{region_code}`, it is unique regardless of providers. You can also specify the latitude, longitude, and continent information in `tags`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n |query||Query||\n |provider||string||\n |cloud_service_group||string||\n |cloud_service_type||string||\n |region_code||string||\n |account||string||\n |workspace_id||string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |region_code||string|True|\n |provider||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"region_code" : {"type": "string","title": "REGION_CODE" },"account" : {"type": "string","title": "ACCOUNT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"region_code" : {"type": "string","title": "REGION_CODE" },"provider" : {"type": "string","title": "PROVIDER" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": \u003cSearchQuery\u003e,\n \"query_set_id\": \"query-set-abcd1234\",\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"region_code\": \"us-east-1\",\n \"account\": \"aws-account-id\",\n \"project_id\": \"project-abcd1234\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asis_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -1136,29 +1062,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceStatsInfo"},
+ "schema": {"$ref": "#/components/schemas/RegionInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceStatsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"query_set_id\": \"query-set-abcd1234\",\n \"key\": \"Disk Size\",\n \"data\": {\n \"Disk Size\": 1040,\n \"Memory Size\": 1024,\n \"CPU\": 2\n },\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"region_code\": \"us-east-1\",\n \"account\": \"aws-account-id\",\n \"additional_info\": {\n \"instance_type\": \"t2.micro\"\n },\n \"project_id\": \"project-abcd1234\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_date\": \"2022-06-22\"\n },\n {...}\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/RegionInfo"},"Default Example":{
+ "value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-stats/analyze": {
+ },"/inventory/region/update": {
"post": {
- "tags": ["inventory > cloud-service-stats"],
- "summary": "Analyze",
+ "tags": ["inventory > region"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nUpdates a specific Region. You can make changes in Region settings, including `name` and `tags`. The `tags` contain the continent, latitude, and longitude.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |query_set_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |region_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"region_id" : {"type": "string","title": "REGION_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Region home\",\n \"tags\": {\n \"latitude\": \"6.34545\",\n \"continent\": \"asia_pacific\",\n \"longitude\": \"5.6433213\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -1167,56 +1093,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/RegionInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/RegionInfo"},"Default Example":{
+ "value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-stats/stat": {
+ },"/inventory/region/delete": {
"post": {
- "tags": ["inventory > cloud-service-stats"],
- "summary": "Stat",
+ "tags": ["inventory > region"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeletes a specific Region. You must specify the `region_id` of the Region to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |query_set_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |region_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
+ "properties": {"region_id" : {"type": "string","title": "REGION_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"region_id\": \"region-e41deed3c939\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/create": {
+ },"/inventory/region/get": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "Create",
+ "tags": ["inventory > region"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific Region. Prints detailed information about the Region, including `name`, `region_code`, and a location coordinate.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |metric_type|COUNTER, GAUGE |string|True|\n |query_options||AnalyzeQuery|True|\n |namespace_id||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |metric_id||string||\n |resource_type||string||\n |date_field||string||\n |unit||string||\n |tags||Struct||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |region_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"name" : {"type": "string","title": "NAME" },"metric_type" : {"type": "string","title": "METRIC_TYPE" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"date_field" : {"type": "string","title": "DATE_FIELD" },"unit" : {"type": "string","title": "UNIT" },"tags" : {"type": "object","title": "TAGS" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"region_id" : {"type": "string","title": "REGION_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"region_id\": \"region-e41deed3c939\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1225,29 +1147,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricInfo"},
+ "schema": {"$ref": "#/components/schemas/RegionInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricInfo"},"Default Example":{
- "value": "{\n\n}"
+ "Schema": {"$ref": "#/components/schemas/RegionInfo"},"Default Example":{
+ "value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/update": {
+ },"/inventory/region/list": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "Update",
+ "tags": ["inventory > region"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of all Regions. You can use a query to get a filtered list of Regions.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |name||string||\n |query_options||AnalyzeQuery||\n |date_field||string||\n |unit||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |region_id||string||\n |name||string||\n |region_key||string||\n |region_code||string||\n |provider||string||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"name" : {"type": "string","title": "NAME" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"date_field" : {"type": "string","title": "DATE_FIELD" },"unit" : {"type": "string","title": "UNIT" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"region_id" : {"type": "string","title": "REGION_ID" },"name" : {"type": "string","title": "NAME" },"region_key" : {"type": "string","title": "REGION_KEY" },"region_code" : {"type": "string","title": "REGION_CODE" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {\n \"filter\": [\n {\n \"key\": \"name\",\n \"value\": \"Asia Pacific\",\n \"operator\": \"contain\"\n }\n ]\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -1256,50 +1178,56 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricInfo"},
+ "schema": {"$ref": "#/components/schemas/RegionsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricInfo"},"Default Example":{
- "value": "{\n\n}"
+ "Schema": {"$ref": "#/components/schemas/RegionsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Mumbai)\",\n \"region_key\": \"aws.ap-south-1\",\n \"region_code\": \"ap-south-1\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n },\n {\n \"region_id\": \"region-f803eb00b567\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"latitude\": \"6.34545\",\n \"continent\": \"asia_pacific\",\n \"longitude\": \"5.6433213\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2022-03-21T09:08:31.961Z\",\n \"updated_at\": \"2022-06-17T00:07:35.749Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/delete": {
+ },"/inventory/region/stat": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "Delete",
+ "tags": ["inventory > region"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/run": {
+ },"/inventory/note/create": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "Run",
+ "tags": ["inventory > note"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |record_id||string|True|\n |note||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" } }
+ "properties": {"record_id" : {"type": "string","title": "RECORD_ID" },"note" : {"type": "string","title": "NOTE" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1308,21 +1236,29 @@
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/NoteInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
+ "value": "{\n\n}"
+ }}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/test": {
+ },"/inventory/note/update": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "Test",
+ "tags": ["inventory > note"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |query_options||AnalyzeQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n |note||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" } }
+ "properties": {"note_id" : {"type": "string","title": "NOTE_ID" },"note" : {"type": "string","title": "NOTE" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1333,25 +1269,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/NoteInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
+ "value": "{\n\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/get": {
+ },"/inventory/note/delete": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "Get",
+ "tags": ["inventory > note"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" } }
+ "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1360,29 +1298,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/MetricInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/MetricInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/list": {
+ },"/inventory/note/get": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "List",
+ "tags": ["inventory > note"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |metric_id||string||\n |metric_type|COUNTER, GAUGE |string||\n |resource_type||string||\n |is_managed||string||\n |workspace_id||string||\n |namespace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" },"metric_type" : {"type": "string","title": "METRIC_TYPE" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"is_managed" : {"type": "string","title": "IS_MANAGED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
+ "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1393,27 +1323,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricsInfo"},
+ "schema": {"$ref": "#/components/schemas/NoteInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
+ "value": "{\n\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric/stat": {
+ },"/inventory/note/list": {
"post": {
- "tags": ["inventory > metric"],
- "summary": "Stat",
+ "tags": ["inventory > note"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |note_id||string||\n |record_id||string||\n |cloud_service_id||string||\n |created_by||string||\n |workspace_id||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"note_id" : {"type": "string","title": "NOTE_ID" },"record_id" : {"type": "string","title": "RECORD_ID" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"created_by" : {"type": "string","title": "CREATED_BY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1422,27 +1354,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/NotesInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/NotesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/create": {
+ },"/inventory/note/stat": {
"post": {
- "tags": ["inventory > collector"],
- "summary": "Create",
+ "tags": ["inventory > note"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nCreates a new Collector with information of the plugin to use. Information of the plugin includes `version`, `provider`, and `upgrade_mode`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |plugin_info||PluginInfo|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |schedule||Scheduled||\n |provider||string||\n |secret_filter||SecretFilter||\n |tags||Struct||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"provider" : {"type": "string","title": "PROVIDER" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"filter_format\": [],\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"tags\": {\n \"type\": \"test\"\n },\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -1451,29 +1383,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CollectorInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
- "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/update": {
+ },"/inventory/metric-example/create": {
"post": {
- "tags": ["inventory > collector"],
- "summary": "Update",
+ "tags": ["inventory > metric-example"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nUpdates a specific Collector. You can make changes in Collector settings, including `name` and `tags`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |name||string||\n |schedule||Scheduled||\n |secret_filter||SecretFilter||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |name||string|True|\n |options||Struct|True|\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"name" : {"type": "string","title": "NAME" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"New AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.14.0\",\n \"provider\": \"aws\",\n \"upgrade_mode\": \"MANUAL\"\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"tags\": {\n \"a\": \"b\"\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1482,29 +1412,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CollectorInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricExampleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
- "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/MetricExampleInfo"},"Default Example":{
+ "value": "{\n\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/update-plugin": {
+ },"/inventory/metric-example/update": {
"post": {
- "tags": ["inventory > collector"],
- "summary": "Update Plugin",
+ "tags": ["inventory > metric-example"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdates the plugin of a specific Collector. This method resets the plugin data in the Collector to update the `metadata`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |example_id||string|True|\n |name||string||\n |options||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
+ "properties": {"example_id" : {"type": "string","title": "EXAMPLE_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"type": "object","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1513,52 +1443,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CollectorInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricExampleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
- "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/MetricExampleInfo"},"Default Example":{
+ "value": "{\n\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/verify-plugin": {
- "post": {
- "tags": ["inventory > collector"],
- "summary": "Verify Plugin",
- "operationId" : "",
- "description": "### Description \nVerifies the plugin of a specific Collector. This method validates the plugin data, `version` and `endpoint`.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |secret_id||string||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/delete": {
+ },"/inventory/metric-example/delete": {
"post": {
- "tags": ["inventory > collector"],
+ "tags": ["inventory > metric-example"],
"summary": "Delete",
"operationId" : "",
- "description": "### Description \nDeletes a specific Collector. You must specify the `collector_id` of the Collector to delete.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |example_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" } }
+ "properties": {"example_id" : {"type": "string","title": "EXAMPLE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"collector_id\": \"collector-f2e4e9cc7f21\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1568,20 +1475,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/get": {
+ },"/inventory/metric-example/get": {
"post": {
- "tags": ["inventory > collector"],
+ "tags": ["inventory > metric-example"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a specific Collector. Prints detailed information about the Collector, including its state, basic information, and the plugin information used for cloud resource collection.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |example_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" } }
+ "properties": {"example_id" : {"type": "string","title": "EXAMPLE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"collector_id\": \"collector-f2e4e9cc7f21\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1590,29 +1497,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CollectorInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricExampleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
- "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/MetricExampleInfo"},"Default Example":{
+ "value": "{\n\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/list": {
+ },"/inventory/metric-example/list": {
"post": {
- "tags": ["inventory > collector"],
+ "tags": ["inventory > metric-example"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Collectors. You can use a query to get a filtered list of Collectors.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query|True|\n |collector_id||string|True|\n |name||string|True|\n |secret_filter_state|ENABLED, DISABLED |string|True|\n |schedule_state|ENABLED, DISABLED |string|True|\n |workspace_id||string|True|\n |plugin_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |example_id||string||\n |name||string||\n |metric_id||string||\n |namespace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"name" : {"type": "string","title": "NAME" },"secret_filter_state" : {"type": "string","title": "SECRET_FILTER_STATE" },"schedule_state" : {"type": "string","title": "SCHEDULE_STATE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"example_id" : {"type": "string","title": "EXAMPLE_ID" },"name" : {"type": "string","title": "NAME" },"metric_id" : {"type": "string","title": "METRIC_ID" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1621,18 +1528,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CollectorsInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricExamplesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CollectorsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n },\n {\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n }\n ],\n \"total_count\": 2\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/MetricExamplesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/stat": {
+ },"/inventory/metric-example/stat": {
"post": {
- "tags": ["inventory > collector"],
+ "tags": ["inventory > metric-example"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -1659,20 +1564,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector/collect": {
+ },"/inventory/metric/create": {
"post": {
- "tags": ["inventory > collector"],
- "summary": "Collect",
+ "tags": ["inventory > metric"],
+ "summary": "Create",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |secret_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |metric_type|COUNTER, GAUGE |string|True|\n |query_options||AnalyzeQuery|True|\n |namespace_id||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |metric_id||string||\n |resource_type||string||\n |date_field||string||\n |unit||string||\n |tags||Struct||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
+ "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"name" : {"type": "string","title": "NAME" },"metric_type" : {"type": "string","title": "METRIC_TYPE" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"date_field" : {"type": "string","title": "DATE_FIELD" },"unit" : {"type": "string","title": "UNIT" },"tags" : {"type": "object","title": "TAGS" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1681,27 +1586,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
- "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"filter\": {},\n \"total_tasks\": 2,\n \"collector_info\": {\n \"collector_id\": \"collector-123456789012\",\n \"name\": \"Jenkins Collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-jenkins-inven-collector\",\n \"version\": \"0.1.1\"\n },\n \"provider\": \"jenkins\",\n \"capability\": {},\n \"is_public\": true\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/MetricInfo"},"Default Example":{
+ "value": "{\n\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/note/create": {
+ },"/inventory/metric/update": {
"post": {
- "tags": ["inventory > note"],
- "summary": "Create",
+ "tags": ["inventory > metric"],
+ "summary": "Update",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |record_id||string|True|\n |note||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |name||string||\n |query_options||AnalyzeQuery||\n |date_field||string||\n |unit||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"record_id" : {"type": "string","title": "RECORD_ID" },"note" : {"type": "string","title": "NOTE" } }
+ "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"name" : {"type": "string","title": "NAME" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"date_field" : {"type": "string","title": "DATE_FIELD" },"unit" : {"type": "string","title": "UNIT" },"tags" : {"type": "object","title": "TAGS" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1712,27 +1617,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NoteInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
+ "Schema": {"$ref": "#/components/schemas/MetricInfo"},"Default Example":{
"value": "{\n\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/note/update": {
+ },"/inventory/metric/delete": {
"post": {
- "tags": ["inventory > note"],
- "summary": "Update",
+ "tags": ["inventory > metric"],
+ "summary": "Delete",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n |note||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"note_id" : {"type": "string","title": "NOTE_ID" },"note" : {"type": "string","title": "NOTE" } }
+ "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1741,29 +1646,21 @@
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/NoteInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/note/delete": {
+ },"/inventory/metric/run": {
"post": {
- "tags": ["inventory > note"],
- "summary": "Delete",
+ "tags": ["inventory > metric"],
+ "summary": "Run",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
+ "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1775,18 +1672,18 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/note/get": {
+ },"/inventory/metric/test": {
"post": {
- "tags": ["inventory > note"],
- "summary": "Get",
+ "tags": ["inventory > metric"],
+ "summary": "Test",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |query_options||AnalyzeQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
+ "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1797,27 +1694,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NoteInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
- "value": "{\n\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/note/list": {
+ },"/inventory/metric/get": {
"post": {
- "tags": ["inventory > note"],
- "summary": "List",
+ "tags": ["inventory > metric"],
+ "summary": "Get",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |note_id||string||\n |record_id||string||\n |cloud_service_id||string||\n |created_by||string||\n |workspace_id||string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"note_id" : {"type": "string","title": "NOTE_ID" },"record_id" : {"type": "string","title": "RECORD_ID" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"created_by" : {"type": "string","title": "CREATED_BY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"metric_id" : {"type": "string","title": "METRIC_ID" } }
},
"examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
@@ -1828,27 +1723,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NotesInfo"},
+ "schema": {"$ref": "#/components/schemas/MetricInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NotesInfo"}}
+ "Schema": {"$ref": "#/components/schemas/MetricInfo"},"Default Example":{
+ "value": "{\n\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/note/stat": {
+ },"/inventory/metric/list": {
"post": {
- "tags": ["inventory > note"],
- "summary": "Stat",
+ "tags": ["inventory > metric"],
+ "summary": "List",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |metric_id||string||\n |metric_type|COUNTER, GAUGE |string||\n |resource_type||string||\n |is_managed||string||\n |workspace_id||string||\n |namespace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" },"metric_type" : {"type": "string","title": "METRIC_TYPE" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"is_managed" : {"type": "string","title": "IS_MANAGED" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"namespace_id" : {"type": "string","title": "NAMESPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
}
}
},"required": true
@@ -1857,50 +1754,56 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/MetricsInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/MetricsInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job-task/delete": {
+ },"/inventory/metric/stat": {
"post": {
- "tags": ["inventory > job-task"],
- "summary": "Delete",
+ "tags": ["inventory > metric"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nDeletes a specific JobTask. You must specify the `job_task_id` of the JobTask to delete.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_task_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_task_id" : {"type": "string","title": "JOB_TASK_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_task_id\": \"job-task-123456789012\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job-task/get": {
+ },"/inventory/cloud-service-query-set/create": {
"post": {
- "tags": ["inventory > job-task"],
- "summary": "Get",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nGets a specific JobTask. Prints detailed information about the JobTask, including its state, updated or failure counts, and error log.",
+ "description": "### Description \nCreate a new query set. Periodic statistics data is created based on the query set.\n`query` parameters refer to AnalyzeQuery.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_task_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |query_options||AnalyzeQuery|True|\n |provider||string|True|\n |cloud_service_group||string|True|\n |cloud_service_type||string|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |unit||Struct||\n |tags||Struct||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_task_id" : {"type": "string","title": "JOB_TASK_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"unit" : {"type": "object","title": "UNIT" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_task_id\": \"job-task-123456789012\",\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"EC2 Count by Instance Type\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -1909,29 +1812,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobTaskInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobTaskInfo"},"Default Example":{
- "value": "{\n \"job_task_id\": \"job-task-123456789012\",\n \"status\": \"FAILURE\",\n \"updated_count\": 199,\n \"failure_count\": 1,\n \"errors\": [\n {\n \"error_code\": \"ERROR_PLUGIN\",\n \"message\": \"{\\\"tags\\\": [\\\"Could not interpret the value as a list\\\"]}\",\n \"additional\": {\n \"domain_id\": \"domain-123456789012\",\n \"resource_id\": \"eventarc-us-central1-function\",\n \"resource_type\": \"inventory.CloudService\",\n \"cloud_service_group\": \"Pub/Sub\",\n \"cloud_service_type\": \"Subscription\",\n \"provider\": \"google_cloud\"\n }\n }\n ],\n \"job_id\": \"job-123456789012\",\n \"secret_id\": \"secret-123456789012\",\n \"provider\": \"google_cloud\",\n \"service_account_id\": \"sa-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T11:00:02.588Z\",\n \"started_at\": \"2022-01-01T11:00:02.819Z\",\n \"finished_at\": \"2022-01-01T11:00:34.398Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
+ "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job-task/list": {
+ },"/inventory/cloud-service-query-set/update": {
"post": {
- "tags": ["inventory > job-task"],
- "summary": "List",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nGets a list of all JobTasks in a specific Job. You can use a query to get a filtered list of JobTasks.",
+ "description": "### Description \nUpdate a specific query set. You can only update the query set of custom type.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_task_id||string||\n |status|PENDING, CANCELED, IN_PROGRESS, SUCCESS, FAILURE |string||\n |provider||string||\n |workspace_id||string||\n |project_id||string||\n |service_account_id||string||\n |job_id||string||\n |secret_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n |name||string||\n |query_options||AnalyzeQuery||\n |unit||Struct||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_task_id" : {"type": "string","title": "JOB_TASK_ID" },"status" : {"type": "string","title": "STATUS" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID" },"job_id" : {"type": "string","title": "JOB_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
+ "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" },"name" : {"type": "string","title": "NAME" },"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS" },"unit" : {"type": "object","title": "UNIT" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"Changed Name\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"tags\": {\n \"changed_key\": \"changed_value\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -1940,87 +1843,75 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobTasksInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobTasksInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"job_task_id\": \"job_task-69b301d0fbfc\",\n \"status\": \"SUCCESS\",\n \"updated_count\": 55,\n \"job_id\": \"job-587a3d3b4db3\",\n \"secret_id\": \"secret-957e407bfc15\",\n \"provider\": \"aws\",\n \"service_account_id\": \"sa-a41ff4765671\",\n \"project_id\": \"project-77dffd3f7cd3\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.680Z\",\n \"started_at\": \"2022-06-17T08:00:00.914Z\",\n \"finished_at\": \"2022-06-17T08:05:48.933Z\"\n },\n {\n \"job_task_id\": \"job_task-c5077338cf23\",\n \"status\": \"SUCCESS\",\n \"updated_count\": 1921,\n \"job_id\": \"job-587a3d3b4db3\",\n \"secret_id\": \"secret-1cd7417c1889\",\n \"provider\": \"aws\",\n \"service_account_id\": \"sa-5e186fcc7c91\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.582Z\",\n \"started_at\": \"2022-06-17T08:00:00.814Z\",\n \"finished_at\": \"2022-06-17T08:07:31.995Z\"\n }\n ],\n \"total_count\": 4839\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
+ "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job-task/stat": {
+ },"/inventory/cloud-service-query-set/delete": {
"post": {
- "tags": ["inventory > job-task"],
- "summary": "Stat",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDelete a specific query set.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-data/list": {
+ },"/inventory/cloud-service-query-set/run": {
"post": {
- "tags": ["inventory > metric-data"],
- "summary": "List",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Run",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nRun a specific query set and store the result in the statistics data.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |metric_id||string|True|\n |query||Query||\n |workspace_id||string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/MetricDatasInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/MetricDatasInfo"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-data/stat": {
+ },"/inventory/cloud-service-query-set/test": {
"post": {
- "tags": ["inventory > metric-data"],
- "summary": "Stat",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Test",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nRun a specific query set and store the result in the statistics data.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n |metric_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" } }
+ "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2036,20 +1927,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/metric-data/analyze": {
+ },"/inventory/cloud-service-query-set/enable": {
"post": {
- "tags": ["inventory > metric-data"],
- "summary": "Analyze",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Enable",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nEnable a specific query set.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||TimeSeriesAnalyzeQuery|True|\n |metric_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY" },"metric_id" : {"type": "string","title": "METRIC_ID" } }
+ "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2058,27 +1949,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
+ "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector-rule/create": {
+ },"/inventory/cloud-service-query-set/disable": {
"post": {
- "tags": ["inventory > collector-rule"],
- "summary": "Create",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Disable",
"operationId" : "",
- "description": "### Description \nCreates a new CollectorRule. When creating the cloud service, this method can apply two types of conditions: mapping projects where the cloud service incurred to the Cloud Service, and mapping cloud service accounts to the Cloud Service. By adjusting the `condition_policy` parameter, the CollectorRule can be applied when all conditions are met, applied when any of the conditions are met, or always applied regardless of whether the conditions are met.",
+ "description": "### Description \nDisable a specific query set. query set is not executed when disabled.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |conditions_policy|ALL, ANY, ALWAYS |string|True|\n |actions||CollectorRuleActions|True|\n |name||string||\n |conditions||array||\n |options||CollectorRuleOptions||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/CollectorRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/CollectorRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/CollectorRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\"source\": \"account\", \"target\": \"data.project_id\"}\n },\n \"options\": {\"stop_processing\": true},\n \"tags\": {\"b\": \"c\", \"a\": \"b\"},\n \"collector_id\": \"collector-2e39891cbbb5\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2087,29 +1980,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},"Default Example":{
- "value": "{\n \"collector_rule_id\": \"collector-rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"collector_id\": \"collector-2e39891cbbb5\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
+ "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector-rule/update": {
+ },"/inventory/cloud-service-query-set/get": {
"post": {
- "tags": ["inventory > collector-rule"],
- "summary": "Update",
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nUpdates a specific CollectorRule. You can make changes in CollectorRule settings, including filtering conditions.",
+ "description": "### Description \nGet a specific query set.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_rule_id||string|True|\n |name||string||\n |conditions||array||\n |conditions_policy|ALL, ANY, ALWAYS |string||\n |actions||CollectorRuleActions||\n |options||CollectorRuleOptions||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query_set_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"collector_rule_id" : {"type": "string","title": "COLLECTOR_RULE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/CollectorRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/CollectorRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/CollectorRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"query_set_id" : {"type": "string","title": "QUERY_SET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"collector_rule_id\": \"collector-rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\"b\": \"c\", \"a\": \"b\"}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query_set_id\": \"query-set-abcd1234\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2118,16 +2011,138 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},"Default Example":{
- "value": "{\n \"collector_rule_id\": \"collector-rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"collector_id\": \"collector-2e39891cbbb5\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},"Default Example":{
+ "value": "{\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"query_type\": \"MANAGED\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\"\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/collector-rule/change-order": {
+ },"/inventory/cloud-service-query-set/list": {
+ "post": {
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "List",
+ "operationId" : "",
+ "description": "### Description \nGets a list of all query sets.\nYou can use a query to get a filtered list of query sets.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |query_set_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |query_type|MANAGED, CUSTOM |string||\n |provider||string||\n |cloud_service_group||string||\n |cloud_service_type||string||\n |workspace_id||string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"query_set_id" : {"type": "string","title": "QUERY_SET_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"query_type" : {"type": "string","title": "QUERY_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"query\": \u003cSearchQuery\u003e,\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_type\": \"MANAGED\",\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"resource_group\": \"DOMAIN\",\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/CloudServiceQuerySetsInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/CloudServiceQuerySetsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"query_set_id\": \"query-set-abcd1234\",\n \"name\": \"EC2 Count by Instance Type\",\n \"state\": \"ENABLED\",\n \"query_type\": \"MANAGED\",\n \"query_options\": \"\u003cAnalyzeQuery\u003e\",\n \"unit\": {\n \"Disk Size\": \"GB\",\n \"Memory\": \"GB\",\n \"CPU\": \"Core\"\n },\n \"data_keys\": [\n \"Disk Size\",\n \"Memory\",\n \"CPU\n ],\n \"additional_info_keys\": [\n \"instance_type\"\n ],\n \"provider\": \"aws\",\n \"cloud_service_group\": \"EC2\",\n \"cloud_service_type\": \"Instance\",\n \"tags\": {\n \"foo\": \"bar\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T01:38:16.301Z\",\n \"updated_at\": \"2023-03-16T06:00:00.000Z\"\n },\n {...}\n ],\n \"total_count\": 2\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/inventory/cloud-service-query-set/stat": {
+ "post": {
+ "tags": ["inventory > cloud-service-query-set"],
+ "summary": "Stat",
+ "operationId" : "",
+ "description": "### Description \n",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/inventory/collector-rule/create": {
+ "post": {
+ "tags": ["inventory > collector-rule"],
+ "summary": "Create",
+ "operationId" : "",
+ "description": "### Description \nCreates a new CollectorRule. When creating the cloud service, this method can apply two types of conditions: mapping projects where the cloud service incurred to the Cloud Service, and mapping cloud service accounts to the Cloud Service. By adjusting the `condition_policy` parameter, the CollectorRule can be applied when all conditions are met, applied when any of the conditions are met, or always applied regardless of whether the conditions are met.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |conditions_policy|ALL, ANY, ALWAYS |string|True|\n |actions||CollectorRuleActions|True|\n |name||string||\n |conditions||array||\n |options||CollectorRuleOptions||\n |tags||Struct||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/CollectorRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/CollectorRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/CollectorRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\"source\": \"account\", \"target\": \"data.project_id\"}\n },\n \"options\": {\"stop_processing\": true},\n \"tags\": {\"b\": \"c\", \"a\": \"b\"},\n \"collector_id\": \"collector-2e39891cbbb5\"\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},"Default Example":{
+ "value": "{\n \"collector_rule_id\": \"collector-rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"collector_id\": \"collector-2e39891cbbb5\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/inventory/collector-rule/update": {
+ "post": {
+ "tags": ["inventory > collector-rule"],
+ "summary": "Update",
+ "operationId" : "",
+ "description": "### Description \nUpdates a specific CollectorRule. You can make changes in CollectorRule settings, including filtering conditions.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_rule_id||string|True|\n |name||string||\n |conditions||array||\n |conditions_policy|ALL, ANY, ALWAYS |string||\n |actions||CollectorRuleActions||\n |options||CollectorRuleOptions||\n |tags||Struct||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"collector_rule_id" : {"type": "string","title": "COLLECTOR_RULE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/CollectorRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/CollectorRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/CollectorRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"collector_rule_id\": \"collector-rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\"b\": \"c\", \"a\": \"b\"}\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/CollectorRuleInfo"},"Default Example":{
+ "value": "{\n \"collector_rule_id\": \"collector-rule-c8055231e212\",\n \"name\": \"match_service_account_test\",\n \"order\": 2,\n \"conditions_policy\": \"ALWAYS\",\n \"actions\": {\n \"match_service_account\": {\n \"source\": \"account\",\n \"target\": \"data.project_id\"\n }\n },\n \"options\": {\n \"stop_processing\": true\n },\n \"tags\": {\n \"a\": \"b\",\n \"b\": \"c\"\n },\n \"collector_id\": \"collector-2e39891cbbb5\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-07-19T10:13:28.335Z\"\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/inventory/collector-rule/change-order": {
"post": {
"tags": ["inventory > collector-rule"],
"summary": "Change Order",
@@ -2272,20 +2287,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-report/create": {
+ },"/inventory/collector/create": {
"post": {
- "tags": ["inventory > cloud-service-report"],
+ "tags": ["inventory > collector"],
"summary": "Create",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nCreates a new Collector with information of the plugin to use. Information of the plugin includes `version`, `provider`, and `upgrade_mode`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |options||array|True|\n |schedule||ReportSchedule|True|\n |target||Struct|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |file_format|EXCEL, CSV |string||\n |timezone||string||\n |language||string||\n |tags||Struct||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |plugin_info||PluginInfo|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |schedule||Scheduled||\n |provider||string||\n |secret_filter||SecretFilter||\n |tags||Struct||\n |workspace_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"options" : {"items": {"$ref": "#/components/schemas/ExportOption"}, "type": "array","title": "OPTIONS" },"file_format" : {"type": "string","title": "FILE_FORMAT" },"timezone" : {"type": "string","title": "TIMEZONE" },"language" : {"type": "string","title": "LANGUAGE" },"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE" },"target" : {"type": "object","title": "TARGET" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"provider" : {"type": "string","title": "PROVIDER" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"filter_format\": [],\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"tags\": {\n \"type\": \"test\"\n },\n}"},"Schema":{}
}
}
},"required": true
@@ -2294,25 +2309,58 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
+ "schema": {"$ref": "#/components/schemas/CollectorInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
+ "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-report/update": {
+ },"/inventory/collector/update": {
"post": {
- "tags": ["inventory > cloud-service-report"],
+ "tags": ["inventory > collector"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nUpdates a specific Collector. You can make changes in Collector settings, including `name` and `tags`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n |name||string||\n |options||array||\n |file_format|EXCEL, CSV |string||\n |timezone||string||\n |language||string||\n |schedule||ReportSchedule||\n |target||Struct||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |name||string||\n |schedule||Scheduled||\n |secret_filter||SecretFilter||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"report_id" : {"type": "string","title": "REPORT_ID" },"name" : {"type": "string","title": "NAME" },"options" : {"items": {"$ref": "#/components/schemas/ExportOption"}, "type": "array","title": "OPTIONS" },"file_format" : {"type": "string","title": "FILE_FORMAT" },"timezone" : {"type": "string","title": "TIMEZONE" },"language" : {"type": "string","title": "LANGUAGE" },"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE" },"target" : {"type": "object","title": "TARGET" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"name" : {"type": "string","title": "NAME" },"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE" },"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER" },"tags" : {"type": "object","title": "TAGS" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"New AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.14.0\",\n \"provider\": \"aws\",\n \"upgrade_mode\": \"MANUAL\"\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"tags\": {\n \"a\": \"b\"\n }\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/CollectorInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
+ "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/inventory/collector/update-plugin": {
+ "post": {
+ "tags": ["inventory > collector"],
+ "summary": "Update Plugin",
+ "operationId" : "",
+ "description": "### Description \nUpdates the plugin of a specific Collector. This method resets the plugin data in the Collector to update the `metadata`.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
},
"examples":{"Schema":{}
}
@@ -2323,25 +2371,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
+ "schema": {"$ref": "#/components/schemas/CollectorInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
+ "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-report/delete": {
+ },"/inventory/collector/verify-plugin": {
"post": {
- "tags": ["inventory > cloud-service-report"],
- "summary": "Delete",
+ "tags": ["inventory > collector"],
+ "summary": "Verify Plugin",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nVerifies the plugin of a specific Collector. This method validates the plugin data, `version` and `endpoint`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |secret_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"report_id" : {"type": "string","title": "REPORT_ID" } }
+ "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
},
"examples":{"Schema":{}
}
@@ -2353,20 +2403,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-report/send": {
+ },"/inventory/collector/delete": {
"post": {
- "tags": ["inventory > cloud-service-report"],
- "summary": "Send",
+ "tags": ["inventory > collector"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeletes a specific Collector. You must specify the `collector_id` of the Collector to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"report_id" : {"type": "string","title": "REPORT_ID" } }
+ "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"collector_id\": \"collector-f2e4e9cc7f21\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2376,20 +2426,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-report/get": {
+ },"/inventory/collector/get": {
"post": {
- "tags": ["inventory > cloud-service-report"],
+ "tags": ["inventory > collector"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific Collector. Prints detailed information about the Collector, including its state, basic information, and the plugin information used for cloud resource collection.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |report_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"report_id" : {"type": "string","title": "REPORT_ID" } }
+ "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"collector_id\": \"collector-f2e4e9cc7f21\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2398,27 +2448,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
+ "schema": {"$ref": "#/components/schemas/CollectorInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceReportInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CollectorInfo"},"Default Example":{
+ "value": "{\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-report/list": {
+ },"/inventory/collector/list": {
"post": {
- "tags": ["inventory > cloud-service-report"],
+ "tags": ["inventory > collector"],
"summary": "List",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a list of all Collectors. You can use a query to get a filtered list of Collectors.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |report_id||string||\n |name||string||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query|True|\n |collector_id||string|True|\n |name||string|True|\n |secret_filter_state|ENABLED, DISABLED |string|True|\n |schedule_state|ENABLED, DISABLED |string|True|\n |workspace_id||string|True|\n |plugin_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"report_id" : {"type": "string","title": "REPORT_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"name" : {"type": "string","title": "NAME" },"secret_filter_state" : {"type": "string","title": "SECRET_FILTER_STATE" },"schedule_state" : {"type": "string","title": "SCHEDULE_STATE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
}
},"required": true
@@ -2427,16 +2479,18 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/CloudServiceReportsInfo"},
+ "schema": {"$ref": "#/components/schemas/CollectorsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/CloudServiceReportsInfo"}}
+ "Schema": {"$ref": "#/components/schemas/CollectorsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n },\n {\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS Collector\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13\",\n \"options\": {},\n \"metadata\": {\n \"supported_schedules\": [\n \"hours\"\n ],\n \"supported_resource_type\": [\n \"inventory.CloudService\",\n \"inventory.CloudServiceType\",\n \"inventory.Region\"\n ],\n \"filter_format\": [],\n \"supported_features\": [\n \"garbage_collection\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"type\": \"test\"\n },\n \"created_at\": \"2022-06-17T06:33:27.195Z\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"schedule\": {\n \"state\": \"ENABLED\",\n \"hours\": [0, 6, 12, 18]\n },\n \"secret_filter\": {\n \"state\": \"ENABLED\",\n \"secrets\": [\"secret-xxx\", \"secret-yyy\"],\n \"service_accounts\": [\"sa-xxx\", \"sa-yyy\"],\n \"schemas\": [\"schema-xxx\", \"schema-yyy\"]\n },\n \"last_collected_at\": \"2022-06-17T06:33:27.195Z\"\n }\n ],\n \"total_count\": 2\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/cloud-service-report/stat": {
+ },"/inventory/collector/stat": {
"post": {
- "tags": ["inventory > cloud-service-report"],
+ "tags": ["inventory > collector"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -2463,20 +2517,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/region/create": {
+ },"/inventory/collector/collect": {
"post": {
- "tags": ["inventory > region"],
- "summary": "Create",
+ "tags": ["inventory > collector"],
+ "summary": "Collect",
"operationId" : "",
- "description": "### Description \nCreates a new Region. As the parameter `region_key`, which is automatically created when a Region is created, is in a form of `{provider}.{region_code}`, it is unique regardless of providers. You can also specify the latitude, longitude, and continent information in `tags`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |region_code||string|True|\n |provider||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |collector_id||string|True|\n |secret_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"region_code" : {"type": "string","title": "REGION_CODE" },"provider" : {"type": "string","title": "PROVIDER" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"secret_id" : {"type": "string","title": "SECRET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asis_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n }\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2485,29 +2539,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RegionInfo"},
+ "schema": {"$ref": "#/components/schemas/JobInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RegionInfo"},"Default Example":{
- "value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
+ "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"filter\": {},\n \"total_tasks\": 2,\n \"collector_info\": {\n \"collector_id\": \"collector-123456789012\",\n \"name\": \"Jenkins Collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-jenkins-inven-collector\",\n \"version\": \"0.1.1\"\n },\n \"provider\": \"jenkins\",\n \"capability\": {},\n \"is_public\": true\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/region/update": {
+ },"/inventory/cloud-service/create": {
"post": {
- "tags": ["inventory > region"],
- "summary": "Update",
+ "tags": ["inventory > cloud-service"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nUpdates a specific Region. You can make changes in Region settings, including `name` and `tags`. The `tags` contain the continent, latitude, and longitude.",
+ "description": "### Description \nCreates a new CloudService. A CloudService instance is created based on data including the `resource`'s attribute values. When creating, the classification information defined by CloudServiceType is also needed. The created CloudService has collection information which is the collection history for the `resource` by plugin.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |region_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_type||string|True|\n |provider||string|True|\n |cloud_service_group||string|True|\n |data||Struct|True|\n |name||string||\n |account||string||\n |instance_type||string||\n |instance_size||float||\n |ip_addresses||array||\n |metadata||Struct||\n |reference||CloudServiceReference||\n |tags||Struct||\n |region_code||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"region_id" : {"type": "string","title": "REGION_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"name" : {"type": "string","title": "NAME" },"account" : {"type": "string","title": "ACCOUNT" },"instance_type" : {"type": "string","title": "INSTANCE_TYPE" },"instance_size" : {"type": "float","title": "INSTANCE_SIZE" },"ip_addresses" : {"items": {}, "type": "array","title": "IP_ADDRESSES" },"data" : {"type": "object","title": "DATA" },"metadata" : {"type": "object","title": "METADATA" },"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE" },"tags" : {"type": "object","title": "TAGS" },"region_code" : {"type": "string","title": "REGION_CODE" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Region home\",\n \"tags\": {\n \"latitude\": \"6.34545\",\n \"continent\": \"asia_pacific\",\n \"longitude\": \"5.6433213\"\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cloud_service_type\": \"Key\",\n \"provider\": \"aws\",\n \"cloud_service_group\": \"KMS\",\n \"name\": \"cloud_service_test\",\n \"account\": \"251340636361\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\",\n \"ip_addresses\": [],\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {},\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"region_code\": \"ap-northeast-1\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2516,52 +2570,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RegionInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RegionInfo"},"Default Example":{
- "value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceInfo"},"Default Example":{
+ "value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/region/delete": {
- "post": {
- "tags": ["inventory > region"],
- "summary": "Delete",
- "operationId" : "",
- "description": "### Description \nDeletes a specific Region. You must specify the `region_id` of the Region to delete.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |region_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"region_id" : {"type": "string","title": "REGION_ID" } }
- },
- "examples":{"Default Example":{"value": "{\n \"region_id\": \"region-e41deed3c939\"\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/inventory/region/get": {
+ },"/inventory/cloud-service/update": {
"post": {
- "tags": ["inventory > region"],
- "summary": "Get",
+ "tags": ["inventory > cloud-service"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nGets a specific Region. Prints detailed information about the Region, including `name`, `region_code`, and a location coordinate.",
+ "description": "### Description \nUpdates a specific CloudService. You can make changes in CloudService settings, except for the classification system of CloudService and the information about the `resource` attribute value.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |region_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n |name||string||\n |account||string||\n |instance_type||string||\n |instance_size||float||\n |ip_addresses||array||\n |data||Struct||\n |metadata||Struct||\n |reference||CloudServiceReference||\n |tags||Struct||\n |region_code||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"region_id" : {"type": "string","title": "REGION_ID" } }
+ "properties": {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"name" : {"type": "string","title": "NAME" },"account" : {"type": "string","title": "ACCOUNT" },"instance_type" : {"type": "string","title": "INSTANCE_TYPE" },"instance_size" : {"type": "float","title": "INSTANCE_SIZE" },"ip_addresses" : {"items": {}, "type": "array","title": "IP_ADDRESSES" },"data" : {"type": "object","title": "DATA" },"metadata" : {"type": "object","title": "METADATA" },"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE" },"tags" : {"type": "object","title": "TAGS" },"region_code" : {"type": "string","title": "REGION_CODE" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"region_id\": \"region-e41deed3c939\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test2\",\n \"ip_addresses\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"tags\": {\n \"description\": \"spaceone\"\n },\n \"region_code\": \"ap-northeast-2\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2570,60 +2601,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RegionInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RegionInfo"},"Default Example":{
- "value": "{\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServiceInfo"},"Default Example":{
+ "value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/region/list": {
+ },"/inventory/cloud-service/delete": {
"post": {
- "tags": ["inventory > region"],
- "summary": "List",
+ "tags": ["inventory > cloud-service"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \nGets a list of all Regions. You can use a query to get a filtered list of Regions.",
+ "description": "### Description \nDeletes a specific CloudService. You must specify the `cloud_service_id` of the CloudService to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |region_id||string||\n |name||string||\n |region_key||string||\n |region_code||string||\n |provider||string||\n |workspace_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"region_id" : {"type": "string","title": "REGION_ID" },"name" : {"type": "string","title": "NAME" },"region_key" : {"type": "string","title": "REGION_KEY" },"region_code" : {"type": "string","title": "REGION_CODE" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" } }
+ "properties": {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {\n \"filter\": [\n {\n \"key\": \"name\",\n \"value\": \"Asia Pacific\",\n \"operator\": \"contain\"\n }\n ]\n }\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cloud_service_id\": \"cloud-svc-fea2b0d32141\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/RegionsInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/RegionsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"region_id\": \"region-e41deed3c939\",\n \"name\": \"Asia Pacific (Mumbai)\",\n \"region_key\": \"aws.ap-south-1\",\n \"region_code\": \"ap-south-1\",\n \"provider\": \"aws\",\n \"tags\": {\n \"continent\": \"asia_pacific\",\n \"longitude\": \"73.013805\",\n \"latitude\": \"19.147428\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2021-11-18T13:07:31.382Z\",\n \"updated_at\": \"2022-06-17T00:07:35.469Z\"\n },\n {\n \"region_id\": \"region-f803eb00b567\",\n \"name\": \"Asia Pacific (Seoul)\",\n \"region_key\": \"aws.ap-northeast-2\",\n \"region_code\": \"ap-northeast-2\",\n \"provider\": \"aws\",\n \"tags\": {\n \"latitude\": \"6.34545\",\n \"continent\": \"asia_pacific\",\n \"longitude\": \"5.6433213\"\n },\n \"domain_id\": \"domain-x1b3c34v432\",\n \"workspace_id\": \"workspace-123456789012\",\n \"created_at\": \"2022-03-21T09:08:31.961Z\",\n \"updated_at\": \"2022-06-17T00:07:35.749Z\"\n }\n ],\n \"total_count\": 2\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/region/stat": {
+ },"/inventory/cloud-service/get": {
"post": {
- "tags": ["inventory > region"],
- "summary": "Stat",
+ "tags": ["inventory > cloud-service"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific CloudService. Prints detailed information about the CloudService, including its state, classification information, and attribute values.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |cloud_service_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"cloud_service_id\": \"cloud-svc-fea2b0d32141\"\n}"},"Schema":{}
}
}
},"required": true
@@ -2632,50 +2655,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/CloudServiceInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/CloudServiceInfo"},"Default Example":{
+ "value": "{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job/delete": {
- "post": {
- "tags": ["inventory > job"],
- "summary": "Delete",
- "operationId" : "",
- "description": "### Description \nDeletes a specific Job. You must specify the `job_id` of the Job to delete.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
- },
- "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/inventory/job/get": {
+ },"/inventory/cloud-service/list": {
"post": {
- "tags": ["inventory > job"],
- "summary": "Get",
+ "tags": ["inventory > cloud-service"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nGets a specific Job. Prints detailed information about the Job, including its state, total tasks, and collector info.",
+ "description": "### Description \nGets a list of all CloudServices. You can use a query to get a filtered list of CloudServices.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |job_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |cloud_service_id||string||\n |name||string||\n |state||string||\n |ip_address||string||\n |account||string||\n |instance_type||string||\n |cloud_service_type||string||\n |cloud_service_group||string||\n |provider||string||\n |region_code||string||\n |workspace_id||string||\n |project_id||string||\n |project_group_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"job_id" : {"type": "string","title": "JOB_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"ip_address" : {"type": "string","title": "IP_ADDRESS" },"account" : {"type": "string","title": "ACCOUNT" },"instance_type" : {"type": "string","title": "INSTANCE_TYPE" },"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE" },"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP" },"provider" : {"type": "string","title": "PROVIDER" },"region_code" : {"type": "string","title": "REGION_CODE" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"job_id\": \"job-123456789012\",\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {\n \"filter\": [\n {\n \"key\": \"cloud_service_type\",\n \"value\": \"Key\",\n \"operator\": \"eq\"\n }\n ]\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -2684,29 +2686,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobInfo"},
+ "schema": {"$ref": "#/components/schemas/CloudServicesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobInfo"},"Default Example":{
- "value": "{\n \"job_id\": \"job-123456789012\",\n \"status\": \"ERROR\",\n \"filter\": {},\n \"total_tasks\": 2,\n \"collector_info\": {\n \"collector_id\": \"collector-123456789012\",\n \"name\": \"Jenkins Collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-jenkins-inven-collector\",\n \"version\": \"0.1.1\"\n },\n \"provider\": \"jenkins\",\n \"capability\": {},\n \"is_public\": true\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T10:00:01.389Z\",\n \"updated_at\": \"2022-01-01T10:00:01.389Z\",\n \"finished_at\": \"2022-01-01T10:02:11.270Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/CloudServicesInfo"},"Default Example":{
+ "value": "{\n \"results\": [{\n \"cloud_service_id\": \"cloud-svc-c00f38a173e1\",\n \"name\": \"cloud_service_test2\",\n \"state\": \"ACTIVE\",\n \"account\": \"251340636361\",\n \"cloud_service_type\": \"Key\",\n \"cloud_service_group\": \"KMS\",\n \"provider\": \"aws\",\n \"data\": {\n \"alias_arn\": null,\n \"origin\": \"AWS_KMS\",\n \"cloudwatch\": {\n \"region_name\": \"ap-northeast-1\",\n \"namespace\": \"AWS/KMS\",\n \"dimensions\": [\n {\n \"Value\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"Name\": \"KeyId\"\n }\n ]\n },\n \"aws_account_id\": \"251340636361\",\n \"creation_date\": \"2020-07-09T09:39:03.097000+0000\",\n \"encryption_algorithms\": [\n \"SYMMETRIC_DEFAULT\"\n ],\n \"key_usage\": \"ENCRYPT_DECRYPT\",\n \"key_id\": \"0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_type_path\": \"defaultKeys\",\n \"key_rotated\": false,\n \"description\": \"Default master key that protects my Secrets Manager data when no other key is defined\",\n \"key_state\": \"Enabled\",\n \"customer_master_key_spec\": \"SYMMETRIC_DEFAULT\",\n \"enabled\": true,\n \"arn\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"key_manager\": \"AWS\"\n },\n \"metadata\": {\n \"manual\": {}\n },\n \"reference\": {\n \"resource_id\": \"arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx\",\n \"external_link\": \"https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/\"\n },\n \"tags\": {\n \"description\": \"spaceone\"\n },\n \"collection_info\": {\n \"service_account_id\": \"sa-abcd1234\",\n \"secret_id\": \"secret-abcd1234\",\n \"collector_id\": \"collector-abcd1234\",\n \"last_collected_at\": \"2022-06-22T06:38:48.989Z\"\n },\n \"ip_addresses\": [\n \"1.1.1.1\",\n \"2.2.2.2\"\n ],\n \"region_code\": \"ap-northeast-1\",\n \"workspace_id\": \"workspace-58010aa2e451\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-22T06:38:48.989Z\",\n \"updated_at\": \"2022-06-22T06:38:48.989Z\",\n \"launched_at\": \"2020-08-03T15:00:54.000Z\"\n }],\n \"total_count\": 1\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job/list": {
+ },"/inventory/cloud-service/export": {
"post": {
- "tags": ["inventory > job"],
- "summary": "List",
+ "tags": ["inventory > cloud-service"],
+ "summary": "Export",
"operationId" : "",
- "description": "### Description \nGets a list of all Jobs. You can use a query to get a filtered list of Jobs.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |job_id||string||\n |status|CANCELED, IN_PROGRESS, SUCCESS, FAILURE, TIMEOUT |string||\n |workspace_id||string||\n |collector_id||string||\n |plugin_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |options||array|True|\n |file_format|EXCEL, CSV |string||\n |file_name||string||\n |timezone||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"job_id" : {"type": "string","title": "JOB_ID" },"status" : {"type": "string","title": "STATUS" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"collector_id" : {"type": "string","title": "COLLECTOR_ID" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ "properties": {"options" : {"items": {"$ref": "#/components/schemas/ExportOption"}, "type": "array","title": "OPTIONS" },"file_format" : {"type": "string","title": "FILE_FORMAT" },"file_name" : {"type": "string","title": "FILE_NAME" },"timezone" : {"type": "string","title": "TIMEZONE" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -2715,18 +2717,16 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/JobsInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/JobsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"job_id\": \"job-3b124006c2d2\",\n \"status\": \"SUCCESS\",\n \"filter\": {},\n \"total_tasks\": 2,\n \"collector_info\": {\n \"collector_id\": \"collector-accd02663b3d\",\n \"name\": \"openstack-collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-openstack-inven-collector\",\n \"version\": \"0.4.2.20220616.134758\"\n },\n \"provider\": \"openstack\",\n \"capability\": {\n \"supported_schema\": [\n \"openstack_credentials\"\n ]\n },\n \"is_public\": true\n },\n \"resource_group\": \"DOMAIN\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:01.225Z\",\n \"updated_at\": \"2022-06-17T08:00:01.225Z\",\n \"finished_at\": \"2022-06-17T08:00:15.197Z\"\n },\n {\n \"job_id\": \"job-587a3d3b4db3\",\n \"status\": \"SUCCESS\",\n \"filter\": {},\n \"total_tasks\": 3,\n \"collector_info\": {\n \"collector_id\": \"collector-2c0847644f39\",\n \"name\": \"AWS stat-kwon Collector\",\n \"state\": \"ENABLED\",\n \"plugin_info\": {\n \"plugin_id\": \"plugin-30d21ef75a5d\",\n \"version\": \"1.13.13.20220610.143142\"\n },\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\"\n ]\n },\n \"is_public\": true\n },\n \"resource_group\": \"DOMAIN\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-17T08:00:00.407Z\",\n \"updated_at\": \"2022-06-17T08:00:00.407Z\",\n \"finished_at\": \"2022-06-17T08:07:32.023Z\"\n }\n ],\n \"total_count\": 2\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job/analyze": {
+ },"/inventory/cloud-service/analyze": {
"post": {
- "tags": ["inventory > job"],
+ "tags": ["inventory > cloud-service"],
"summary": "Analyze",
"operationId" : "",
"description": "### Description \n",
@@ -2753,9 +2753,9 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/inventory/job/stat": {
+ },"/inventory/cloud-service/stat": {
"post": {
- "tags": ["inventory > job"],
+ "tags": ["inventory > cloud-service"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -2786,68 +2786,48 @@
},
"components":{
"schemas": {
- "ChangeHistoryInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RecordInfo"},
- "type": "array","$ref": "#/components/schemas/RecordInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "CreateNamespaceRequest": {
+ "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"name" : {"type": "string","title": "NAME"},"category" : {"type": "string","title": "CATEGORY"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"group" : {"type": "string","title": "GROUP"},"icon" : {"type": "string","title": "ICON"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "ChangeHistoryInfo"
+ "required": ["name","category","resource_type","resource_group"],
+ "title": "CreateNamespaceRequest"
}
- , "ChangeHistoryQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"action" : {"type": "string","title": "ACTION"},"user_id" : {"type": "string","title": "USER_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"updated_by" : {"type": "string","title": "UPDATED_BY"}},
+ , "NamespaceInfo": {
+ "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"name" : {"type": "string","title": "NAME"},"category" : {"type": "string","title": "CATEGORY"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"group" : {"type": "string","title": "GROUP"},"icon" : {"type": "string","title": "ICON"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["cloud_service_id"],
- "title": "ChangeHistoryQuery"
+ "required": ["namespace_id","name","category","resource_type","group","icon","tags","is_managed","resource_group","domain_id","workspace_id","created_at","updated_at"],
+ "title": "NamespaceInfo"
}
- , "ChangeHistoryStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"}},
+ , "NamespaceQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"category" : {"type": "string","title": "CATEGORY"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"group" : {"type": "string","title": "GROUP"},"is_managed" : {"type": "string","title": "IS_MANAGED"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["query","cloud_service_id"],
- "title": "ChangeHistoryStatQuery"
+ "required": [],
+ "title": "NamespaceQuery"
}
- , "RecordInfo": {
- "properties" : {"record_id" : {"type": "string","title": "RECORD_ID"},"action" : {"type": "string","title": "ACTION"},"diff" : {"type": "array","title": "DIFF"},"diff_count" : {"type": "integer","title": "DIFF_COUNT"},"updated_by" : {"type": "string","title": "UPDATED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "NamespaceRequest": {
+ "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"}},
"type": "object",
- "required": ["record_id","action","diff","diff_count","updated_by","domain_id","cloud_service_id","collector_id","job_id","user_id","created_at"],
- "title": "RecordInfo"
+ "required": ["namespace_id"],
+ "title": "NamespaceRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "NamespaceStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
+ "required": ["query"],
+ "title": "NamespaceStatQuery"
}
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ , "NamespacesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/NamespaceInfo"},
+ "type": "array","$ref": "#/components/schemas/NamespaceInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
+ "required": ["results","total_count"],
+ "title": "NamespacesInfo"
}
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ , "UpdateNamespaceRequest": {
+ "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"name" : {"type": "string","title": "NAME"},"icon" : {"type": "string","title": "ICON"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
+ "required": ["namespace_id"],
+ "title": "UpdateNamespaceRequest"
}
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
@@ -3018,6 +2998,98 @@
"required": ["path","filter"],
"title": "Unwind"
}
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
+ }
+ , "CloudServiceReportInfo": {
+ "properties" : {"report_id" : {"type": "string","title": "REPORT_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
+ "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"timezone" : {"type": "string","title": "TIMEZONE"},"language" : {"type": "string","title": "LANGUAGE"},"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE"},"target" : {"type": "object","title": "TARGET"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_sent_at" : {"type": "string","title": "LAST_SENT_AT"}},
+ "type": "object",
+ "required": ["report_id","name","options","file_format","timezone","language","schedule","target","tags","resource_group","domain_id","workspace_id","created_at","last_sent_at"],
+ "title": "CloudServiceReportInfo"
+ }
+ , "CloudServiceReportQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"report_id" : {"type": "string","title": "REPORT_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "CloudServiceReportQuery"
+ }
+ , "CloudServiceReportRequest": {
+ "properties" : {"report_id" : {"type": "string","title": "REPORT_ID"}},
+ "type": "object",
+ "required": ["report_id"],
+ "title": "CloudServiceReportRequest"
+ }
+ , "CloudServiceReportStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "CloudServiceReportStatQuery"
+ }
+ , "CloudServiceReportsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
+ "type": "array","$ref": "#/components/schemas/CloudServiceReportInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "CloudServiceReportsInfo"
+ }
+ , "CreateCloudServiceReportRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
+ "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"timezone" : {"type": "string","title": "TIMEZONE"},"language" : {"type": "string","title": "LANGUAGE"},"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE"},"target" : {"type": "object","title": "TARGET"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ "type": "object",
+ "required": ["name","options","schedule","target","resource_group"],
+ "title": "CreateCloudServiceReportRequest"
+ }
+ , "ReportSchedule": {
+ "properties" : {"state" : {"type": "string","title": "STATE"},"hours" : {"items": {"type": "integer"},
+ "type": "array","title": "HOURS"},"days_of_week" : {"items": {"type": "string"},
+ "type": "array","title": "DAYS_OF_WEEK"}},
+ "type": "object",
+ "required": ["state","hours","days_of_week"],
+ "title": "ReportSchedule"
+ }
+ , "UpdateCloudServiceReportRequest": {
+ "properties" : {"report_id" : {"type": "string","title": "REPORT_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
+ "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"timezone" : {"type": "string","title": "TIMEZONE"},"language" : {"type": "string","title": "LANGUAGE"},"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE"},"target" : {"type": "object","title": "TARGET"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["report_id"],
+ "title": "UpdateCloudServiceReportRequest"
+ }
, "CloudServiceTypeInfo": {
"properties" : {"cloud_service_type_id" : {"type": "string","title": "CLOUD_SERVICE_TYPE_ID"},"name" : {"type": "string","title": "NAME"},"provider" : {"type": "string","title": "PROVIDER"},"group" : {"type": "string","title": "GROUP"},"cloud_service_type_key" : {"type": "string","title": "CLOUD_SERVICE_TYPE_KEY"},"service_code" : {"type": "string","title": "SERVICE_CODE"},"is_primary" : {"type": "boolean","title": "IS_PRIMARY"},"is_major" : {"type": "boolean","title": "IS_MAJOR"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"metadata" : {"type": "object","title": "METADATA"},"tags" : {"type": "object","title": "TAGS"},"labels" : {"type": "array","title": "LABELS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
@@ -3061,164 +3133,253 @@
"required": ["cloud_service_type_id"],
"title": "UpdateCloudServiceTypeRequest"
}
- , "CreateNamespaceRequest": {
- "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"name" : {"type": "string","title": "NAME"},"category" : {"type": "string","title": "CATEGORY"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"group" : {"type": "string","title": "GROUP"},"icon" : {"type": "string","title": "ICON"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
- "type": "object",
- "required": ["name","category","resource_type","resource_group"],
- "title": "CreateNamespaceRequest"
- }
- , "NamespaceInfo": {
- "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"name" : {"type": "string","title": "NAME"},"category" : {"type": "string","title": "CATEGORY"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"group" : {"type": "string","title": "GROUP"},"icon" : {"type": "string","title": "ICON"},"tags" : {"type": "object","title": "TAGS"},"is_managed" : {"type": "boolean","title": "IS_MANAGED"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "MetricDataAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"metric_id" : {"type": "string","title": "METRIC_ID"}},
"type": "object",
- "required": ["namespace_id","name","category","resource_type","group","icon","tags","is_managed","resource_group","domain_id","workspace_id","created_at","updated_at"],
- "title": "NamespaceInfo"
+ "required": ["query","metric_id"],
+ "title": "MetricDataAnalyzeQuery"
}
- , "NamespaceQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"category" : {"type": "string","title": "CATEGORY"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"group" : {"type": "string","title": "GROUP"},"is_managed" : {"type": "string","title": "IS_MANAGED"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "MetricDataInfo": {
+ "properties" : {"metric_id" : {"type": "string","title": "METRIC_ID"},"value" : {"type": "float","title": "VALUE"},"unit" : {"type": "string","title": "UNIT"},"labels" : {"type": "object","title": "LABELS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"created_year" : {"type": "string","title": "CREATED_YEAR"},"created_month" : {"type": "string","title": "CREATED_MONTH"},"created_date" : {"type": "string","title": "CREATED_DATE"}},
"type": "object",
- "required": [],
- "title": "NamespaceQuery"
+ "required": ["metric_id","value","unit","labels","domain_id","workspace_id","project_id","service_account_id","namespace_id","created_year","created_month","created_date"],
+ "title": "MetricDataInfo"
}
- , "NamespaceRequest": {
- "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"}},
+ , "MetricDataQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"metric_id" : {"type": "string","title": "METRIC_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["namespace_id"],
- "title": "NamespaceRequest"
+ "required": ["metric_id"],
+ "title": "MetricDataQuery"
}
- , "NamespaceStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "MetricDataStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"metric_id" : {"type": "string","title": "METRIC_ID"}},
"type": "object",
"required": ["query"],
- "title": "NamespaceStatQuery"
+ "title": "MetricDataStatQuery"
}
- , "NamespacesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/NamespaceInfo"},
- "type": "array","$ref": "#/components/schemas/NamespaceInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "MetricDatasInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/MetricDataInfo"},
+ "type": "array","$ref": "#/components/schemas/MetricDataInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "NamespacesInfo"
+ "title": "MetricDatasInfo"
}
- , "UpdateNamespaceRequest": {
- "properties" : {"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"name" : {"type": "string","title": "NAME"},"icon" : {"type": "string","title": "ICON"},"tags" : {"type": "object","title": "TAGS"}},
+ , "CloudServiceStatInfo": {
+ "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"data" : {"type": "object","title": "DATA"},"unit" : {"type": "object","title": "UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"region_code" : {"type": "string","title": "REGION_CODE"},"account" : {"type": "string","title": "ACCOUNT"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_date" : {"type": "string","title": "CREATED_DATE"}},
"type": "object",
- "required": ["namespace_id"],
- "title": "UpdateNamespaceRequest"
+ "required": ["query_set_id","data","unit","provider","cloud_service_group","cloud_service_type","region_code","account","additional_info","domain_id","workspace_id","project_id","created_date"],
+ "title": "CloudServiceStatInfo"
}
- , "CloudServiceQuerySetInfo": {
- "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS"},"query_type" : {"type": "string","title": "QUERY_TYPE"},"unit" : {"type": "object","title": "UNIT"},"data_keys" : {"items": {"type": "string"},
- "type": "array","title": "DATA_KEYS"},"additional_info_keys" : {"items": {"type": "string"},
- "type": "array","title": "ADDITIONAL_INFO_KEYS"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "CloudServiceStatsAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"}},
"type": "object",
- "required": ["query_set_id","name","state","query_options","query_type","unit","data_keys","additional_info_keys","provider","cloud_service_group","cloud_service_type","tags","resource_group","domain_id","workspace_id","created_at","updated_at"],
- "title": "CloudServiceQuerySetInfo"
+ "required": ["query","query_set_id"],
+ "title": "CloudServiceStatsAnalyzeQuery"
}
- , "CloudServiceQuerySetQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"query_type" : {"type": "string","title": "QUERY_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "CloudServiceStatsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceStatInfo"},
+ "type": "array","$ref": "#/components/schemas/CloudServiceStatInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": [],
- "title": "CloudServiceQuerySetQuery"
+ "required": ["results","total_count"],
+ "title": "CloudServiceStatsInfo"
}
- , "CloudServiceQuerySetRequest": {
- "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"}},
+ , "CloudServiceStatsQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"region_code" : {"type": "string","title": "REGION_CODE"},"account" : {"type": "string","title": "ACCOUNT"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
"required": ["query_set_id"],
- "title": "CloudServiceQuerySetRequest"
+ "title": "CloudServiceStatsQuery"
}
- , "CloudServiceQuerySetStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "CloudServiceStatsStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"}},
"type": "object",
"required": ["query"],
- "title": "CloudServiceQuerySetStatQuery"
+ "title": "CloudServiceStatsStatQuery"
}
- , "CloudServiceQuerySetsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
- "type": "array","$ref": "#/components/schemas/CloudServiceQuerySetInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "JobAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "CloudServiceQuerySetsInfo"
+ "required": ["query"],
+ "title": "JobAnalyzeQuery"
}
- , "CreateCloudServiceQuerySetRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS"},"unit" : {"type": "object","title": "UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "JobInfo": {
+ "properties" : {"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"total_tasks" : {"type": "integer","title": "TOTAL_TASKS"},"remained_tasks" : {"type": "integer","title": "REMAINED_TASKS"},"success_tasks" : {"type": "integer","title": "SUCCESS_TASKS"},"failure_tasks" : {"type": "integer","title": "FAILURE_TASKS"},"request_secret_id" : {"type": "string","title": "REQUEST_SECRET_ID"},"request_workspace_id" : {"type": "string","title": "REQUEST_WORKSPACE_ID"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
"type": "object",
- "required": ["name","query_options","provider","cloud_service_group","cloud_service_type","resource_group"],
- "title": "CreateCloudServiceQuerySetRequest"
+ "required": ["job_id","status","total_tasks","remained_tasks","success_tasks","failure_tasks","request_secret_id","request_workspace_id","resource_group","domain_id","workspace_id","collector_id","plugin_id","created_at","updated_at","finished_at"],
+ "title": "JobInfo"
}
- , "UpdateCloudServiceQuerySetRequest": {
- "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS"},"unit" : {"type": "object","title": "UNIT"},"tags" : {"type": "object","title": "TAGS"}},
+ , "JobRequest": {
+ "properties" : {"job_id" : {"type": "string","title": "JOB_ID"}},
"type": "object",
- "required": ["query_set_id"],
- "title": "UpdateCloudServiceQuerySetRequest"
+ "required": ["job_id"],
+ "title": "JobRequest"
}
- , "CloudServiceAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY"}},
+ , "JobStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "CloudServiceAnalyzeQuery"
- }
- , "CloudServiceExportRequest": {
- "properties" : {"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
- "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"file_name" : {"type": "string","title": "FILE_NAME"},"timezone" : {"type": "string","title": "TIMEZONE"}},
- "type": "object",
- "required": ["options"],
- "title": "CloudServiceExportRequest"
+ "title": "JobStatQuery"
}
- , "CloudServiceInfo": {
- "properties" : {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"ip_addresses" : {"items": {"type": "string"},
- "type": "array","title": "IP_ADDRESSES"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"instance_size" : {"type": "float","title": "INSTANCE_SIZE"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"provider" : {"type": "string","title": "PROVIDER"},"data" : {"type": "object","title": "DATA"},"metadata" : {"type": "object","title": "METADATA"},"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE"},"tags" : {"type": "object","title": "TAGS"},"tag_keys" : {"type": "object","title": "TAG_KEYS"},"collection_info" : {"$ref": "#/components/schemas/CollectionInfo","title": "COLLECTION_INFO"},"region_code" : {"type": "string","title": "REGION_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
+ , "JobsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobInfo"},
+ "type": "array","$ref": "#/components/schemas/JobInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["cloud_service_id","name","state","ip_addresses","account","instance_type","instance_size","cloud_service_type","cloud_service_group","provider","data","metadata","reference","tags","tag_keys","collection_info","region_code","domain_id","workspace_id","project_id","created_at","updated_at","deleted_at"],
- "title": "CloudServiceInfo"
+ "required": ["results","total_count"],
+ "title": "JobsInfo"
}
- , "CloudServiceQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"ip_address" : {"type": "string","title": "IP_ADDRESS"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
+ , "JobsQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
"type": "object",
"required": [],
- "title": "CloudServiceQuery"
+ "title": "JobsQuery"
}
- , "CloudServiceReference": {
- "properties" : {"resource_id" : {"type": "string","title": "RESOURCE_ID"},"external_link" : {"type": "string","title": "EXTERNAL_LINK"}},
+ , "ChangeHistoryInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RecordInfo"},
+ "type": "array","$ref": "#/components/schemas/RecordInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["resource_id","external_link"],
- "title": "CloudServiceReference"
+ "required": ["results","total_count"],
+ "title": "ChangeHistoryInfo"
}
- , "CloudServiceRequest": {
- "properties" : {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"}},
+ , "ChangeHistoryQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"action" : {"type": "string","title": "ACTION"},"user_id" : {"type": "string","title": "USER_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"updated_by" : {"type": "string","title": "UPDATED_BY"}},
"type": "object",
"required": ["cloud_service_id"],
- "title": "CloudServiceRequest"
+ "title": "ChangeHistoryQuery"
}
- , "CloudServiceStatQuery": {
+ , "ChangeHistoryStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"}},
+ "type": "object",
+ "required": ["query","cloud_service_id"],
+ "title": "ChangeHistoryStatQuery"
+ }
+ , "RecordInfo": {
+ "properties" : {"record_id" : {"type": "string","title": "RECORD_ID"},"action" : {"type": "string","title": "ACTION"},"diff" : {"type": "array","title": "DIFF"},"diff_count" : {"type": "integer","title": "DIFF_COUNT"},"updated_by" : {"type": "string","title": "UPDATED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ "type": "object",
+ "required": ["record_id","action","diff","diff_count","updated_by","domain_id","cloud_service_id","collector_id","job_id","user_id","created_at"],
+ "title": "RecordInfo"
+ }
+ , "ErrorInfo": {
+ "properties" : {"error_code" : {"type": "string","title": "ERROR_CODE"},"message" : {"type": "string","title": "MESSAGE"},"additional" : {"type": "object","title": "ADDITIONAL"}},
+ "type": "object",
+ "required": ["error_code","message","additional"],
+ "title": "ErrorInfo"
+ }
+ , "JobTaskInfo": {
+ "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"provider" : {"type": "string","title": "PROVIDER"},"created_count" : {"type": "integer","title": "CREATED_COUNT"},"updated_count" : {"type": "integer","title": "UPDATED_COUNT"},"failure_count" : {"type": "integer","title": "FAILURE_COUNT"},"deleted_count" : {"type": "integer","title": "DELETED_COUNT"},"disconnected_count" : {"type": "integer","title": "DISCONNECTED_COUNT"},"errors" : {"items": {"$ref": "#/components/schemas/ErrorInfo"},
+ "type": "array","$ref": "#/components/schemas/ErrorInfo","title": "ERRORS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"started_at" : {"type": "string","title": "STARTED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
+ "type": "object",
+ "required": ["job_task_id","status","provider","created_count","updated_count","failure_count","deleted_count","disconnected_count","errors","domain_id","workspace_id","project_id","service_account_id","job_id","secret_id","created_at","started_at","finished_at"],
+ "title": "JobTaskInfo"
+ }
+ , "JobTaskQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "JobTaskQuery"
+ }
+ , "JobTaskRequest": {
+ "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"}},
+ "type": "object",
+ "required": ["job_task_id"],
+ "title": "JobTaskRequest"
+ }
+ , "JobTaskStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "CloudServiceStatQuery"
+ "title": "JobTaskStatQuery"
}
- , "CloudServicesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceInfo"},
- "type": "array","$ref": "#/components/schemas/CloudServiceInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "JobTasksInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobTaskInfo"},
+ "type": "array","$ref": "#/components/schemas/JobTaskInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "CloudServicesInfo"
+ "title": "JobTasksInfo"
}
- , "CollectionInfo": {
- "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"last_collected_at" : {"type": "string","title": "LAST_COLLECTED_AT"}},
+ , "CreateRegionRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"region_code" : {"type": "string","title": "REGION_CODE"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["service_account_id","secret_id","collector_id","last_collected_at"],
- "title": "CollectionInfo"
+ "required": ["name","region_code"],
+ "title": "CreateRegionRequest"
}
- , "CreateServiceRequest": {
- "properties" : {"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"name" : {"type": "string","title": "NAME"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"instance_size" : {"type": "float","title": "INSTANCE_SIZE"},"ip_addresses" : {"items": {"type": "string"},
- "type": "array","title": "IP_ADDRESSES"},"data" : {"type": "object","title": "DATA"},"metadata" : {"type": "object","title": "METADATA"},"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE"},"tags" : {"type": "object","title": "TAGS"},"region_code" : {"type": "string","title": "REGION_CODE"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "RegionInfo": {
+ "properties" : {"region_id" : {"type": "string","title": "REGION_ID"},"name" : {"type": "string","title": "NAME"},"region_key" : {"type": "string","title": "REGION_KEY"},"region_code" : {"type": "string","title": "REGION_CODE"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["cloud_service_type","provider","cloud_service_group","data"],
- "title": "CreateServiceRequest"
+ "required": ["region_id","name","region_key","region_code","provider","tags","domain_id","workspace_id","created_at","updated_at"],
+ "title": "RegionInfo"
}
- , "UpdateCloudServiceRequest": {
- "properties" : {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"name" : {"type": "string","title": "NAME"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"instance_size" : {"type": "float","title": "INSTANCE_SIZE"},"ip_addresses" : {"items": {"type": "string"},
- "type": "array","title": "IP_ADDRESSES"},"data" : {"type": "object","title": "DATA"},"metadata" : {"type": "object","title": "METADATA"},"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE"},"tags" : {"type": "object","title": "TAGS"},"region_code" : {"type": "string","title": "REGION_CODE"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "RegionQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"region_id" : {"type": "string","title": "REGION_ID"},"name" : {"type": "string","title": "NAME"},"region_key" : {"type": "string","title": "REGION_KEY"},"region_code" : {"type": "string","title": "REGION_CODE"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["cloud_service_id"],
- "title": "UpdateCloudServiceRequest"
+ "required": [],
+ "title": "RegionQuery"
+ }
+ , "RegionRequest": {
+ "properties" : {"region_id" : {"type": "string","title": "REGION_ID"}},
+ "type": "object",
+ "required": ["region_id"],
+ "title": "RegionRequest"
+ }
+ , "RegionStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "RegionStatQuery"
+ }
+ , "RegionsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RegionInfo"},
+ "type": "array","$ref": "#/components/schemas/RegionInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "RegionsInfo"
+ }
+ , "UpdateRegionRequest": {
+ "properties" : {"region_id" : {"type": "string","title": "REGION_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["region_id"],
+ "title": "UpdateRegionRequest"
+ }
+ , "CreateNoteRequest": {
+ "properties" : {"record_id" : {"type": "string","title": "RECORD_ID"},"note" : {"type": "string","title": "NOTE"}},
+ "type": "object",
+ "required": ["record_id","note"],
+ "title": "CreateNoteRequest"
+ }
+ , "NoteInfo": {
+ "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"record_id" : {"type": "string","title": "RECORD_ID"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"note" : {"type": "string","title": "NOTE"},"created_by" : {"type": "string","title": "CREATED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ "type": "object",
+ "required": ["note_id","record_id","cloud_service_id","note","created_by","domain_id","workspace_id","project_id","created_at"],
+ "title": "NoteInfo"
+ }
+ , "NoteQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"note_id" : {"type": "string","title": "NOTE_ID"},"record_id" : {"type": "string","title": "RECORD_ID"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"created_by" : {"type": "string","title": "CREATED_BY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "NoteQuery"
+ }
+ , "NoteRequest": {
+ "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"}},
+ "type": "object",
+ "required": ["note_id"],
+ "title": "NoteRequest"
+ }
+ , "NoteStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "NoteStatQuery"
+ }
+ , "NotesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/NoteInfo"},
+ "type": "array","$ref": "#/components/schemas/NoteInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "NotesInfo"
+ }
+ , "UpdateNoteRequest": {
+ "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"note" : {"type": "string","title": "NOTE"}},
+ "type": "object",
+ "required": ["note_id"],
+ "title": "UpdateNoteRequest"
}
, "CreateMetricExampleRequest": {
"properties" : {"metric_id" : {"type": "string","title": "METRIC_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"type": "object","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
@@ -3263,37 +3424,6 @@
"required": ["example_id"],
"title": "UpdateMetricExampleRequest"
}
- , "CloudServiceStatInfo": {
- "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"data" : {"type": "object","title": "DATA"},"unit" : {"type": "object","title": "UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"region_code" : {"type": "string","title": "REGION_CODE"},"account" : {"type": "string","title": "ACCOUNT"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_date" : {"type": "string","title": "CREATED_DATE"}},
- "type": "object",
- "required": ["query_set_id","data","unit","provider","cloud_service_group","cloud_service_type","region_code","account","additional_info","domain_id","workspace_id","project_id","created_date"],
- "title": "CloudServiceStatInfo"
- }
- , "CloudServiceStatsAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"}},
- "type": "object",
- "required": ["query","query_set_id"],
- "title": "CloudServiceStatsAnalyzeQuery"
- }
- , "CloudServiceStatsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceStatInfo"},
- "type": "array","$ref": "#/components/schemas/CloudServiceStatInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "CloudServiceStatsInfo"
- }
- , "CloudServiceStatsQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"region_code" : {"type": "string","title": "REGION_CODE"},"account" : {"type": "string","title": "ACCOUNT"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
- "type": "object",
- "required": ["query_set_id"],
- "title": "CloudServiceStatsQuery"
- }
- , "CloudServiceStatsStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"}},
- "type": "object",
- "required": ["query"],
- "title": "CloudServiceStatsStatQuery"
- }
, "CreateMetricRequest": {
"properties" : {"metric_id" : {"type": "string","title": "METRIC_ID"},"name" : {"type": "string","title": "NAME"},"metric_type" : {"type": "string","title": "METRIC_TYPE"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS"},"date_field" : {"type": "string","title": "DATE_FIELD"},"unit" : {"type": "string","title": "UNIT"},"tags" : {"type": "object","title": "TAGS"},"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
@@ -3344,203 +3474,50 @@
"required": ["metric_id"],
"title": "UpdateMetricRequest"
}
- , "CollectRequest": {
- "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
- "type": "object",
- "required": ["collector_id"],
- "title": "CollectRequest"
- }
- , "CollectorInfo": {
- "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"name" : {"type": "string","title": "NAME"},"provider" : {"type": "string","title": "PROVIDER"},"capability" : {"type": "object","title": "CAPABILITY"},"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_collected_at" : {"type": "string","title": "LAST_COLLECTED_AT"}},
- "type": "object",
- "required": ["collector_id","name","provider","capability","secret_filter","plugin_info","schedule","tags","resource_group","domain_id","workspace_id","created_at","last_collected_at"],
- "title": "CollectorInfo"
- }
- , "CollectorQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"name" : {"type": "string","title": "NAME"},"secret_filter_state" : {"type": "string","title": "SECRET_FILTER_STATE"},"schedule_state" : {"type": "string","title": "SCHEDULE_STATE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
- "type": "object",
- "required": ["query","collector_id","name","secret_filter_state","schedule_state","workspace_id","plugin_id"],
- "title": "CollectorQuery"
- }
- , "CollectorRequest": {
- "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"}},
- "type": "object",
- "required": ["collector_id"],
- "title": "CollectorRequest"
- }
- , "CollectorStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
- "type": "object",
- "required": ["query"],
- "title": "CollectorStatQuery"
- }
- , "CollectorsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CollectorInfo"},
- "type": "array","$ref": "#/components/schemas/CollectorInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "CollectorsInfo"
- }
- , "CreateCollectorRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"provider" : {"type": "string","title": "PROVIDER"},"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
- "type": "object",
- "required": ["name","plugin_info","resource_group"],
- "title": "CreateCollectorRequest"
- }
- , "PluginInfo": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"metadata" : {"type": "object","title": "METADATA"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
- "type": "object",
- "required": ["plugin_id","version","options","metadata","upgrade_mode"],
- "title": "PluginInfo"
- }
- , "Scheduled": {
- "properties" : {"state" : {"type": "string","title": "STATE"},"hours" : {"items": {"type": "integer"},
- "type": "array","title": "HOURS"}},
- "type": "object",
- "required": ["state","hours"],
- "title": "Scheduled"
- }
- , "SecretFilter": {
- "properties" : {"state" : {"type": "string","title": "STATE"},"secrets" : {"items": {"type": "string"},
- "type": "array","title": "SECRETS"},"service_accounts" : {"items": {"type": "string"},
- "type": "array","title": "SERVICE_ACCOUNTS"},"schemas" : {"items": {"type": "string"},
- "type": "array","title": "SCHEMAS"},"exclude_secrets" : {"items": {"type": "string"},
- "type": "array","title": "EXCLUDE_SECRETS"},"exclude_service_accounts" : {"items": {"type": "string"},
- "type": "array","title": "EXCLUDE_SERVICE_ACCOUNTS"},"exclude_schemas" : {"items": {"type": "string"},
- "type": "array","title": "EXCLUDE_SCHEMAS"}},
- "type": "object",
- "required": ["state","secrets","service_accounts","schemas","exclude_secrets","exclude_service_accounts","exclude_schemas"],
- "title": "SecretFilter"
- }
- , "UpdateCollectorRequest": {
- "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"name" : {"type": "string","title": "NAME"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["collector_id"],
- "title": "UpdateCollectorRequest"
- }
- , "UpdatePluginRequest": {
- "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
- "type": "object",
- "required": ["collector_id"],
- "title": "UpdatePluginRequest"
- }
- , "VerifyPluginRequest": {
- "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
- "type": "object",
- "required": ["collector_id"],
- "title": "VerifyPluginRequest"
- }
- , "CreateNoteRequest": {
- "properties" : {"record_id" : {"type": "string","title": "RECORD_ID"},"note" : {"type": "string","title": "NOTE"}},
- "type": "object",
- "required": ["record_id","note"],
- "title": "CreateNoteRequest"
- }
- , "NoteInfo": {
- "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"record_id" : {"type": "string","title": "RECORD_ID"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"note" : {"type": "string","title": "NOTE"},"created_by" : {"type": "string","title": "CREATED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
- "type": "object",
- "required": ["note_id","record_id","cloud_service_id","note","created_by","domain_id","workspace_id","project_id","created_at"],
- "title": "NoteInfo"
- }
- , "NoteQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"note_id" : {"type": "string","title": "NOTE_ID"},"record_id" : {"type": "string","title": "RECORD_ID"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"created_by" : {"type": "string","title": "CREATED_BY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
- "type": "object",
- "required": [],
- "title": "NoteQuery"
- }
- , "NoteRequest": {
- "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"}},
- "type": "object",
- "required": ["note_id"],
- "title": "NoteRequest"
- }
- , "NoteStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
- "type": "object",
- "required": ["query"],
- "title": "NoteStatQuery"
- }
- , "NotesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/NoteInfo"},
- "type": "array","$ref": "#/components/schemas/NoteInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "NotesInfo"
- }
- , "UpdateNoteRequest": {
- "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"note" : {"type": "string","title": "NOTE"}},
- "type": "object",
- "required": ["note_id"],
- "title": "UpdateNoteRequest"
- }
- , "ErrorInfo": {
- "properties" : {"error_code" : {"type": "string","title": "ERROR_CODE"},"message" : {"type": "string","title": "MESSAGE"},"additional" : {"type": "object","title": "ADDITIONAL"}},
- "type": "object",
- "required": ["error_code","message","additional"],
- "title": "ErrorInfo"
- }
- , "JobTaskInfo": {
- "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"provider" : {"type": "string","title": "PROVIDER"},"created_count" : {"type": "integer","title": "CREATED_COUNT"},"updated_count" : {"type": "integer","title": "UPDATED_COUNT"},"failure_count" : {"type": "integer","title": "FAILURE_COUNT"},"deleted_count" : {"type": "integer","title": "DELETED_COUNT"},"disconnected_count" : {"type": "integer","title": "DISCONNECTED_COUNT"},"errors" : {"items": {"$ref": "#/components/schemas/ErrorInfo"},
- "type": "array","$ref": "#/components/schemas/ErrorInfo","title": "ERRORS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"started_at" : {"type": "string","title": "STARTED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
+ , "CloudServiceQuerySetInfo": {
+ "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS"},"query_type" : {"type": "string","title": "QUERY_TYPE"},"unit" : {"type": "object","title": "UNIT"},"data_keys" : {"items": {"type": "string"},
+ "type": "array","title": "DATA_KEYS"},"additional_info_keys" : {"items": {"type": "string"},
+ "type": "array","title": "ADDITIONAL_INFO_KEYS"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["job_task_id","status","provider","created_count","updated_count","failure_count","deleted_count","disconnected_count","errors","domain_id","workspace_id","project_id","service_account_id","job_id","secret_id","created_at","started_at","finished_at"],
- "title": "JobTaskInfo"
+ "required": ["query_set_id","name","state","query_options","query_type","unit","data_keys","additional_info_keys","provider","cloud_service_group","cloud_service_type","tags","resource_group","domain_id","workspace_id","created_at","updated_at"],
+ "title": "CloudServiceQuerySetInfo"
}
- , "JobTaskQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_task_id" : {"type": "string","title": "JOB_TASK_ID"},"status" : {"type": "string","title": "STATUS"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"job_id" : {"type": "string","title": "JOB_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
+ , "CloudServiceQuerySetQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"query_type" : {"type": "string","title": "QUERY_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
"required": [],
- "title": "JobTaskQuery"
+ "title": "CloudServiceQuerySetQuery"
}
- , "JobTaskRequest": {
- "properties" : {"job_task_id" : {"type": "string","title": "JOB_TASK_ID"}},
+ , "CloudServiceQuerySetRequest": {
+ "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"}},
"type": "object",
- "required": ["job_task_id"],
- "title": "JobTaskRequest"
+ "required": ["query_set_id"],
+ "title": "CloudServiceQuerySetRequest"
}
- , "JobTaskStatQuery": {
+ , "CloudServiceQuerySetStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "JobTaskStatQuery"
+ "title": "CloudServiceQuerySetStatQuery"
}
- , "JobTasksInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobTaskInfo"},
- "type": "array","$ref": "#/components/schemas/JobTaskInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "CloudServiceQuerySetsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceQuerySetInfo"},
+ "type": "array","$ref": "#/components/schemas/CloudServiceQuerySetInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "JobTasksInfo"
- }
- , "MetricDataAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/TimeSeriesAnalyzeQuery","title": "QUERY"},"metric_id" : {"type": "string","title": "METRIC_ID"}},
- "type": "object",
- "required": ["query","metric_id"],
- "title": "MetricDataAnalyzeQuery"
- }
- , "MetricDataInfo": {
- "properties" : {"metric_id" : {"type": "string","title": "METRIC_ID"},"value" : {"type": "float","title": "VALUE"},"unit" : {"type": "string","title": "UNIT"},"labels" : {"type": "object","title": "LABELS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"namespace_id" : {"type": "string","title": "NAMESPACE_ID"},"created_year" : {"type": "string","title": "CREATED_YEAR"},"created_month" : {"type": "string","title": "CREATED_MONTH"},"created_date" : {"type": "string","title": "CREATED_DATE"}},
- "type": "object",
- "required": ["metric_id","value","unit","labels","domain_id","workspace_id","project_id","service_account_id","namespace_id","created_year","created_month","created_date"],
- "title": "MetricDataInfo"
- }
- , "MetricDataQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"metric_id" : {"type": "string","title": "METRIC_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
- "type": "object",
- "required": ["metric_id"],
- "title": "MetricDataQuery"
+ "title": "CloudServiceQuerySetsInfo"
}
- , "MetricDataStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"metric_id" : {"type": "string","title": "METRIC_ID"}},
+ , "CreateCloudServiceQuerySetRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS"},"unit" : {"type": "object","title": "UNIT"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["query"],
- "title": "MetricDataStatQuery"
+ "required": ["name","query_options","provider","cloud_service_group","cloud_service_type","resource_group"],
+ "title": "CreateCloudServiceQuerySetRequest"
}
- , "MetricDatasInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/MetricDataInfo"},
- "type": "array","$ref": "#/components/schemas/MetricDataInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "UpdateCloudServiceQuerySetRequest": {
+ "properties" : {"query_set_id" : {"type": "string","title": "QUERY_SET_ID"},"name" : {"type": "string","title": "NAME"},"query_options" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY_OPTIONS"},"unit" : {"type": "object","title": "UNIT"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "MetricDatasInfo"
+ "required": ["query_set_id"],
+ "title": "UpdateCloudServiceQuerySetRequest"
}
, "ChangeCollectorRuleOrderRequest": {
"properties" : {"collector_rule_id" : {"type": "string","title": "COLLECTOR_RULE_ID"},"order" : {"type": "integer","title": "ORDER"}},
@@ -3618,139 +3595,162 @@
"required": ["collector_rule_id"],
"title": "UpdateCollectorRuleRequest"
}
- , "CloudServiceReportInfo": {
- "properties" : {"report_id" : {"type": "string","title": "REPORT_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
- "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"timezone" : {"type": "string","title": "TIMEZONE"},"language" : {"type": "string","title": "LANGUAGE"},"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE"},"target" : {"type": "object","title": "TARGET"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_sent_at" : {"type": "string","title": "LAST_SENT_AT"}},
+ , "CollectRequest": {
+ "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
"type": "object",
- "required": ["report_id","name","options","file_format","timezone","language","schedule","target","tags","resource_group","domain_id","workspace_id","created_at","last_sent_at"],
- "title": "CloudServiceReportInfo"
+ "required": ["collector_id"],
+ "title": "CollectRequest"
}
- , "CloudServiceReportQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"report_id" : {"type": "string","title": "REPORT_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "CollectorInfo": {
+ "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"name" : {"type": "string","title": "NAME"},"provider" : {"type": "string","title": "PROVIDER"},"capability" : {"type": "object","title": "CAPABILITY"},"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"last_collected_at" : {"type": "string","title": "LAST_COLLECTED_AT"}},
"type": "object",
- "required": [],
- "title": "CloudServiceReportQuery"
+ "required": ["collector_id","name","provider","capability","secret_filter","plugin_info","schedule","tags","resource_group","domain_id","workspace_id","created_at","last_collected_at"],
+ "title": "CollectorInfo"
}
- , "CloudServiceReportRequest": {
- "properties" : {"report_id" : {"type": "string","title": "REPORT_ID"}},
+ , "CollectorQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"name" : {"type": "string","title": "NAME"},"secret_filter_state" : {"type": "string","title": "SECRET_FILTER_STATE"},"schedule_state" : {"type": "string","title": "SCHEDULE_STATE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
"type": "object",
- "required": ["report_id"],
- "title": "CloudServiceReportRequest"
+ "required": ["query","collector_id","name","secret_filter_state","schedule_state","workspace_id","plugin_id"],
+ "title": "CollectorQuery"
}
- , "CloudServiceReportStatQuery": {
+ , "CollectorRequest": {
+ "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"}},
+ "type": "object",
+ "required": ["collector_id"],
+ "title": "CollectorRequest"
+ }
+ , "CollectorStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "CloudServiceReportStatQuery"
+ "title": "CollectorStatQuery"
}
- , "CloudServiceReportsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceReportInfo"},
- "type": "array","$ref": "#/components/schemas/CloudServiceReportInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "CollectorsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CollectorInfo"},
+ "type": "array","$ref": "#/components/schemas/CollectorInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "CloudServiceReportsInfo"
+ "title": "CollectorsInfo"
}
- , "CreateCloudServiceReportRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
- "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"timezone" : {"type": "string","title": "TIMEZONE"},"language" : {"type": "string","title": "LANGUAGE"},"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE"},"target" : {"type": "object","title": "TARGET"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "CreateCollectorRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"plugin_info" : {"$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"provider" : {"type": "string","title": "PROVIDER"},"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
"type": "object",
- "required": ["name","options","schedule","target","resource_group"],
- "title": "CreateCloudServiceReportRequest"
+ "required": ["name","plugin_info","resource_group"],
+ "title": "CreateCollectorRequest"
}
- , "ReportSchedule": {
- "properties" : {"state" : {"type": "string","title": "STATE"},"hours" : {"items": {"type": "integer"},
- "type": "array","title": "HOURS"},"days_of_week" : {"items": {"type": "string"},
- "type": "array","title": "DAYS_OF_WEEK"}},
+ , "PluginInfo": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"metadata" : {"type": "object","title": "METADATA"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
"type": "object",
- "required": ["state","hours","days_of_week"],
- "title": "ReportSchedule"
+ "required": ["plugin_id","version","options","metadata","upgrade_mode"],
+ "title": "PluginInfo"
}
- , "UpdateCloudServiceReportRequest": {
- "properties" : {"report_id" : {"type": "string","title": "REPORT_ID"},"name" : {"type": "string","title": "NAME"},"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
- "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"timezone" : {"type": "string","title": "TIMEZONE"},"language" : {"type": "string","title": "LANGUAGE"},"schedule" : {"$ref": "#/components/schemas/ReportSchedule","title": "SCHEDULE"},"target" : {"type": "object","title": "TARGET"},"tags" : {"type": "object","title": "TAGS"}},
+ , "Scheduled": {
+ "properties" : {"state" : {"type": "string","title": "STATE"},"hours" : {"items": {"type": "integer"},
+ "type": "array","title": "HOURS"}},
"type": "object",
- "required": ["report_id"],
- "title": "UpdateCloudServiceReportRequest"
+ "required": ["state","hours"],
+ "title": "Scheduled"
}
- , "CreateRegionRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"region_code" : {"type": "string","title": "REGION_CODE"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"}},
+ , "SecretFilter": {
+ "properties" : {"state" : {"type": "string","title": "STATE"},"secrets" : {"items": {"type": "string"},
+ "type": "array","title": "SECRETS"},"service_accounts" : {"items": {"type": "string"},
+ "type": "array","title": "SERVICE_ACCOUNTS"},"schemas" : {"items": {"type": "string"},
+ "type": "array","title": "SCHEMAS"},"exclude_secrets" : {"items": {"type": "string"},
+ "type": "array","title": "EXCLUDE_SECRETS"},"exclude_service_accounts" : {"items": {"type": "string"},
+ "type": "array","title": "EXCLUDE_SERVICE_ACCOUNTS"},"exclude_schemas" : {"items": {"type": "string"},
+ "type": "array","title": "EXCLUDE_SCHEMAS"}},
"type": "object",
- "required": ["name","region_code"],
- "title": "CreateRegionRequest"
+ "required": ["state","secrets","service_accounts","schemas","exclude_secrets","exclude_service_accounts","exclude_schemas"],
+ "title": "SecretFilter"
}
- , "RegionInfo": {
- "properties" : {"region_id" : {"type": "string","title": "REGION_ID"},"name" : {"type": "string","title": "NAME"},"region_key" : {"type": "string","title": "REGION_KEY"},"region_code" : {"type": "string","title": "REGION_CODE"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "UpdateCollectorRequest": {
+ "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"name" : {"type": "string","title": "NAME"},"schedule" : {"$ref": "#/components/schemas/Scheduled","title": "SCHEDULE"},"secret_filter" : {"$ref": "#/components/schemas/SecretFilter","title": "SECRET_FILTER"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["region_id","name","region_key","region_code","provider","tags","domain_id","workspace_id","created_at","updated_at"],
- "title": "RegionInfo"
+ "required": ["collector_id"],
+ "title": "UpdateCollectorRequest"
}
- , "RegionQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"region_id" : {"type": "string","title": "REGION_ID"},"name" : {"type": "string","title": "NAME"},"region_key" : {"type": "string","title": "REGION_KEY"},"region_code" : {"type": "string","title": "REGION_CODE"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"}},
+ , "UpdatePluginRequest": {
+ "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"version" : {"type": "string","title": "VERSION"},"options" : {"type": "object","title": "OPTIONS"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"}},
"type": "object",
- "required": [],
- "title": "RegionQuery"
+ "required": ["collector_id"],
+ "title": "UpdatePluginRequest"
}
- , "RegionRequest": {
- "properties" : {"region_id" : {"type": "string","title": "REGION_ID"}},
+ , "VerifyPluginRequest": {
+ "properties" : {"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"}},
"type": "object",
- "required": ["region_id"],
- "title": "RegionRequest"
+ "required": ["collector_id"],
+ "title": "VerifyPluginRequest"
}
- , "RegionStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "CloudServiceAnalyzeQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "RegionStatQuery"
+ "title": "CloudServiceAnalyzeQuery"
}
- , "RegionsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/RegionInfo"},
- "type": "array","$ref": "#/components/schemas/RegionInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "CloudServiceExportRequest": {
+ "properties" : {"options" : {"items": {"$ref": "#/components/schemas/ExportOption"},
+ "type": "array","$ref": "#/components/schemas/ExportOption","title": "OPTIONS"},"file_format" : {"type": "string","title": "FILE_FORMAT"},"file_name" : {"type": "string","title": "FILE_NAME"},"timezone" : {"type": "string","title": "TIMEZONE"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "RegionsInfo"
+ "required": ["options"],
+ "title": "CloudServiceExportRequest"
}
- , "UpdateRegionRequest": {
- "properties" : {"region_id" : {"type": "string","title": "REGION_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "CloudServiceInfo": {
+ "properties" : {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"ip_addresses" : {"items": {"type": "string"},
+ "type": "array","title": "IP_ADDRESSES"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"instance_size" : {"type": "float","title": "INSTANCE_SIZE"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"provider" : {"type": "string","title": "PROVIDER"},"data" : {"type": "object","title": "DATA"},"metadata" : {"type": "object","title": "METADATA"},"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE"},"tags" : {"type": "object","title": "TAGS"},"tag_keys" : {"type": "object","title": "TAG_KEYS"},"collection_info" : {"$ref": "#/components/schemas/CollectionInfo","title": "COLLECTION_INFO"},"region_code" : {"type": "string","title": "REGION_CODE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"deleted_at" : {"type": "string","title": "DELETED_AT"}},
"type": "object",
- "required": ["region_id"],
- "title": "UpdateRegionRequest"
+ "required": ["cloud_service_id","name","state","ip_addresses","account","instance_type","instance_size","cloud_service_type","cloud_service_group","provider","data","metadata","reference","tags","tag_keys","collection_info","region_code","domain_id","workspace_id","project_id","created_at","updated_at","deleted_at"],
+ "title": "CloudServiceInfo"
}
- , "JobAnalyzeQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/AnalyzeQuery","title": "QUERY"}},
+ , "CloudServiceQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"ip_address" : {"type": "string","title": "IP_ADDRESS"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"provider" : {"type": "string","title": "PROVIDER"},"region_code" : {"type": "string","title": "REGION_CODE"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"}},
"type": "object",
- "required": ["query"],
- "title": "JobAnalyzeQuery"
+ "required": [],
+ "title": "CloudServiceQuery"
}
- , "JobInfo": {
- "properties" : {"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"total_tasks" : {"type": "integer","title": "TOTAL_TASKS"},"remained_tasks" : {"type": "integer","title": "REMAINED_TASKS"},"success_tasks" : {"type": "integer","title": "SUCCESS_TASKS"},"failure_tasks" : {"type": "integer","title": "FAILURE_TASKS"},"request_secret_id" : {"type": "string","title": "REQUEST_SECRET_ID"},"request_workspace_id" : {"type": "string","title": "REQUEST_WORKSPACE_ID"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"finished_at" : {"type": "string","title": "FINISHED_AT"}},
+ , "CloudServiceReference": {
+ "properties" : {"resource_id" : {"type": "string","title": "RESOURCE_ID"},"external_link" : {"type": "string","title": "EXTERNAL_LINK"}},
"type": "object",
- "required": ["job_id","status","total_tasks","remained_tasks","success_tasks","failure_tasks","request_secret_id","request_workspace_id","resource_group","domain_id","workspace_id","collector_id","plugin_id","created_at","updated_at","finished_at"],
- "title": "JobInfo"
+ "required": ["resource_id","external_link"],
+ "title": "CloudServiceReference"
}
- , "JobRequest": {
- "properties" : {"job_id" : {"type": "string","title": "JOB_ID"}},
+ , "CloudServiceRequest": {
+ "properties" : {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"}},
"type": "object",
- "required": ["job_id"],
- "title": "JobRequest"
+ "required": ["cloud_service_id"],
+ "title": "CloudServiceRequest"
}
- , "JobStatQuery": {
+ , "CloudServiceStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "JobStatQuery"
+ "title": "CloudServiceStatQuery"
}
- , "JobsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/JobInfo"},
- "type": "array","$ref": "#/components/schemas/JobInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "CloudServicesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/CloudServiceInfo"},
+ "type": "array","$ref": "#/components/schemas/CloudServiceInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "JobsInfo"
+ "title": "CloudServicesInfo"
}
- , "JobsQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"job_id" : {"type": "string","title": "JOB_ID"},"status" : {"type": "string","title": "STATUS"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
+ , "CollectionInfo": {
+ "properties" : {"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"secret_id" : {"type": "string","title": "SECRET_ID"},"collector_id" : {"type": "string","title": "COLLECTOR_ID"},"last_collected_at" : {"type": "string","title": "LAST_COLLECTED_AT"}},
"type": "object",
- "required": [],
- "title": "JobsQuery"
+ "required": ["service_account_id","secret_id","collector_id","last_collected_at"],
+ "title": "CollectionInfo"
+ }
+ , "CreateServiceRequest": {
+ "properties" : {"cloud_service_type" : {"type": "string","title": "CLOUD_SERVICE_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"cloud_service_group" : {"type": "string","title": "CLOUD_SERVICE_GROUP"},"name" : {"type": "string","title": "NAME"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"instance_size" : {"type": "float","title": "INSTANCE_SIZE"},"ip_addresses" : {"items": {"type": "string"},
+ "type": "array","title": "IP_ADDRESSES"},"data" : {"type": "object","title": "DATA"},"metadata" : {"type": "object","title": "METADATA"},"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE"},"tags" : {"type": "object","title": "TAGS"},"region_code" : {"type": "string","title": "REGION_CODE"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ "type": "object",
+ "required": ["cloud_service_type","provider","cloud_service_group","data"],
+ "title": "CreateServiceRequest"
+ }
+ , "UpdateCloudServiceRequest": {
+ "properties" : {"cloud_service_id" : {"type": "string","title": "CLOUD_SERVICE_ID"},"name" : {"type": "string","title": "NAME"},"account" : {"type": "string","title": "ACCOUNT"},"instance_type" : {"type": "string","title": "INSTANCE_TYPE"},"instance_size" : {"type": "float","title": "INSTANCE_SIZE"},"ip_addresses" : {"items": {"type": "string"},
+ "type": "array","title": "IP_ADDRESSES"},"data" : {"type": "object","title": "DATA"},"metadata" : {"type": "object","title": "METADATA"},"reference" : {"$ref": "#/components/schemas/CloudServiceReference","title": "REFERENCE"},"tags" : {"type": "object","title": "TAGS"},"region_code" : {"type": "string","title": "REGION_CODE"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ "type": "object",
+ "required": ["cloud_service_id"],
+ "title": "UpdateCloudServiceRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/monitoring/v1/openapi.json b/dist/openapi/cloudforet/api/monitoring/v1/openapi.json
index 9e933c185..6d0dd134b 100755
--- a/dist/openapi/cloudforet/api/monitoring/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/monitoring/v1/openapi.json
@@ -8,20 +8,20 @@
"title": "Monitoring API",
"version": "3.1.0"
},
- "paths":{"/monitoring/event-rule/create": {
+ "paths":{"/monitoring/alert/create": {
"post": {
- "tags": ["monitoring > event-rule"],
+ "tags": ["monitoring > alert"],
"summary": "Create",
"operationId" : "",
- "description": "### Description \nCreates a new EventRule. You can filter the Events to apply the EventRule by setting the input parameter `Conditions`. The method can change the Events' assignee or Project.",
+ "description": "### Description \nCreates a new Alert. Alerts generated with `create` method are made in a manual way. Manually made Alerts can be used for Notifications.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |conditions||array|True|\n |conditions_policy|ALL, ANY, ALWAYS |string|True|\n |actions||EventRuleActions|True|\n |resource_group|WORKSPACE, PROJECT |string|True|\n |options||EventRuleOptions||\n |tags||Struct||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |title||string|True|\n |project_id||string|True|\n |description||string||\n |assignee||string||\n |urgency|HIGH, LOW |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"title" : {"type": "string","title": "TITLE" },"description" : {"type": "string","title": "DESCRIPTION" },"assignee" : {"type": "string","title": "ASSIGNEE" },"urgency" : {"type": "string","title": "URGENCY" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"conditions\": [{\"key\": \"description\", \"value\": \"API\", \"operator\": \"contain\"}],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\"type\": \"personal rule\"},\n \"no_notification\": true},\n \"options\": {},\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"title\": \"sample test\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -30,29 +30,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/AlertInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
- "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
+ "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event-rule/update": {
+ },"/monitoring/alert/update": {
"post": {
- "tags": ["monitoring > event-rule"],
+ "tags": ["monitoring > alert"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \nChanges a priority order between EventRules to apply. EventRules are filtered by the order configured.",
+ "description": "### Description \nUpdates a specific Alert. You can make changes in Alert settings, including the `title`, `description`, `responder`, `state`, and `urgency`. The `responder` of the Alert is a User who is assigned to respond to the Alert.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n |name||string||\n |conditions||array||\n |conditions_policy|ALL, ANY, ALWAYS |string||\n |actions||EventRuleActions||\n |options||EventRuleOptions||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n |title||string||\n |state||string||\n |description||string||\n |reset_description||boolean||\n |urgency|HIGH, LOW |string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" },"title" : {"type": "string","title": "TITLE" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"reset_description" : {"type": "boolean","title": "RESET_DESCRIPTION" },"urgency" : {"type": "string","title": "URGENCY" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"conditions\": [{\"key\": \"description\", \"value\": \"ELB\", \"operator\": \"contain\"}],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\"change_assignee\": \"user2@email.com\",\n \"change_urgency\": \"HIGH\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\"type\": \"personal rule\"},\n \"no_notification\": true},\n \"options\": {},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-123456789012\",\n \"state\": \"ACKNOWLEDGED\",\n \"urgency\": \"LOW\",\n \"description\": \"[updating]This is a description of sample.\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -61,29 +61,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/AlertInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
- "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
+ "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event-rule/change-order": {
+ },"/monitoring/alert/assign-user": {
"post": {
- "tags": ["monitoring > event-rule"],
- "summary": "Change Order",
+ "tags": ["monitoring > alert"],
+ "summary": "Assign User",
"operationId" : "",
- "description": "### Description \nUpdates a specific EventRule. You can make changes in EventRule settings.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n |order||int|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n |assignee||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" },"order" : {"type": "integer","title": "ORDER" } }
+ "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" },"assignee" : {"type": "string","title": "ASSIGNEE" } }
},
- "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\", \n \"order\": 2,\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -92,29 +92,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/AlertInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
- "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
+ "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event-rule/delete": {
+ },"/monitoring/alert/delete": {
"post": {
- "tags": ["monitoring > event-rule"],
+ "tags": ["monitoring > alert"],
"summary": "Delete",
"operationId" : "",
- "description": "### Description \nDeletes a specific EventRule. You must assign an EventRule resource to delete by specifying `event_rule_id`.",
+ "description": "### Description \nDeletes a specific Alert and remove it from the list of Alerts. You must specify the `alert_id` of the Alert to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" } }
+ "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 2,\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
@@ -124,20 +124,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event-rule/get": {
+ },"/monitoring/alert/get": {
"post": {
- "tags": ["monitoring > event-rule"],
+ "tags": ["monitoring > alert"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGets a specific EventRule. Prints detailed information about the EventRule.",
+ "description": "### Description \nGets a specific Alert. Prints detailed information about the Alert.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" } }
+ "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 2,\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-123456789012\",\n}"},"Schema":{}
}
}
},"required": true
@@ -146,29 +146,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
+ "schema": {"$ref": "#/components/schemas/AlertInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
- "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
+ "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event-rule/list": {
+ },"/monitoring/alert/list": {
"post": {
- "tags": ["monitoring > event-rule"],
+ "tags": ["monitoring > alert"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all EventRules. You can use a query to get a filtered list of EventRules. For example, you can adjust the scope of the list to a certain Project or Domain.",
+ "description": "### Description \nGets a list of all Alerts. You can use a query to get a filtered list of Alerts.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |event_rule_id||string||\n |name||string||\n |workspace_id||string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |alert_number||int||\n |alert_id||string||\n |title||string||\n |state|TRIGGERED, ACKNOWLEDGED, RESOLVED, ERROR |string||\n |assignee||string||\n |responder||string||\n |urgency|HIGH, LOW |string||\n |severity||string||\n |resource||string||\n |provider||string||\n |account||string||\n |triggered_by||string||\n |workspace_id||string||\n |project_id||string||\n |webhook_id||string||\n |escalation_policy_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"alert_number" : {"type": "integer","title": "ALERT_NUMBER" },"alert_id" : {"type": "string","title": "ALERT_ID" },"title" : {"type": "string","title": "TITLE" },"state" : {"type": "string","title": "STATE" },"assignee" : {"type": "string","title": "ASSIGNEE" },"responder" : {"type": "string","title": "RESPONDER" },"urgency" : {"type": "string","title": "URGENCY" },"severity" : {"type": "string","title": "SEVERITY" },"resource" : {"type": "string","title": "RESOURCE" },"provider" : {"type": "string","title": "PROVIDER" },"account" : {"type": "string","title": "ACCOUNT" },"triggered_by" : {"type": "string","title": "TRIGGERED_BY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"webhook_id" : {"type": "string","title": "WEBHOOK_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {}, \n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -177,18 +177,18 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EventRulesInfo"},
+ "schema": {"$ref": "#/components/schemas/AlertsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EventRulesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"title\",\n \"value\": \"AWS\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user2@email.com\",\n \"change_urgency\": \"HIGH\",\n \"add_additional_info\": {},\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:33:58.388Z\"\n },\n {\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 2,\n \"conditions\": [\n {\n \"key\": \"title\",\n \"value\": \"ELB\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {},\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:12:30.226Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/AlertsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"alert_number\": 104057,\n \"alert_id\": \"alert-987654321098\",\n \"title\": \"Notification of access to the bastion Host\",\n \"state\": \"TRIGGERED\",\n \"description\": \"SSH Access to stargate-dev from adm\",\n \"urgency\": \"LOW\",\n \"severity\": \"INFO\",\n \"resources\": [{\n \"resource_id\": \"server-123456789012\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev\"\n }],\n \"escalation_step\": 1,\n \"escalation_ttl\": 1,\n \"additional_info\": {\n \"user\": \"user1\"\n \"host\": \"[\u00272.2.2.2\u0027]\"\n },\n \"triggered_by\": \"webhook-123456789012\",\n \"webhook_id\": \"webhook-123456789012\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T02:46:35.934Z\",\n \"updated_at\": \"2022-01-01T02:46:35.934Z\",\n \"escalated_at\": \"2022-01-01T02:46:35.979Z\"\n },\n {\n \"alert_number\": 104056,\n \"alert_id\": \"alert-123456789999\",\n \"title\": \"Notification of access to the bastion Host\",\n \"state\": \"TRIGGERED\",\n \"description\": \"SSH Access to stargate-dev from user3@email.com\",\n \"urgency\": \"LOW\",\n \"severity\": \"INFO\",\n \"resource\": [{\n \"resource_id\": \"server-123456789012\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev\"\n }],\n \"escalation_step\": 1,\n \"escalation_ttl\": 1,\n \"additional_info\": {\n \"user\": \"user3@email.com\",\n \"host\": \"[\u00271.1.1.1\u0027]\"\n },\n \"triggered_by\": \"webhook-123456789012\",\n \"webhook_id\": \"webhook-123456789012\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T02:46:31.391Z\",\n \"updated_at\": \"2022-01-01T02:46:31.391Z\",\n \"escalated_at\": \"2022-01-01T02:46:31.553Z\"\n }\n ],\n \"total_count\": 21283\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event-rule/stat": {
+ },"/monitoring/alert/stat": {
"post": {
- "tags": ["monitoring > event-rule"],
+ "tags": ["monitoring > alert"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -215,20 +215,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/project-alert-config/create": {
+ },"/monitoring/data-source/register": {
"post": {
- "tags": ["monitoring > project-alert-config"],
- "summary": "Create",
+ "tags": ["monitoring > data-source"],
+ "summary": "Register",
"operationId" : "",
- "description": "### Description \nCreates a new ProjectAlertConfig in a specific Project. When creating a ProjectAlertConfig, validation of the Project is preceded. After the validation is done, ProjectAlertConfig enables EscalationPolicy to be set in the Project, or enables `enum` type `recovery_mode` and `notification_urgency` to be set through the `options` parameter. The parameter `recovery_mode` is for changing the state of the Alert to `resolved` if the external monitoring solution sends the resolved Alert. The parameter `notification_urgency` is used to choose whether you will get all Alerts or only urgent ones.",
+ "description": "### Description \nRegisters a DataSource with information of the plugin to use. Information of the plugin includes `version`, `provider`, `upgrade_mode`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |escalation_policy_id||string||\n |options||AlertOptions||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |plugin_info||DataSourcePluginInfo|True|\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" },"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"plugin_info" : {"$ref": "#/components/schemas/DataSourcePluginInfo","title": "PLUGIN_INFO" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"datasource-test\",\n \"plugin_info\": {\"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_resource_type\": [\"inventory.Server\", \"inventory.CloudService\"],\n \"required_keys\": [\"data.cloudwatch\"],\n \"supported_stat\": [\"AVERAGE\", \"MAX\", \"MIN\", \"SUM\"]},\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\"a\": \"b\"},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -237,29 +237,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},"Default Example":{
- "value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-27T05:12:22.998Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/project-alert-config/update": {
+ },"/monitoring/data-source/update": {
"post": {
- "tags": ["monitoring > project-alert-config"],
+ "tags": ["monitoring > data-source"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdates a specific ProjectAlertConfig. You can make changes in ProjectAlertConfig settings, including the EscalationPolicy to apply. You can also change `notification_urgency` and `recovery_mode` by modifying the `options` parameter.",
+ "description": "### Description \nUpdates a specific DataSource. You can make changes in DataSource settings, including `name` and `tags`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |escalation_policy_id||string||\n |options||AlertOptions||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" },"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"escalation_policy_id\": \"ep-4ee42a9b2d96\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"MANUAL\"\n },\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"tmp-datasource_test\",\n \"tags\": {\"b\": \"c\"},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -268,52 +268,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},"Default Example":{
- "value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-27T05:12:22.998Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/project-alert-config/delete": {
- "post": {
- "tags": ["monitoring > project-alert-config"],
- "summary": "Delete",
- "operationId" : "",
- "description": "### Description \nDeletes a specific ProjectAlertConfig. Deletes alert configuration data in a Project.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
- },
- "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/monitoring/project-alert-config/get": {
+ },"/monitoring/data-source/enable": {
"post": {
- "tags": ["monitoring > project-alert-config"],
- "summary": "Get",
+ "tags": ["monitoring > data-source"],
+ "summary": "Enable",
"operationId" : "",
- "description": "### Description \nGets a specific ProjectAlertConfig. Prints detailed information about the ProjectAlertConfig, including EscalationPolicy, recovery mode, and notification urgency.",
+ "description": "### Description \nEnables a specific DataSource. By enabling a DataSource, you can communicate with an external cloud service via the plugin.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -322,29 +299,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},"Default Example":{
- "value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-27T05:12:22.998Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/project-alert-config/list": {
+ },"/monitoring/data-source/disable": {
"post": {
- "tags": ["monitoring > project-alert-config"],
- "summary": "List",
+ "tags": ["monitoring > data-source"],
+ "summary": "Disable",
"operationId" : "",
- "description": "### Description \nGets a list of all ProjectAlertConfigs from all projects configured in the same domain. You can use a query to get a filtered list of ProjectAlertConfigs.",
+ "description": "### Description \nDisables a specific DataSource. By disabling a DataSource, you can block communication with an external cloud service via the plugin.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |project_id||string||\n |escalation_policy_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -353,58 +330,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/ProjectAlertConfigsInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"project_id\": \"project-18655561c535\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"MANUAL\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-4ee42a9b2d96\",\n \"name\": \"HAHA\",\n \"is_default\": true\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-05-17T02:09:19.839Z\"\n },\n {\n \"project_id\": \"project-9074eea97d7e\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"MANUAL\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2021-06-24T02:50:50.535Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
+ "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/project-alert-config/stat": {
+ },"/monitoring/data-source/deregister": {
"post": {
- "tags": ["monitoring > project-alert-config"],
- "summary": "Stat",
+ "tags": ["monitoring > data-source"],
+ "summary": "Deregister",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeregisters and deletes a specific DataSource. You must specify the `data_source_id` of the DataSource to deregister.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/register": {
+ },"/monitoring/data-source/update-plugin": {
"post": {
"tags": ["monitoring > data-source"],
- "summary": "Register",
+ "summary": "Update Plugin",
"operationId" : "",
- "description": "### Description \nRegisters a DataSource with information of the plugin to use. Information of the plugin includes `version`, `provider`, `upgrade_mode`.",
+ "description": "### Description \nUpdates the plugin of a specific DataSource. This method resets the plugin data in the DataSource to update the `metadata`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |plugin_info||DataSourcePluginInfo|True|\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"plugin_info" : {"$ref": "#/components/schemas/DataSourcePluginInfo","title": "PLUGIN_INFO" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"datasource-test\",\n \"plugin_info\": {\"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_resource_type\": [\"inventory.Server\", \"inventory.CloudService\"],\n \"required_keys\": [\"data.cloudwatch\"],\n \"supported_stat\": [\"AVERAGE\", \"MAX\", \"MIN\", \"SUM\"]},\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\"a\": \"b\"},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"version\": \"1.1.3\",\n \"options\": {},\n \"upgrade_mode\": \"MANUAL\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -422,43 +393,35 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/update": {
+ },"/monitoring/data-source/verify-plugin": {
"post": {
"tags": ["monitoring > data-source"],
- "summary": "Update",
+ "summary": "Verify Plugin",
"operationId" : "",
- "description": "### Description \nUpdates a specific DataSource. You can make changes in DataSource settings, including `name` and `tags`.",
+ "description": "### Description \nVerifies the plugin of a specific DataSource. This method validates the plugin data, `version` and `endpoint`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"tmp-datasource_test\",\n \"tags\": {\"b\": \"c\"},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/enable": {
+ },"/monitoring/data-source/get": {
"post": {
"tags": ["monitoring > data-source"],
- "summary": "Enable",
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nEnables a specific DataSource. By enabling a DataSource, you can communicate with an external cloud service via the plugin.",
+ "description": "### Description \nGets a specific DataSource. Prints detailed information about the DataSource, including `name`, `state`, and `plugin_info`.",
"requestBody": {
"description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
"content": {
@@ -484,20 +447,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/disable": {
+ },"/monitoring/data-source/list": {
"post": {
"tags": ["monitoring > data-source"],
- "summary": "Disable",
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nDisables a specific DataSource. By disabling a DataSource, you can block communication with an external cloud service via the plugin.",
+ "description": "### Description \nGets a list of all DataSources. You can use a query to get a filtered list of DataSources.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |data_source_id||string||\n |name||string||\n |state||string||\n |monitoring_type|METRIC, LOG |string||\n |provider||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"monitoring_type" : {"type": "string","title": "MONITORING_TYPE" },"provider" : {"type": "string","title": "PROVIDER" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -506,52 +469,58 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/DataSourcesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/DataSourcesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"data_source_id\": \"ds-89f1e81528e9\",\n \"name\": \"AWS CloudTrail\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"LOG\",\n \"provider\": \"aws\",\n \"capability\": {\n \"use_resource_secret\": true,\n \"monitoring_type\": \"LOG\",\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ]\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-9881b9b440a4\",\n \"version\": \"1.0-dev2\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"required_keys\": [\n \"reference.resource_id\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2021-03-31T08:39:45.532Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/deregister": {
+ },"/monitoring/data-source/stat": {
"post": {
"tags": ["monitoring > data-source"],
- "summary": "Deregister",
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nDeregisters and deletes a specific DataSource. You must specify the `data_source_id` of the DataSource to deregister.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/update-plugin": {
+ },"/monitoring/event-rule/create": {
"post": {
- "tags": ["monitoring > data-source"],
- "summary": "Update Plugin",
+ "tags": ["monitoring > event-rule"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nUpdates the plugin of a specific DataSource. This method resets the plugin data in the DataSource to update the `metadata`.",
+ "description": "### Description \nCreates a new EventRule. You can filter the Events to apply the EventRule by setting the input parameter `Conditions`. The method can change the Events' assignee or Project.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |version||string||\n |options||Struct||\n |upgrade_mode|MANUAL, AUTO |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |conditions||array|True|\n |conditions_policy|ALL, ANY, ALWAYS |string|True|\n |actions||EventRuleActions|True|\n |resource_group|WORKSPACE, PROJECT |string|True|\n |options||EventRuleOptions||\n |tags||Struct||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"version" : {"type": "string","title": "VERSION" },"options" : {"type": "object","title": "OPTIONS" },"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"version\": \"1.1.3\",\n \"options\": {},\n \"upgrade_mode\": \"MANUAL\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"conditions\": [{\"key\": \"description\", \"value\": \"API\", \"operator\": \"contain\"}],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\"type\": \"personal rule\"},\n \"no_notification\": true},\n \"options\": {},\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -560,52 +529,60 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
+ "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/verify-plugin": {
+ },"/monitoring/event-rule/update": {
"post": {
- "tags": ["monitoring > data-source"],
- "summary": "Verify Plugin",
+ "tags": ["monitoring > event-rule"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nVerifies the plugin of a specific DataSource. This method validates the plugin data, `version` and `endpoint`.",
+ "description": "### Description \nChanges a priority order between EventRules to apply. EventRules are filtered by the order configured.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n |name||string||\n |conditions||array||\n |conditions_policy|ALL, ANY, ALWAYS |string||\n |actions||EventRuleActions||\n |options||EventRuleOptions||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" },"name" : {"type": "string","title": "NAME" },"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"}, "type": "array","title": "CONDITIONS" },"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY" },"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS" },"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"conditions\": [{\"key\": \"description\", \"value\": \"ELB\", \"operator\": \"contain\"}],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\"change_assignee\": \"user2@email.com\",\n \"change_urgency\": \"HIGH\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\"type\": \"personal rule\"},\n \"no_notification\": true},\n \"options\": {},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
+ "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
+ }}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/get": {
+ },"/monitoring/event-rule/change-order": {
"post": {
- "tags": ["monitoring > data-source"],
- "summary": "Get",
+ "tags": ["monitoring > event-rule"],
+ "summary": "Change Order",
"operationId" : "",
- "description": "### Description \nGets a specific DataSource. Prints detailed information about the DataSource, including `name`, `state`, and `plugin_info`.",
+ "description": "### Description \nUpdates a specific EventRule. You can make changes in EventRule settings.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n |order||int|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" } }
+ "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" },"order" : {"type": "integer","title": "ORDER" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-6167ed6b42f4\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\", \n \"order\": 2,\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -614,60 +591,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourceInfo"},
+ "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourceInfo"},"Default Example":{
- "value": "{\n \"data_source_id\": \"ds-123456789012\",\n \"name\": \"datasource-test\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"METRIC\",\n \"provider\": \"aws\",\n \"capability\": {\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ],\n \"use_resource_secret\": true,\n \"monitoring_type\": \"METRIC\"\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-123456789012\",\n \"version\": \"1.1.4.20220617.135934\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"supported_stat\": [\n \"AVERAGE\",\n \"MAX\",\n \"MIN\",\n \"SUM\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ],\n \"required_keys\": [\n \"data.cloudwatch\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {\n \"a\": \"b\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-06-21T01:17:12.144Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
+ "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/list": {
+ },"/monitoring/event-rule/delete": {
"post": {
- "tags": ["monitoring > data-source"],
- "summary": "List",
+ "tags": ["monitoring > event-rule"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \nGets a list of all DataSources. You can use a query to get a filtered list of DataSources.",
+ "description": "### Description \nDeletes a specific EventRule. You must assign an EventRule resource to delete by specifying `event_rule_id`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |data_source_id||string||\n |name||string||\n |state||string||\n |monitoring_type|METRIC, LOG |string||\n |provider||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"monitoring_type" : {"type": "string","title": "MONITORING_TYPE" },"provider" : {"type": "string","title": "PROVIDER" } }
+ "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 2,\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/DataSourcesInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/DataSourcesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"data_source_id\": \"ds-89f1e81528e9\",\n \"name\": \"AWS CloudTrail\",\n \"state\": \"ENABLED\",\n \"monitoring_type\": \"LOG\",\n \"provider\": \"aws\",\n \"capability\": {\n \"use_resource_secret\": true,\n \"monitoring_type\": \"LOG\",\n \"supported_schema\": [\n \"aws_access_key\",\n \"aws_assume_role\"\n ]\n },\n \"plugin_info\": {\n \"plugin_id\": \"plugin-9881b9b440a4\",\n \"version\": \"1.0-dev2\",\n \"options\": {},\n \"provider\": \"aws\",\n \"metadata\": {\n \"required_keys\": [\n \"reference.resource_id\"\n ],\n \"supported_resource_type\": [\n \"inventory.Server\",\n \"inventory.CloudService\"\n ]\n },\n \"upgrade_mode\": \"AUTO\"\n },\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2021-03-31T08:39:45.532Z\"\n }\n ],\n \"total_count\": 2\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/data-source/stat": {
+ },"/monitoring/event-rule/get": {
"post": {
- "tags": ["monitoring > data-source"],
- "summary": "Stat",
+ "tags": ["monitoring > event-rule"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific EventRule. Prints detailed information about the EventRule.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |event_rule_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 2,\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -676,27 +645,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/EventRuleInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/EventRuleInfo"},"Default Example":{
+ "value": "{\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"description\",\n \"value\": \"API\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {\n \"type\": \"personal rule\"\n },\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-02T06:02:31.517Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/metric/list": {
+ },"/monitoring/event-rule/list": {
"post": {
- "tags": ["monitoring > metric"],
+ "tags": ["monitoring > event-rule"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Metrics of one or more specified Resources. The parameter `resources` is a list of Resources from which to get a list of Metrics collected.",
+ "description": "### Description \nGets a list of all EventRules. You can use a query to get a filtered list of EventRules. For example, you can adjust the scope of the list to a certain Project or Domain.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |resources||array|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |event_rule_id||string||\n |name||string||\n |workspace_id||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"resources" : {"items": {}, "type": "array","title": "RESOURCES" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID" },"name" : {"type": "string","title": "NAME" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-31190a65a42a\",\n \"resources\": [\"cloud-svc-cd0105d255da\"],\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -705,29 +676,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricsInfo"},
+ "schema": {"$ref": "#/components/schemas/EventRulesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricsInfo"},"Default Example":{
- "value": "{\n \"metrics\": [\n {\n \"key\": \"CPUUtilization\",\n \"group\": \"AWS/EC2\",\n \"name\": \"CPUUtilization\",\n \"unit\": {\n \"y\": \"Percent\",\n \"x\": \"Timestamp\"\n },\n \"metric_query\": {\n \"cloud-svc-cd0105d255da\": {\n \"Dimensions\": [\n {\n \"Name\": \"InstanceId\",\n \"Value\": \"i-0400cdd39f1a4d5e9\"\n }\n ],\n \"MetricName\": \"CPUUtilization\",\n \"Namespace\": \"AWS/EC2\"\n }\n }\n },\n {\n \"key\": \"NetworkIn\",\n \"group\": \"AWS/EC2\",\n \"name\": \"NetworkIn\",\n \"unit\": {\n \"y\": \"Bytes\",\n \"x\": \"Timestamp\"\n },\n \"metric_query\": {\n \"cloud-svc-cd0105d255da\": {\n \"Dimensions\": [\n {\n \"Name\": \"InstanceId\",\n \"Value\": \"i-0400cdd39f1a4d5e9\"\n }\n ],\n \"MetricName\": \"NetworkIn\",\n \"Namespace\": \"AWS/EC2\"\n }\n }\n }\n ],\n \"available_resources\": {\n \"cloud-svc-cd0105d255da\": true\n },\n \"domain_id\": \"domain-31190a65a42a\"\n}"
+ "Schema": {"$ref": "#/components/schemas/EventRulesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 1,\n \"conditions\": [\n {\n \"key\": \"title\",\n \"value\": \"AWS\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user2@email.com\",\n \"change_urgency\": \"HIGH\",\n \"add_additional_info\": {},\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:33:58.388Z\"\n },\n {\n \"event_rule_id\": \"er-123456789012\",\n \"order\": 2,\n \"conditions\": [\n {\n \"key\": \"title\",\n \"value\": \"ELB\",\n \"operator\": \"contain\"\n }\n ],\n \"conditions_policy\": \"ALL\",\n \"actions\": {\n \"change_assignee\": \"user1@email.com\",\n \"change_urgency\": \"LOW\",\n \"change_project\": \"project-123456789012\",\n \"add_additional_info\": {},\n \"no_notification\": true\n },\n \"options\": {},\n \"scope\": \"PROJECT\",\n \"project_id\": \"project-123456789012\",\n \"tags\": {},\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:12:30.226Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/metric/get-data": {
+ },"/monitoring/event-rule/stat": {
"post": {
- "tags": ["monitoring > metric"],
- "summary": "Get Data",
+ "tags": ["monitoring > event-rule"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nGets data of a single Metric. You must specify the parameter `metric` to get data of. You can specify the `period` to get data for.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |metric_query||Struct|True|\n |metric||string|True|\n |start||string|True|\n |end||string|True|\n |period||int||\n |stat||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"metric_query" : {"type": "object","title": "METRIC_QUERY" },"metric" : {"type": "string","title": "METRIC" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"period" : {"type": "integer","title": "PERIOD" },"stat" : {"type": "string","title": "STAT" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-31190a65a42a\",\n \"metric_query\": {\n \"cloud-svc-cd0105d255da\": {\n \"Dimensions\": [\n {\n \"Name\": \"InstanceId\",\n \"Value\": \"i-0400cdd39f1a4d5e9\"\n }\n ],\n \"MetricName\": \"CPUUtilization\",\n \"Namespace\": \"AWS/EC2\"\n }\n },\n \"metric\": \"CPUUtilization\",\n \"start\": \"2022-06-21T03:11:29.438Z\",\n \"end\": \"2022-06-21T04:11:29.438Z\",\n \"stat\": \"AVERAGE\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -736,29 +707,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/MetricDataInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/MetricDataInfo"},"Default Example":{
- "value": "{\n \"labels\": [\n \"2022-06-21T03:13:00.000Z\",\n \"2022-06-21T03:18:00.000Z\",\n \"2022-06-21T03:23:00.000Z\",\n \"2022-06-21T03:28:00.000Z\",\n \"2022-06-21T03:33:00.000Z\",\n \"2022-06-21T03:38:00.000Z\",\n \"2022-06-21T03:43:00.000Z\",\n \"2022-06-21T03:48:00.000Z\",\n \"2022-06-21T03:53:00.000Z\",\n \"2022-06-21T03:58:00.000Z\",\n \"2022-06-21T04:03:00.000Z\",\n \"2022-06-21T04:08:00.000Z\"\n ],\n \"resource_values\": {\n \"cloud-svc-cd0105d255da\": [\n 0.099999999999999,\n 0.10001852366397981,\n 0.10001852366397981,\n 0.1328230362675432,\n 0.099472075576548,\n 0.06507936507936621,\n 0.166703713994628,\n 0.1338983050847476,\n 0.1327868852458988,\n 0.1339168287487284,\n 0.1328610417160508,\n 0.10056497175141618\n ]\n },\n \"domain_id\": \"domain-58010aa2e451\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/note/create": {
+ },"/monitoring/event/get": {
"post": {
- "tags": ["monitoring > note"],
- "summary": "Create",
+ "tags": ["monitoring > event"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nCreates a new Note. You can create Notes for each Alert to record the information needed to manage the Alerts.",
+ "description": "### Description \nGets a specific Event matching the input parameters, `event_id` and `domain_id`. Prints detailed information about the Event.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n |note||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service||string|True|\n |resource||string|True|\n |verb||string|True|\n |status||string|True|\n |message||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" },"note" : {"type": "string","title": "NOTE" } }
+ "properties": {"service" : {"type": "string","title": "SERVICE" },"resource" : {"type": "string","title": "RESOURCE" },"verb" : {"type": "string","title": "VERB" },"status" : {"type": "string","title": "STATUS" },"message" : {"type": "object","title": "MESSAGE" } }
},
- "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -767,29 +736,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NoteInfo"},
+ "schema": {"$ref": "#/components/schemas/EventInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
- "value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n \"created_by\": \"seolmin@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-29T08:26:14.418Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/EventInfo"},"Default Example":{
+ "value": "{\n \"event_id\": \"event-4e16ba3bd384\",\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"severity\": \"INFO\",\n \"resource\": {\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\"\n },\n \"raw_data\": {\n \"resource\": {\n \"name\": \"stargate-dev-kubectl-amzl2\",\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\"\n },\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"severity\": \"INFO\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"event_type\": \"ALERT\",\n \"additional_info\": {\n \"host\": [],\n \"user\": \"spaceoneadm\"\n }\n },\n \"additional_info\": {\n \"host\": \"[]\",\n \"user\": \"spaceoneadm\"\n },\n \"alert_id\": \"alert-06462f6cb54e\",\n \"webhook_id\": \"webhook-ff9e2eda678a\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-21T00:34:58.034Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/note/update": {
+ },"/monitoring/event/list": {
"post": {
- "tags": ["monitoring > note"],
- "summary": "Update",
+ "tags": ["monitoring > event"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nUpdates a specific Note. You must specify the `note_id` for Note validation check. If the Note exists, it is updated.",
+ "description": "### Description \nGets a list of all Events. You must specify the `domain_id`. You can use a query to get a filtered list of Events.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n |note||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |event_id||string||\n |event_key||string||\n |event_type||string||\n |severity||string||\n |resource||string||\n |provider||string||\n |account||string||\n |workspace_id||string||\n |project_id||string||\n |alert_id||string||\n |webhook_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"note_id" : {"type": "string","title": "NOTE_ID" },"note" : {"type": "string","title": "NOTE" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"event_id" : {"type": "string","title": "EVENT_ID" },"event_key" : {"type": "string","title": "EVENT_KEY" },"event_type" : {"type": "string","title": "EVENT_TYPE" },"severity" : {"type": "string","title": "SEVERITY" },"resource" : {"type": "string","title": "RESOURCE" },"provider" : {"type": "string","title": "PROVIDER" },"account" : {"type": "string","title": "ACCOUNT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"alert_id" : {"type": "string","title": "ALERT_ID" },"webhook_id" : {"type": "string","title": "WEBHOOK_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"note\": \"This is a test\",\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
}
}
},"required": true
@@ -798,52 +767,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NoteInfo"},
+ "schema": {"$ref": "#/components/schemas/EventsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
- "value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n \"created_by\": \"seolmin@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-29T08:26:14.418Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/EventsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"event_id\": \"event-4e16ba3bd384\",\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"severity\": \"INFO\",\n \"resource\": {\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\"\n },\n \"raw_data\": {\n \"resource\": {\n \"name\": \"stargate-dev-kubectl-amzl2\",\n \"resource_type\": \"inventory.Server\",\n \"resource_id\": \"server-1187737cc0d9\"\n },\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"additional_info\": {\n \"user\": \"spaceoneadm\",\n \"host\": []\n },\n \"severity\": \"INFO\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"event_type\": \"ALERT\"\n },\n \"additional_info\": {\n \"user\": \"spaceoneadm\",\n \"host\": \"[]\"\n },\n \"alert_id\": \"alert-06462f6cb54e\",\n \"webhook_id\": \"webhook-ff9e2eda678a\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-21T00:34:58.034Z\"\n },\n {\n \"event_id\": \"event-b178e1b71daf\",\n \"event_key\": \"abc16e5455c26ab7611bf8aa8d1020cc\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from glee@mz.co.kr\",\n \"severity\": \"INFO\",\n \"resource\": {\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\"\n },\n \"raw_data\": {\n \"additional_info\": {\n \"host\": [\n \"125.131.104.40\"\n ],\n \"user\": \"glee@mz.co.kr\"\n },\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from glee@mz.co.kr\",\n \"severity\": \"INFO\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"resource\": {\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\",\n \"resource_id\": \"server-1187737cc0d9\"\n },\n \"event_key\": \"abc16e5455c26ab7611bf8aa8d1020cc\"\n },\n \"additional_info\": {\n \"user\": \"glee@mz.co.kr\",\n \"host\": \"[\u0027125.131.104.40\u0027]\"\n },\n \"alert_id\": \"alert-332617cf2894\",\n \"webhook_id\": \"webhook-ff9e2eda678a\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-21T00:34:52.822Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/note/delete": {
+ },"/monitoring/event/stat": {
"post": {
- "tags": ["monitoring > note"],
- "summary": "Delete",
+ "tags": ["monitoring > event"],
+ "summary": "Stat",
"operationId" : "",
- "description": "### Description \nDeletes a specific Note. You must specify the `note_id` of the Note to delete.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
- "examples":{"Default Example":{"value": "{\n \"note_id\": \"note-0bfac585bf5a\",\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response"}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/monitoring/note/get": {
- "post": {
- "tags": ["monitoring > note"],
- "summary": "Get",
- "operationId" : "",
- "description": "### Description \nGets a specific Note. You must specify the `note_id` and `domain_id`.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
- },
- "examples":{"Default Example":{"value": "{\n \"note_id\": \"note-0bfac585bf5a\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -852,58 +798,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/NoteInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
- "value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n \"created_by\": \"seolmin@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-29T08:26:14.418Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/note/list": {
+ },"/monitoring/log/list": {
"post": {
- "tags": ["monitoring > note"],
+ "tags": ["monitoring > log"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Notes. You can use a query to get a filtered list of Notes.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |note_id||string||\n |alert_id||string||\n |created_by||string||\n |workspace_id||string||\n |project_id||string||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"note_id" : {"type": "string","title": "NOTE_ID" },"alert_id" : {"type": "string","title": "ALERT_ID" },"created_by" : {"type": "string","title": "CREATED_BY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
- },
- "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/NotesInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/NotesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"note_id\": \"note-0597bd748be0\",\n \"alert_id\": \"alert-fbfd78e43df8\",\n \"note\": \"http://spaceone.org\",\n \"created_by\": \"hykang@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-23T09:58:23.838Z\"\n },\n {\n \"note_id\": \"note-0bfac585bf5a\",\n \"alert_id\": \"alert-fbfd78e43df8\",\n \"note\": \"test\",\n \"created_by\": \"hykang@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-23T09:52:42.251Z\"\n }\n ],\n \"total_count\": 2\n}"
- }}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
- },"/monitoring/note/stat": {
- "post": {
- "tags": ["monitoring > note"],
- "summary": "Stat",
- "operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |resource_id||string|True|\n |keyword||string||\n |start||string||\n |end||string||\n |sort||Struct||\n |limit||int||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"resource_id" : {"type": "string","title": "RESOURCE_ID" },"keyword" : {"type": "string","title": "KEYWORD" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"sort" : {"type": "object","title": "SORT" },"limit" : {"type": "integer","title": "LIMIT" } }
},
"examples":{"Schema":{}
}
@@ -914,9 +827,9 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"type": "object"},
+ "schema": {"$ref": "#/components/schemas/LogDataInfo"},
"examples": {
- "Schema": {"type": "object"}}
+ "Schema": {"$ref": "#/components/schemas/LogDataInfo"}}
}
}}
}
@@ -1128,20 +1041,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event/get": {
+ },"/monitoring/note/create": {
"post": {
- "tags": ["monitoring > event"],
- "summary": "Get",
+ "tags": ["monitoring > note"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nGets a specific Event matching the input parameters, `event_id` and `domain_id`. Prints detailed information about the Event.",
+ "description": "### Description \nCreates a new Note. You can create Notes for each Alert to record the information needed to manage the Alerts.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |service||string|True|\n |resource||string|True|\n |verb||string|True|\n |status||string|True|\n |message||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n |note||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"service" : {"type": "string","title": "SERVICE" },"resource" : {"type": "string","title": "RESOURCE" },"verb" : {"type": "string","title": "VERB" },"status" : {"type": "string","title": "STATUS" },"message" : {"type": "object","title": "MESSAGE" } }
+ "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" },"note" : {"type": "string","title": "NOTE" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n}"},"Schema":{}
}
}
},"required": true
@@ -1150,29 +1063,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EventInfo"},
+ "schema": {"$ref": "#/components/schemas/NoteInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EventInfo"},"Default Example":{
- "value": "{\n \"event_id\": \"event-4e16ba3bd384\",\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"severity\": \"INFO\",\n \"resource\": {\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\"\n },\n \"raw_data\": {\n \"resource\": {\n \"name\": \"stargate-dev-kubectl-amzl2\",\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\"\n },\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"severity\": \"INFO\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"event_type\": \"ALERT\",\n \"additional_info\": {\n \"host\": [],\n \"user\": \"spaceoneadm\"\n }\n },\n \"additional_info\": {\n \"host\": \"[]\",\n \"user\": \"spaceoneadm\"\n },\n \"alert_id\": \"alert-06462f6cb54e\",\n \"webhook_id\": \"webhook-ff9e2eda678a\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-21T00:34:58.034Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
+ "value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n \"created_by\": \"seolmin@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-29T08:26:14.418Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event/list": {
+ },"/monitoring/note/update": {
"post": {
- "tags": ["monitoring > event"],
- "summary": "List",
+ "tags": ["monitoring > note"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nGets a list of all Events. You must specify the `domain_id`. You can use a query to get a filtered list of Events.",
+ "description": "### Description \nUpdates a specific Note. You must specify the `note_id` for Note validation check. If the Note exists, it is updated.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |event_id||string||\n |event_key||string||\n |event_type||string||\n |severity||string||\n |resource||string||\n |provider||string||\n |account||string||\n |workspace_id||string||\n |project_id||string||\n |alert_id||string||\n |webhook_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n |note||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"event_id" : {"type": "string","title": "EVENT_ID" },"event_key" : {"type": "string","title": "EVENT_KEY" },"event_type" : {"type": "string","title": "EVENT_TYPE" },"severity" : {"type": "string","title": "SEVERITY" },"resource" : {"type": "string","title": "RESOURCE" },"provider" : {"type": "string","title": "PROVIDER" },"account" : {"type": "string","title": "ACCOUNT" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"alert_id" : {"type": "string","title": "ALERT_ID" },"webhook_id" : {"type": "string","title": "WEBHOOK_ID" } }
+ "properties": {"note_id" : {"type": "string","title": "NOTE_ID" },"note" : {"type": "string","title": "NOTE" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"note\": \"This is a test\",\n}"},"Schema":{}
}
}
},"required": true
@@ -1181,58 +1094,52 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/EventsInfo"},
+ "schema": {"$ref": "#/components/schemas/NoteInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/EventsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"event_id\": \"event-4e16ba3bd384\",\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"severity\": \"INFO\",\n \"resource\": {\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\"\n },\n \"raw_data\": {\n \"resource\": {\n \"name\": \"stargate-dev-kubectl-amzl2\",\n \"resource_type\": \"inventory.Server\",\n \"resource_id\": \"server-1187737cc0d9\"\n },\n \"event_key\": \"cfbdd0cee08f0f2664dbef297c370017\",\n \"additional_info\": {\n \"user\": \"spaceoneadm\",\n \"host\": []\n },\n \"severity\": \"INFO\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from spaceoneadm\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"event_type\": \"ALERT\"\n },\n \"additional_info\": {\n \"user\": \"spaceoneadm\",\n \"host\": \"[]\"\n },\n \"alert_id\": \"alert-06462f6cb54e\",\n \"webhook_id\": \"webhook-ff9e2eda678a\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-21T00:34:58.034Z\"\n },\n {\n \"event_id\": \"event-b178e1b71daf\",\n \"event_key\": \"abc16e5455c26ab7611bf8aa8d1020cc\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from glee@mz.co.kr\",\n \"severity\": \"INFO\",\n \"resource\": {\n \"resource_id\": \"server-1187737cc0d9\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\"\n },\n \"raw_data\": {\n \"additional_info\": {\n \"host\": [\n \"125.131.104.40\"\n ],\n \"user\": \"glee@mz.co.kr\"\n },\n \"description\": \"SSH Access to stargate-dev-kubectl-amzl2 from glee@mz.co.kr\",\n \"severity\": \"INFO\",\n \"event_type\": \"ALERT\",\n \"title\": \"Notification of access to the SpaceONE bastion Host\",\n \"resource\": {\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev-kubectl-amzl2\",\n \"resource_id\": \"server-1187737cc0d9\"\n },\n \"event_key\": \"abc16e5455c26ab7611bf8aa8d1020cc\"\n },\n \"additional_info\": {\n \"user\": \"glee@mz.co.kr\",\n \"host\": \"[\u0027125.131.104.40\u0027]\"\n },\n \"alert_id\": \"alert-332617cf2894\",\n \"webhook_id\": \"webhook-ff9e2eda678a\",\n \"project_id\": \"project-18655561c535\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-21T00:34:52.822Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
+ "value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n \"created_by\": \"seolmin@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-29T08:26:14.418Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/event/stat": {
+ },"/monitoring/note/delete": {
"post": {
- "tags": ["monitoring > event"],
- "summary": "Stat",
+ "tags": ["monitoring > note"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeletes a specific Note. You must specify the `note_id` of the Note to delete.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
+ "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"note_id\": \"note-0bfac585bf5a\",\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/alert/create": {
+ },"/monitoring/note/get": {
"post": {
- "tags": ["monitoring > alert"],
- "summary": "Create",
+ "tags": ["monitoring > note"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nCreates a new Alert. Alerts generated with `create` method are made in a manual way. Manually made Alerts can be used for Notifications.",
+ "description": "### Description \nGets a specific Note. You must specify the `note_id` and `domain_id`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |title||string|True|\n |project_id||string|True|\n |description||string||\n |assignee||string||\n |urgency|HIGH, LOW |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |note_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"title" : {"type": "string","title": "TITLE" },"description" : {"type": "string","title": "DESCRIPTION" },"assignee" : {"type": "string","title": "ASSIGNEE" },"urgency" : {"type": "string","title": "URGENCY" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"note_id" : {"type": "string","title": "NOTE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"title\": \"sample test\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"note_id\": \"note-0bfac585bf5a\",\n}"},"Schema":{}
}
}
},"required": true
@@ -1241,29 +1148,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AlertInfo"},
+ "schema": {"$ref": "#/components/schemas/NoteInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
- "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/NoteInfo"},"Default Example":{
+ "value": "{\n \"note_id\": \"note-df107d31bf20\",\n \"alert_id\": \"alert-160ce04f6908\",\n \"note\": \"This is a description\",\n \"created_by\": \"seolmin@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-29T08:26:14.418Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/alert/update": {
+ },"/monitoring/note/list": {
"post": {
- "tags": ["monitoring > alert"],
- "summary": "Update",
+ "tags": ["monitoring > note"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nUpdates a specific Alert. You can make changes in Alert settings, including the `title`, `description`, `responder`, `state`, and `urgency`. The `responder` of the Alert is a User who is assigned to respond to the Alert.",
+ "description": "### Description \nGets a list of all Notes. You can use a query to get a filtered list of Notes.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n |title||string||\n |state||string||\n |description||string||\n |reset_description||boolean||\n |urgency|HIGH, LOW |string||\n |project_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |note_id||string||\n |alert_id||string||\n |created_by||string||\n |workspace_id||string||\n |project_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" },"title" : {"type": "string","title": "TITLE" },"state" : {"type": "string","title": "STATE" },"description" : {"type": "string","title": "DESCRIPTION" },"reset_description" : {"type": "boolean","title": "RESET_DESCRIPTION" },"urgency" : {"type": "string","title": "URGENCY" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"note_id" : {"type": "string","title": "NOTE_ID" },"alert_id" : {"type": "string","title": "ALERT_ID" },"created_by" : {"type": "string","title": "CREATED_BY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-123456789012\",\n \"state\": \"ACKNOWLEDGED\",\n \"urgency\": \"LOW\",\n \"description\": \"[updating]This is a description of sample.\",\n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1272,27 +1179,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AlertInfo"},
+ "schema": {"$ref": "#/components/schemas/NotesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
- "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/NotesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"note_id\": \"note-0597bd748be0\",\n \"alert_id\": \"alert-fbfd78e43df8\",\n \"note\": \"http://spaceone.org\",\n \"created_by\": \"hykang@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-23T09:58:23.838Z\"\n },\n {\n \"note_id\": \"note-0bfac585bf5a\",\n \"alert_id\": \"alert-fbfd78e43df8\",\n \"note\": \"test\",\n \"created_by\": \"hykang@mz.co.kr\",\n \"project_id\": \"project-52a423012d5e\",\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-23T09:52:42.251Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/alert/assign-user": {
+ },"/monitoring/note/stat": {
"post": {
- "tags": ["monitoring > alert"],
- "summary": "Assign User",
+ "tags": ["monitoring > note"],
+ "summary": "Stat",
"operationId" : "",
"description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n |assignee||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" },"assignee" : {"type": "string","title": "ASSIGNEE" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY" } }
},
"examples":{"Schema":{}
}
@@ -1303,52 +1210,58 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AlertInfo"},
+ "schema": {"type": "object"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
- "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
- }}
+ "Schema": {"type": "object"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/alert/delete": {
+ },"/monitoring/project-alert-config/create": {
"post": {
- "tags": ["monitoring > alert"],
- "summary": "Delete",
+ "tags": ["monitoring > project-alert-config"],
+ "summary": "Create",
"operationId" : "",
- "description": "### Description \nDeletes a specific Alert and remove it from the list of Alerts. You must specify the `alert_id` of the Alert to delete.",
+ "description": "### Description \nCreates a new ProjectAlertConfig in a specific Project. When creating a ProjectAlertConfig, validation of the Project is preceded. After the validation is done, ProjectAlertConfig enables EscalationPolicy to be set in the Project, or enables `enum` type `recovery_mode` and `notification_urgency` to be set through the `options` parameter. The parameter `recovery_mode` is for changing the state of the Alert to `resolved` if the external monitoring solution sends the resolved Alert. The parameter `notification_urgency` is used to choose whether you will get all Alerts or only urgent ones.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |escalation_policy_id||string||\n |options||AlertOptions||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" },"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS" } }
},
- "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-123456789012\",\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response"}
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},"Default Example":{
+ "value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-27T05:12:22.998Z\"\n}"
+ }}
+ }
+ }}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/alert/get": {
+ },"/monitoring/project-alert-config/update": {
"post": {
- "tags": ["monitoring > alert"],
- "summary": "Get",
+ "tags": ["monitoring > project-alert-config"],
+ "summary": "Update",
"operationId" : "",
- "description": "### Description \nGets a specific Alert. Prints detailed information about the Alert.",
+ "description": "### Description \nUpdates a specific ProjectAlertConfig. You can make changes in ProjectAlertConfig settings, including the EscalationPolicy to apply. You can also change `notification_urgency` and `recovery_mode` by modifying the `options` parameter.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |alert_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n |escalation_policy_id||string||\n |options||AlertOptions||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"alert_id" : {"type": "string","title": "ALERT_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" },"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS" } }
},
- "examples":{"Default Example":{"value": "{\n \"alert_id\": \"alert-123456789012\",\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"escalation_policy_id\": \"ep-4ee42a9b2d96\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"MANUAL\"\n },\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
}
}
},"required": true
@@ -1357,51 +1270,105 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/AlertInfo"},
+ "schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/AlertInfo"},"Default Example":{
- "value": "{\n \"alert_number\": 104053,\n \"alert_id\": \"alert-123456789012\",\n \"title\": \"sample test\",\n \"state\": \"TRIGGERED\",\n \"description\": \"This is a description of sample.\",\n \"urgency\": \"HIGH\",\n \"severity\": \"NONE\",\n \"escalation_step\": 1,\n \"additional_info\": {},\n \"triggered_by\": \"user1@email.com\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T01:43:08.566Z\",\n \"updated_at\": \"2022-01-01T01:43:08.566Z\",\n \"escalated_at\": \"2022-01-01T01:43:54.464Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},"Default Example":{
+ "value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-27T05:12:22.998Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/alert/list": {
+ },"/monitoring/project-alert-config/delete": {
"post": {
- "tags": ["monitoring > alert"],
- "summary": "List",
+ "tags": ["monitoring > project-alert-config"],
+ "summary": "Delete",
"operationId" : "",
- "description": "### Description \nGets a list of all Alerts. You can use a query to get a filtered list of Alerts.",
+ "description": "### Description \nDeletes a specific ProjectAlertConfig. Deletes alert configuration data in a Project.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |alert_number||int||\n |alert_id||string||\n |title||string||\n |state|TRIGGERED, ACKNOWLEDGED, RESOLVED, ERROR |string||\n |assignee||string||\n |responder||string||\n |urgency|HIGH, LOW |string||\n |severity||string||\n |resource||string||\n |provider||string||\n |account||string||\n |triggered_by||string||\n |workspace_id||string||\n |project_id||string||\n |webhook_id||string||\n |escalation_policy_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"alert_number" : {"type": "integer","title": "ALERT_NUMBER" },"alert_id" : {"type": "string","title": "ALERT_ID" },"title" : {"type": "string","title": "TITLE" },"state" : {"type": "string","title": "STATE" },"assignee" : {"type": "string","title": "ASSIGNEE" },"responder" : {"type": "string","title": "RESPONDER" },"urgency" : {"type": "string","title": "URGENCY" },"severity" : {"type": "string","title": "SEVERITY" },"resource" : {"type": "string","title": "RESOURCE" },"provider" : {"type": "string","title": "PROVIDER" },"account" : {"type": "string","title": "ACCOUNT" },"triggered_by" : {"type": "string","title": "TRIGGERED_BY" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"project_id" : {"type": "string","title": "PROJECT_ID" },"webhook_id" : {"type": "string","title": "WEBHOOK_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" } }
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"query\": {}, \n \"domain_id\": \"domain-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
}
}
},"required": true
},
"responses": {
"200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/AlertsInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/AlertsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"alert_number\": 104057,\n \"alert_id\": \"alert-987654321098\",\n \"title\": \"Notification of access to the bastion Host\",\n \"state\": \"TRIGGERED\",\n \"description\": \"SSH Access to stargate-dev from adm\",\n \"urgency\": \"LOW\",\n \"severity\": \"INFO\",\n \"resources\": [{\n \"resource_id\": \"server-123456789012\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev\"\n }],\n \"escalation_step\": 1,\n \"escalation_ttl\": 1,\n \"additional_info\": {\n \"user\": \"user1\"\n \"host\": \"[\u00272.2.2.2\u0027]\"\n },\n \"triggered_by\": \"webhook-123456789012\",\n \"webhook_id\": \"webhook-123456789012\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T02:46:35.934Z\",\n \"updated_at\": \"2022-01-01T02:46:35.934Z\",\n \"escalated_at\": \"2022-01-01T02:46:35.979Z\"\n },\n {\n \"alert_number\": 104056,\n \"alert_id\": \"alert-123456789999\",\n \"title\": \"Notification of access to the bastion Host\",\n \"state\": \"TRIGGERED\",\n \"description\": \"SSH Access to stargate-dev from user3@email.com\",\n \"urgency\": \"LOW\",\n \"severity\": \"INFO\",\n \"resource\": [{\n \"resource_id\": \"server-123456789012\",\n \"resource_type\": \"inventory.Server\",\n \"name\": \"stargate-dev\"\n }],\n \"escalation_step\": 1,\n \"escalation_ttl\": 1,\n \"additional_info\": {\n \"user\": \"user3@email.com\",\n \"host\": \"[\u00271.1.1.1\u0027]\"\n },\n \"triggered_by\": \"webhook-123456789012\",\n \"webhook_id\": \"webhook-123456789012\",\n \"escalation_policy_id\": \"ep-123456789012\",\n \"project_id\": \"project-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T02:46:31.391Z\",\n \"updated_at\": \"2022-01-01T02:46:31.391Z\",\n \"escalated_at\": \"2022-01-01T02:46:31.553Z\"\n }\n ],\n \"total_count\": 21283\n}"
- }}
- }
- }}
+ "description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/alert/stat": {
+ },"/monitoring/project-alert-config/get": {
"post": {
- "tags": ["monitoring > alert"],
- "summary": "Stat",
- "operationId" : "",
+ "tags": ["monitoring > project-alert-config"],
+ "summary": "Get",
+ "operationId" : "",
+ "description": "### Description \nGets a specific ProjectAlertConfig. Prints detailed information about the ProjectAlertConfig, including EscalationPolicy, recovery mode, and notification urgency.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |project_id||string|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"project_id" : {"type": "string","title": "PROJECT_ID" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},"Default Example":{
+ "value": "{\n \"project_id\": \"project-dee2a81d4859\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"AUTO\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-06-27T05:12:22.998Z\"\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/monitoring/project-alert-config/list": {
+ "post": {
+ "tags": ["monitoring > project-alert-config"],
+ "summary": "List",
+ "operationId" : "",
+ "description": "### Description \nGets a list of all ProjectAlertConfigs from all projects configured in the same domain. You can use a query to get a filtered list of ProjectAlertConfigs.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |project_id||string||\n |escalation_policy_id||string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"project_id" : {"type": "string","title": "PROJECT_ID" },"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"query\": {},\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/ProjectAlertConfigsInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/ProjectAlertConfigsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"project_id\": \"project-18655561c535\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"MANUAL\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-4ee42a9b2d96\",\n \"name\": \"HAHA\",\n \"is_default\": true\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2022-05-17T02:09:19.839Z\"\n },\n {\n \"project_id\": \"project-9074eea97d7e\",\n \"options\": {\n \"notification_urgency\": \"ALL\",\n \"recovery_mode\": \"MANUAL\"\n },\n \"escalation_policy_info\": {\n \"escalation_policy_id\": \"ep-b441abe04ca9\",\n \"name\": \"Global New Policy\"\n },\n \"domain_id\": \"domain-58010aa2e451\",\n \"created_at\": \"2021-06-24T02:50:50.535Z\"\n }\n ],\n \"total_count\": 2\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/monitoring/project-alert-config/stat": {
+ "post": {
+ "tags": ["monitoring > project-alert-config"],
+ "summary": "Stat",
+ "operationId" : "",
"description": "### Description \n",
"requestBody": {
"description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||StatisticsQuery|True|\n
",
@@ -1426,6 +1393,68 @@
}}
}
,"security": [{"HTTPBearer": []}] }
+ },"/monitoring/metric/list": {
+ "post": {
+ "tags": ["monitoring > metric"],
+ "summary": "List",
+ "operationId" : "",
+ "description": "### Description \nGets a list of all Metrics of one or more specified Resources. The parameter `resources` is a list of Resources from which to get a list of Metrics collected.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |resources||array|True|\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"resources" : {"items": {}, "type": "array","title": "RESOURCES" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-31190a65a42a\",\n \"resources\": [\"cloud-svc-cd0105d255da\"],\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/MetricsInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/MetricsInfo"},"Default Example":{
+ "value": "{\n \"metrics\": [\n {\n \"key\": \"CPUUtilization\",\n \"group\": \"AWS/EC2\",\n \"name\": \"CPUUtilization\",\n \"unit\": {\n \"y\": \"Percent\",\n \"x\": \"Timestamp\"\n },\n \"metric_query\": {\n \"cloud-svc-cd0105d255da\": {\n \"Dimensions\": [\n {\n \"Name\": \"InstanceId\",\n \"Value\": \"i-0400cdd39f1a4d5e9\"\n }\n ],\n \"MetricName\": \"CPUUtilization\",\n \"Namespace\": \"AWS/EC2\"\n }\n }\n },\n {\n \"key\": \"NetworkIn\",\n \"group\": \"AWS/EC2\",\n \"name\": \"NetworkIn\",\n \"unit\": {\n \"y\": \"Bytes\",\n \"x\": \"Timestamp\"\n },\n \"metric_query\": {\n \"cloud-svc-cd0105d255da\": {\n \"Dimensions\": [\n {\n \"Name\": \"InstanceId\",\n \"Value\": \"i-0400cdd39f1a4d5e9\"\n }\n ],\n \"MetricName\": \"NetworkIn\",\n \"Namespace\": \"AWS/EC2\"\n }\n }\n }\n ],\n \"available_resources\": {\n \"cloud-svc-cd0105d255da\": true\n },\n \"domain_id\": \"domain-31190a65a42a\"\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
+ },"/monitoring/metric/get-data": {
+ "post": {
+ "tags": ["monitoring > metric"],
+ "summary": "Get Data",
+ "operationId" : "",
+ "description": "### Description \nGets data of a single Metric. You must specify the parameter `metric` to get data of. You can specify the `period` to get data for.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |metric_query||Struct|True|\n |metric||string|True|\n |start||string|True|\n |end||string|True|\n |period||int||\n |stat||string||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"metric_query" : {"type": "object","title": "METRIC_QUERY" },"metric" : {"type": "string","title": "METRIC" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"period" : {"type": "integer","title": "PERIOD" },"stat" : {"type": "string","title": "STAT" } }
+ },
+ "examples":{"Default Example":{"value": "{\n \"data_source_id\": \"ds-31190a65a42a\",\n \"metric_query\": {\n \"cloud-svc-cd0105d255da\": {\n \"Dimensions\": [\n {\n \"Name\": \"InstanceId\",\n \"Value\": \"i-0400cdd39f1a4d5e9\"\n }\n ],\n \"MetricName\": \"CPUUtilization\",\n \"Namespace\": \"AWS/EC2\"\n }\n },\n \"metric\": \"CPUUtilization\",\n \"start\": \"2022-06-21T03:11:29.438Z\",\n \"end\": \"2022-06-21T04:11:29.438Z\",\n \"stat\": \"AVERAGE\",\n \"domain_id\": \"domain-58010aa2e451\"\n}"},"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"$ref": "#/components/schemas/MetricDataInfo"},
+ "examples": {
+ "Schema": {"$ref": "#/components/schemas/MetricDataInfo"},"Default Example":{
+ "value": "{\n \"labels\": [\n \"2022-06-21T03:13:00.000Z\",\n \"2022-06-21T03:18:00.000Z\",\n \"2022-06-21T03:23:00.000Z\",\n \"2022-06-21T03:28:00.000Z\",\n \"2022-06-21T03:33:00.000Z\",\n \"2022-06-21T03:38:00.000Z\",\n \"2022-06-21T03:43:00.000Z\",\n \"2022-06-21T03:48:00.000Z\",\n \"2022-06-21T03:53:00.000Z\",\n \"2022-06-21T03:58:00.000Z\",\n \"2022-06-21T04:03:00.000Z\",\n \"2022-06-21T04:08:00.000Z\"\n ],\n \"resource_values\": {\n \"cloud-svc-cd0105d255da\": [\n 0.099999999999999,\n 0.10001852366397981,\n 0.10001852366397981,\n 0.1328230362675432,\n 0.099472075576548,\n 0.06507936507936621,\n 0.166703713994628,\n 0.1338983050847476,\n 0.1327868852458988,\n 0.1339168287487284,\n 0.1328610417160508,\n 0.10056497175141618\n ]\n },\n \"domain_id\": \"domain-58010aa2e451\"\n}"
+ }}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
},"/monitoring/webhook/create": {
"post": {
"tags": ["monitoring > webhook"],
@@ -1718,169 +1747,82 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/monitoring/log/list": {
- "post": {
- "tags": ["monitoring > log"],
- "summary": "List",
- "operationId" : "",
- "description": "### Description \n",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |data_source_id||string|True|\n |resource_id||string|True|\n |keyword||string||\n |start||string||\n |end||string||\n |sort||Struct||\n |limit||int||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID" },"resource_id" : {"type": "string","title": "RESOURCE_ID" },"keyword" : {"type": "string","title": "KEYWORD" },"start" : {"type": "string","title": "START" },"end" : {"type": "string","title": "END" },"sort" : {"type": "object","title": "SORT" },"limit" : {"type": "integer","title": "LIMIT" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"$ref": "#/components/schemas/LogDataInfo"},
- "examples": {
- "Schema": {"$ref": "#/components/schemas/LogDataInfo"}}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
},"securitySchemes": {"HTTPBearer": {"type": "http","scheme": "bearer","bearerFormat": "JWT"}}
},
"components":{
"schemas": {
- "ChangeEventRuleOrderRequest": {
- "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"order" : {"type": "integer","title": "ORDER"}},
+ "AlertInfo": {
+ "properties" : {"alert_number" : {"type": "integer","title": "ALERT_NUMBER"},"alert_id" : {"type": "string","title": "ALERT_ID"},"title" : {"type": "string","title": "TITLE"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"assignee" : {"type": "string","title": "ASSIGNEE"},"responder" : {"type": "string","title": "RESPONDER"},"urgency" : {"type": "string","title": "URGENCY"},"severity" : {"type": "string","title": "SEVERITY"},"rule" : {"type": "string","title": "RULE"},"image_url" : {"type": "string","title": "IMAGE_URL"},"resources" : {"items": {"$ref": "#/components/schemas/AlertResource"},
+ "type": "array","$ref": "#/components/schemas/AlertResource","title": "RESOURCES"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"escalation_step" : {"type": "integer","title": "ESCALATION_STEP"},"escalation_ttl" : {"type": "integer","title": "ESCALATION_TTL"},"triggered_by" : {"type": "string","title": "TRIGGERED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"acknowledged_at" : {"type": "string","title": "ACKNOWLEDGED_AT"},"resolved_at" : {"type": "string","title": "RESOLVED_AT"},"escalated_at" : {"type": "string","title": "ESCALATED_AT"}},
"type": "object",
- "required": ["event_rule_id","order"],
- "title": "ChangeEventRuleOrderRequest"
+ "required": ["alert_number","alert_id","title","state","description","assignee","responder","urgency","severity","rule","image_url","resources","provider","account","additional_info","escalation_step","escalation_ttl","triggered_by","domain_id","workspace_id","project_id","webhook_id","escalation_policy_id","created_at","updated_at","acknowledged_at","resolved_at","escalated_at"],
+ "title": "AlertInfo"
}
- , "CreateEventRuleRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"},
- "type": "array","$ref": "#/components/schemas/EventRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "AlertQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"alert_number" : {"type": "integer","title": "ALERT_NUMBER"},"alert_id" : {"type": "string","title": "ALERT_ID"},"title" : {"type": "string","title": "TITLE"},"state" : {"type": "string","title": "STATE"},"assignee" : {"type": "string","title": "ASSIGNEE"},"responder" : {"type": "string","title": "RESPONDER"},"urgency" : {"type": "string","title": "URGENCY"},"severity" : {"type": "string","title": "SEVERITY"},"resource" : {"type": "string","title": "RESOURCE"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"triggered_by" : {"type": "string","title": "TRIGGERED_BY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"}},
"type": "object",
- "required": ["name","conditions","conditions_policy","actions","resource_group"],
- "title": "CreateEventRuleRequest"
+ "required": [],
+ "title": "AlertQuery"
}
- , "EventRuleActionResponder": {
- "properties" : {"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"}},
+ , "AlertRequest": {
+ "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"}},
"type": "object",
- "required": ["resource_type","resource_id"],
- "title": "EventRuleActionResponder"
+ "required": ["alert_id"],
+ "title": "AlertRequest"
}
- , "EventRuleActions": {
- "properties" : {"change_assignee" : {"type": "string","title": "CHANGE_ASSIGNEE"},"change_urgency" : {"type": "string","title": "CHANGE_URGENCY"},"change_project" : {"type": "string","title": "CHANGE_PROJECT"},"change_escalation_policy" : {"type": "string","title": "CHANGE_ESCALATION_POLICY"},"match_service_account" : {"$ref": "#/components/schemas/MatchRule","title": "MATCH_SERVICE_ACCOUNT"},"add_additional_info" : {"type": "object","title": "ADD_ADDITIONAL_INFO"},"no_notification" : {"type": "boolean","title": "NO_NOTIFICATION"}},
+ , "AlertResource": {
+ "properties" : {"resource_id" : {"type": "string","title": "RESOURCE_ID"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"name" : {"type": "string","title": "NAME"}},
"type": "object",
- "required": ["change_assignee","change_urgency","change_project","change_escalation_policy","match_service_account","add_additional_info","no_notification"],
- "title": "EventRuleActions"
+ "required": ["resource_id","resource_type","name"],
+ "title": "AlertResource"
}
- , "EventRuleCondition": {
- "properties" : {"key" : {"type": "string","title": "KEY"},"value" : {"type": "string","title": "VALUE"},"operator" : {"type": "string","title": "OPERATOR"}},
+ , "AlertStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
- "required": ["key","value","operator"],
- "title": "EventRuleCondition"
+ "required": ["query"],
+ "title": "AlertStatQuery"
}
- , "EventRuleInfo": {
- "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"},
- "type": "array","$ref": "#/components/schemas/EventRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "AlertsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/AlertInfo"},
+ "type": "array","$ref": "#/components/schemas/AlertInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["event_rule_id","name","order","conditions","conditions_policy","actions","options","tags","resource_group","domain_id","workspace_id","project_id","created_at"],
- "title": "EventRuleInfo"
+ "required": ["results","total_count"],
+ "title": "AlertsInfo"
}
- , "EventRuleOptions": {
- "properties" : {"stop_processing" : {"type": "boolean","title": "STOP_PROCESSING"}},
+ , "AssignUserRequest": {
+ "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"assignee" : {"type": "string","title": "ASSIGNEE"}},
"type": "object",
- "required": ["stop_processing"],
- "title": "EventRuleOptions"
+ "required": ["alert_id","assignee"],
+ "title": "AssignUserRequest"
}
- , "EventRuleQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "CreateAlertRequest": {
+ "properties" : {"title" : {"type": "string","title": "TITLE"},"description" : {"type": "string","title": "DESCRIPTION"},"assignee" : {"type": "string","title": "ASSIGNEE"},"urgency" : {"type": "string","title": "URGENCY"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": [],
- "title": "EventRuleQuery"
+ "required": ["title","project_id"],
+ "title": "CreateAlertRequest"
}
- , "EventRuleRequest": {
- "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"}},
+ , "UpdateAlertRequest": {
+ "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"title" : {"type": "string","title": "TITLE"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"reset_description" : {"type": "boolean","title": "RESET_DESCRIPTION"},"urgency" : {"type": "string","title": "URGENCY"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["event_rule_id"],
- "title": "EventRuleRequest"
+ "required": ["alert_id"],
+ "title": "UpdateAlertRequest"
}
- , "EventRuleStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "UpdateAlertStateRequest": {
+ "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"access_key" : {"type": "string","title": "ACCESS_KEY"},"responder" : {"type": "string","title": "RESPONDER"}},
"type": "object",
- "required": ["query"],
- "title": "EventRuleStatQuery"
+ "required": ["alert_id","access_key"],
+ "title": "UpdateAlertStateRequest"
}
- , "EventRulesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EventRuleInfo"},
- "type": "array","$ref": "#/components/schemas/EventRuleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "AggregateCount": {
+ "properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "EventRulesInfo"
+ "required": ["name"],
+ "title": "AggregateCount"
}
- , "MatchRule": {
- "properties" : {"source" : {"type": "string","title": "SOURCE"},"target" : {"type": "string","title": "TARGET"}},
- "type": "object",
- "required": ["source","target"],
- "title": "MatchRule"
- }
- , "UpdateEventRuleRequest": {
- "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"},
- "type": "array","$ref": "#/components/schemas/EventRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["event_rule_id"],
- "title": "UpdateEventRuleRequest"
- }
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
- , "AggregateCount": {
- "properties" : {"name" : {"type": "string","title": "NAME"}},
- "type": "object",
- "required": ["name"],
- "title": "AggregateCount"
- }
- , "AggregateGroup": {
- "properties" : {"keys" : {"items": {"$ref": "#/components/schemas/AggregateGroupKey"},
- "type": "array","$ref": "#/components/schemas/AggregateGroupKey","title": "KEYS"},"fields" : {"items": {"$ref": "#/components/schemas/AggregateGroupField"},
- "type": "array","$ref": "#/components/schemas/AggregateGroupField","title": "FIELDS"}},
+ , "AggregateGroup": {
+ "properties" : {"keys" : {"items": {"$ref": "#/components/schemas/AggregateGroupKey"},
+ "type": "array","$ref": "#/components/schemas/AggregateGroupKey","title": "KEYS"},"fields" : {"items": {"$ref": "#/components/schemas/AggregateGroupField"},
+ "type": "array","$ref": "#/components/schemas/AggregateGroupField","title": "FIELDS"}},
"type": "object",
"required": ["keys","fields"],
"title": "AggregateGroup"
@@ -2040,54 +1982,43 @@
"required": ["path","filter"],
"title": "Unwind"
}
- , "AlertOptions": {
- "properties" : {"notification_urgency" : {"type": "string","title": "NOTIFICATION_URGENCY"},"recovery_mode" : {"type": "string","title": "RECOVERY_MODE"}},
- "type": "object",
- "required": ["notification_urgency","recovery_mode"],
- "title": "AlertOptions"
- }
- , "CreateProjectAlertConfigRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"},"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS"}},
- "type": "object",
- "required": ["project_id"],
- "title": "CreateProjectAlertConfigRequest"
- }
- , "ProjectAlertConfigInfo": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS"},"escalation_policy_info" : {"$ref": "#/components/schemas/EscalationPolicyInfo","title": "ESCALATION_POLICY_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["project_id","options","escalation_policy_info","domain_id","workspace_id","created_at"],
- "title": "ProjectAlertConfigInfo"
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
}
- , "ProjectAlertConfigQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"}},
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
"type": "object",
- "required": [],
- "title": "ProjectAlertConfigQuery"
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
}
- , "ProjectAlertConfigRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
"type": "object",
- "required": ["project_id"],
- "title": "ProjectAlertConfigRequest"
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
}
- , "ProjectAlertConfigStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
"type": "object",
- "required": ["query"],
- "title": "ProjectAlertConfigStatQuery"
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
}
- , "ProjectAlertConfigsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
- "type": "array","$ref": "#/components/schemas/ProjectAlertConfigInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "ProjectAlertConfigsInfo"
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
}
- , "UpdateProjectAlertConfigRequest": {
- "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"},"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS"}},
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["project_id"],
- "title": "UpdateProjectAlertConfigRequest"
+ "required": ["version"],
+ "title": "VersionInfo"
}
, "DataSourceInfo": {
"properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"monitoring_type" : {"type": "string","title": "MONITORING_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"capability" : {"type": "object","title": "CAPABILITY"},"plugin_info" : {"$ref": "#/components/schemas/DataSourcePluginInfo","title": "PLUGIN_INFO"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
@@ -2144,80 +2075,131 @@
"required": ["data_source_id"],
"title": "UpdateDataSourceRequest"
}
- , "MetricDataInfo": {
- "properties" : {"labels" : {"type": "array","title": "LABELS"},"values" : {"type": "object","title": "VALUES"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "ChangeEventRuleOrderRequest": {
+ "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"order" : {"type": "integer","title": "ORDER"}},
"type": "object",
- "required": ["labels","values","domain_id"],
- "title": "MetricDataInfo"
+ "required": ["event_rule_id","order"],
+ "title": "ChangeEventRuleOrderRequest"
}
- , "MetricDataRequest": {
- "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"metric_query" : {"type": "object","title": "METRIC_QUERY"},"metric" : {"type": "string","title": "METRIC"},"start" : {"type": "string","title": "START"},"end" : {"type": "string","title": "END"},"period" : {"type": "integer","title": "PERIOD"},"stat" : {"type": "string","title": "STAT"}},
+ , "CreateEventRuleRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"},
+ "type": "array","$ref": "#/components/schemas/EventRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
- "required": ["data_source_id","metric_query","metric","start","end"],
- "title": "MetricDataRequest"
+ "required": ["name","conditions","conditions_policy","actions","resource_group"],
+ "title": "CreateEventRuleRequest"
}
- , "MetricInfo": {
- "properties" : {"key" : {"type": "string","title": "KEY"},"name" : {"type": "string","title": "NAME"},"group" : {"type": "string","title": "GROUP"},"unit" : {"type": "object","title": "UNIT"},"metric_query" : {"type": "object","title": "METRIC_QUERY"}},
+ , "EventRuleActionResponder": {
+ "properties" : {"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"resource_id" : {"type": "string","title": "RESOURCE_ID"}},
"type": "object",
- "required": ["key","name","group","unit","metric_query"],
- "title": "MetricInfo"
+ "required": ["resource_type","resource_id"],
+ "title": "EventRuleActionResponder"
}
- , "MetricRequest": {
- "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"resources" : {"items": {"type": "string"},
- "type": "array","title": "RESOURCES"}},
+ , "EventRuleActions": {
+ "properties" : {"change_assignee" : {"type": "string","title": "CHANGE_ASSIGNEE"},"change_urgency" : {"type": "string","title": "CHANGE_URGENCY"},"change_project" : {"type": "string","title": "CHANGE_PROJECT"},"change_escalation_policy" : {"type": "string","title": "CHANGE_ESCALATION_POLICY"},"match_service_account" : {"$ref": "#/components/schemas/MatchRule","title": "MATCH_SERVICE_ACCOUNT"},"add_additional_info" : {"type": "object","title": "ADD_ADDITIONAL_INFO"},"no_notification" : {"type": "boolean","title": "NO_NOTIFICATION"}},
"type": "object",
- "required": ["data_source_id","resources"],
- "title": "MetricRequest"
+ "required": ["change_assignee","change_urgency","change_project","change_escalation_policy","match_service_account","add_additional_info","no_notification"],
+ "title": "EventRuleActions"
}
- , "MetricsInfo": {
- "properties" : {"metrics" : {"items": {"$ref": "#/components/schemas/MetricInfo"},
- "type": "array","$ref": "#/components/schemas/MetricInfo","title": "METRICS"},"available_resources" : {"type": "object","title": "AVAILABLE_RESOURCES"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "EventRuleCondition": {
+ "properties" : {"key" : {"type": "string","title": "KEY"},"value" : {"type": "string","title": "VALUE"},"operator" : {"type": "string","title": "OPERATOR"}},
"type": "object",
- "required": ["metrics","available_resources","domain_id"],
- "title": "MetricsInfo"
+ "required": ["key","value","operator"],
+ "title": "EventRuleCondition"
}
- , "CreateNoteRequest": {
- "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"note" : {"type": "string","title": "NOTE"}},
+ , "EventRuleInfo": {
+ "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"name" : {"type": "string","title": "NAME"},"order" : {"type": "integer","title": "ORDER"},"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"},
+ "type": "array","$ref": "#/components/schemas/EventRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["alert_id","note"],
- "title": "CreateNoteRequest"
+ "required": ["event_rule_id","name","order","conditions","conditions_policy","actions","options","tags","resource_group","domain_id","workspace_id","project_id","created_at"],
+ "title": "EventRuleInfo"
}
- , "NoteInfo": {
- "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"note" : {"type": "string","title": "NOTE"},"created_by" : {"type": "string","title": "CREATED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "EventRuleOptions": {
+ "properties" : {"stop_processing" : {"type": "boolean","title": "STOP_PROCESSING"}},
"type": "object",
- "required": ["note_id","alert_id","note","created_by","domain_id","workspace_id","project_id","created_at"],
- "title": "NoteInfo"
+ "required": ["stop_processing"],
+ "title": "EventRuleOptions"
}
- , "NoteQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"note_id" : {"type": "string","title": "NOTE_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"created_by" : {"type": "string","title": "CREATED_BY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "EventRuleQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"name" : {"type": "string","title": "NAME"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
"required": [],
- "title": "NoteQuery"
+ "title": "EventRuleQuery"
}
- , "NoteRequest": {
- "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"}},
+ , "EventRuleRequest": {
+ "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"}},
"type": "object",
- "required": ["note_id"],
- "title": "NoteRequest"
+ "required": ["event_rule_id"],
+ "title": "EventRuleRequest"
}
- , "NoteStatQuery": {
+ , "EventRuleStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "NoteStatQuery"
+ "title": "EventRuleStatQuery"
}
- , "NotesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/NoteInfo"},
- "type": "array","$ref": "#/components/schemas/NoteInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "EventRulesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EventRuleInfo"},
+ "type": "array","$ref": "#/components/schemas/EventRuleInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "NotesInfo"
+ "title": "EventRulesInfo"
}
- , "UpdateNoteRequest": {
- "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"note" : {"type": "string","title": "NOTE"}},
+ , "MatchRule": {
+ "properties" : {"source" : {"type": "string","title": "SOURCE"},"target" : {"type": "string","title": "TARGET"}},
"type": "object",
- "required": ["note_id"],
- "title": "UpdateNoteRequest"
+ "required": ["source","target"],
+ "title": "MatchRule"
+ }
+ , "UpdateEventRuleRequest": {
+ "properties" : {"event_rule_id" : {"type": "string","title": "EVENT_RULE_ID"},"name" : {"type": "string","title": "NAME"},"conditions" : {"items": {"$ref": "#/components/schemas/EventRuleCondition"},
+ "type": "array","$ref": "#/components/schemas/EventRuleCondition","title": "CONDITIONS"},"conditions_policy" : {"type": "string","title": "CONDITIONS_POLICY"},"actions" : {"$ref": "#/components/schemas/EventRuleActions","title": "ACTIONS"},"options" : {"$ref": "#/components/schemas/EventRuleOptions","title": "OPTIONS"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["event_rule_id"],
+ "title": "UpdateEventRuleRequest"
+ }
+ , "CreateEventRequest": {
+ "properties" : {"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"access_key" : {"type": "string","title": "ACCESS_KEY"},"data" : {"type": "object","title": "DATA"}},
+ "type": "object",
+ "required": ["webhook_id","access_key","data"],
+ "title": "CreateEventRequest"
+ }
+ , "EventInfo": {
+ "properties" : {"event_id" : {"type": "string","title": "EVENT_ID"},"event_key" : {"type": "string","title": "EVENT_KEY"},"event_type" : {"type": "string","title": "EVENT_TYPE"},"title" : {"type": "string","title": "TITLE"},"description" : {"type": "string","title": "DESCRIPTION"},"severity" : {"type": "string","title": "SEVERITY"},"rule" : {"type": "string","title": "RULE"},"image_url" : {"type": "string","title": "IMAGE_URL"},"resources" : {"items": {"type": "string"},
+ "type": "array","title": "RESOURCES"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"raw_data" : {"type": "object","title": "RAW_DATA"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"occurred_at" : {"type": "string","title": "OCCURRED_AT"}},
+ "type": "object",
+ "required": ["event_id","event_key","event_type","title","description","severity","rule","image_url","resources","provider","account","additional_info","raw_data","domain_id","workspace_id","project_id","alert_id","webhook_id","created_at","occurred_at"],
+ "title": "EventInfo"
+ }
+ , "EventQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"event_id" : {"type": "string","title": "EVENT_ID"},"event_key" : {"type": "string","title": "EVENT_KEY"},"event_type" : {"type": "string","title": "EVENT_TYPE"},"severity" : {"type": "string","title": "SEVERITY"},"resource" : {"type": "string","title": "RESOURCE"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "EventQuery"
+ }
+ , "EventStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "EventStatQuery"
+ }
+ , "EventsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EventInfo"},
+ "type": "array","$ref": "#/components/schemas/EventInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "EventsInfo"
+ }
+ , "LogDataInfo": {
+ "properties" : {"results" : {"type": "array","title": "RESULTS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["results","domain_id"],
+ "title": "LogDataInfo"
+ }
+ , "LogRequest": {
+ "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"keyword" : {"type": "string","title": "KEYWORD"},"start" : {"type": "string","title": "START"},"end" : {"type": "string","title": "END"},"sort" : {"type": "object","title": "SORT"},"limit" : {"type": "integer","title": "LIMIT"}},
+ "type": "object",
+ "required": ["data_source_id","resource_id"],
+ "title": "LogRequest"
}
, "CreateEscalationPolicyRequest": {
"properties" : {"name" : {"type": "string","title": "NAME"},"rules" : {"items": {"$ref": "#/components/schemas/EscalationPolicyRule"},
@@ -2271,99 +2253,129 @@
"required": ["escalation_policy_id"],
"title": "UpdateEscalationPolicyRequest"
}
- , "CreateEventRequest": {
- "properties" : {"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"access_key" : {"type": "string","title": "ACCESS_KEY"},"data" : {"type": "object","title": "DATA"}},
+ , "CreateNoteRequest": {
+ "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"note" : {"type": "string","title": "NOTE"}},
"type": "object",
- "required": ["webhook_id","access_key","data"],
- "title": "CreateEventRequest"
+ "required": ["alert_id","note"],
+ "title": "CreateNoteRequest"
}
- , "EventInfo": {
- "properties" : {"event_id" : {"type": "string","title": "EVENT_ID"},"event_key" : {"type": "string","title": "EVENT_KEY"},"event_type" : {"type": "string","title": "EVENT_TYPE"},"title" : {"type": "string","title": "TITLE"},"description" : {"type": "string","title": "DESCRIPTION"},"severity" : {"type": "string","title": "SEVERITY"},"rule" : {"type": "string","title": "RULE"},"image_url" : {"type": "string","title": "IMAGE_URL"},"resources" : {"items": {"type": "string"},
- "type": "array","title": "RESOURCES"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"raw_data" : {"type": "object","title": "RAW_DATA"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"occurred_at" : {"type": "string","title": "OCCURRED_AT"}},
+ , "NoteInfo": {
+ "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"note" : {"type": "string","title": "NOTE"},"created_by" : {"type": "string","title": "CREATED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["event_id","event_key","event_type","title","description","severity","rule","image_url","resources","provider","account","additional_info","raw_data","domain_id","workspace_id","project_id","alert_id","webhook_id","created_at","occurred_at"],
- "title": "EventInfo"
+ "required": ["note_id","alert_id","note","created_by","domain_id","workspace_id","project_id","created_at"],
+ "title": "NoteInfo"
}
- , "EventQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"event_id" : {"type": "string","title": "EVENT_ID"},"event_key" : {"type": "string","title": "EVENT_KEY"},"event_type" : {"type": "string","title": "EVENT_TYPE"},"severity" : {"type": "string","title": "SEVERITY"},"resource" : {"type": "string","title": "RESOURCE"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"}},
+ , "NoteQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"note_id" : {"type": "string","title": "NOTE_ID"},"alert_id" : {"type": "string","title": "ALERT_ID"},"created_by" : {"type": "string","title": "CREATED_BY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
"type": "object",
"required": [],
- "title": "EventQuery"
+ "title": "NoteQuery"
}
- , "EventStatQuery": {
+ , "NoteRequest": {
+ "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"}},
+ "type": "object",
+ "required": ["note_id"],
+ "title": "NoteRequest"
+ }
+ , "NoteStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "EventStatQuery"
+ "title": "NoteStatQuery"
}
- , "EventsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/EventInfo"},
- "type": "array","$ref": "#/components/schemas/EventInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "NotesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/NoteInfo"},
+ "type": "array","$ref": "#/components/schemas/NoteInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "EventsInfo"
+ "title": "NotesInfo"
}
- , "AlertInfo": {
- "properties" : {"alert_number" : {"type": "integer","title": "ALERT_NUMBER"},"alert_id" : {"type": "string","title": "ALERT_ID"},"title" : {"type": "string","title": "TITLE"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"assignee" : {"type": "string","title": "ASSIGNEE"},"responder" : {"type": "string","title": "RESPONDER"},"urgency" : {"type": "string","title": "URGENCY"},"severity" : {"type": "string","title": "SEVERITY"},"rule" : {"type": "string","title": "RULE"},"image_url" : {"type": "string","title": "IMAGE_URL"},"resources" : {"items": {"$ref": "#/components/schemas/AlertResource"},
- "type": "array","$ref": "#/components/schemas/AlertResource","title": "RESOURCES"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"additional_info" : {"type": "object","title": "ADDITIONAL_INFO"},"escalation_step" : {"type": "integer","title": "ESCALATION_STEP"},"escalation_ttl" : {"type": "integer","title": "ESCALATION_TTL"},"triggered_by" : {"type": "string","title": "TRIGGERED_BY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"},"acknowledged_at" : {"type": "string","title": "ACKNOWLEDGED_AT"},"resolved_at" : {"type": "string","title": "RESOLVED_AT"},"escalated_at" : {"type": "string","title": "ESCALATED_AT"}},
+ , "UpdateNoteRequest": {
+ "properties" : {"note_id" : {"type": "string","title": "NOTE_ID"},"note" : {"type": "string","title": "NOTE"}},
"type": "object",
- "required": ["alert_number","alert_id","title","state","description","assignee","responder","urgency","severity","rule","image_url","resources","provider","account","additional_info","escalation_step","escalation_ttl","triggered_by","domain_id","workspace_id","project_id","webhook_id","escalation_policy_id","created_at","updated_at","acknowledged_at","resolved_at","escalated_at"],
- "title": "AlertInfo"
+ "required": ["note_id"],
+ "title": "UpdateNoteRequest"
}
- , "AlertQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"alert_number" : {"type": "integer","title": "ALERT_NUMBER"},"alert_id" : {"type": "string","title": "ALERT_ID"},"title" : {"type": "string","title": "TITLE"},"state" : {"type": "string","title": "STATE"},"assignee" : {"type": "string","title": "ASSIGNEE"},"responder" : {"type": "string","title": "RESPONDER"},"urgency" : {"type": "string","title": "URGENCY"},"severity" : {"type": "string","title": "SEVERITY"},"resource" : {"type": "string","title": "RESOURCE"},"provider" : {"type": "string","title": "PROVIDER"},"account" : {"type": "string","title": "ACCOUNT"},"triggered_by" : {"type": "string","title": "TRIGGERED_BY"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"webhook_id" : {"type": "string","title": "WEBHOOK_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"}},
+ , "AlertOptions": {
+ "properties" : {"notification_urgency" : {"type": "string","title": "NOTIFICATION_URGENCY"},"recovery_mode" : {"type": "string","title": "RECOVERY_MODE"}},
"type": "object",
- "required": [],
- "title": "AlertQuery"
+ "required": ["notification_urgency","recovery_mode"],
+ "title": "AlertOptions"
}
- , "AlertRequest": {
- "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"}},
+ , "CreateProjectAlertConfigRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"},"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS"}},
"type": "object",
- "required": ["alert_id"],
- "title": "AlertRequest"
+ "required": ["project_id"],
+ "title": "CreateProjectAlertConfigRequest"
}
- , "AlertResource": {
- "properties" : {"resource_id" : {"type": "string","title": "RESOURCE_ID"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"name" : {"type": "string","title": "NAME"}},
+ , "ProjectAlertConfigInfo": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS"},"escalation_policy_info" : {"$ref": "#/components/schemas/EscalationPolicyInfo","title": "ESCALATION_POLICY_INFO"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["resource_id","resource_type","name"],
- "title": "AlertResource"
+ "required": ["project_id","options","escalation_policy_info","domain_id","workspace_id","created_at"],
+ "title": "ProjectAlertConfigInfo"
}
- , "AlertStatQuery": {
+ , "ProjectAlertConfigQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"project_id" : {"type": "string","title": "PROJECT_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "ProjectAlertConfigQuery"
+ }
+ , "ProjectAlertConfigRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ "type": "object",
+ "required": ["project_id"],
+ "title": "ProjectAlertConfigRequest"
+ }
+ , "ProjectAlertConfigStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"}},
"type": "object",
"required": ["query"],
- "title": "AlertStatQuery"
+ "title": "ProjectAlertConfigStatQuery"
}
- , "AlertsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/AlertInfo"},
- "type": "array","$ref": "#/components/schemas/AlertInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "ProjectAlertConfigsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/ProjectAlertConfigInfo"},
+ "type": "array","$ref": "#/components/schemas/ProjectAlertConfigInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "AlertsInfo"
+ "title": "ProjectAlertConfigsInfo"
}
- , "AssignUserRequest": {
- "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"assignee" : {"type": "string","title": "ASSIGNEE"}},
+ , "UpdateProjectAlertConfigRequest": {
+ "properties" : {"project_id" : {"type": "string","title": "PROJECT_ID"},"escalation_policy_id" : {"type": "string","title": "ESCALATION_POLICY_ID"},"options" : {"$ref": "#/components/schemas/AlertOptions","title": "OPTIONS"}},
"type": "object",
- "required": ["alert_id","assignee"],
- "title": "AssignUserRequest"
+ "required": ["project_id"],
+ "title": "UpdateProjectAlertConfigRequest"
}
- , "CreateAlertRequest": {
- "properties" : {"title" : {"type": "string","title": "TITLE"},"description" : {"type": "string","title": "DESCRIPTION"},"assignee" : {"type": "string","title": "ASSIGNEE"},"urgency" : {"type": "string","title": "URGENCY"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "MetricDataInfo": {
+ "properties" : {"labels" : {"type": "array","title": "LABELS"},"values" : {"type": "object","title": "VALUES"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["title","project_id"],
- "title": "CreateAlertRequest"
+ "required": ["labels","values","domain_id"],
+ "title": "MetricDataInfo"
}
- , "UpdateAlertRequest": {
- "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"title" : {"type": "string","title": "TITLE"},"state" : {"type": "string","title": "STATE"},"description" : {"type": "string","title": "DESCRIPTION"},"reset_description" : {"type": "boolean","title": "RESET_DESCRIPTION"},"urgency" : {"type": "string","title": "URGENCY"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
+ , "MetricDataRequest": {
+ "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"metric_query" : {"type": "object","title": "METRIC_QUERY"},"metric" : {"type": "string","title": "METRIC"},"start" : {"type": "string","title": "START"},"end" : {"type": "string","title": "END"},"period" : {"type": "integer","title": "PERIOD"},"stat" : {"type": "string","title": "STAT"}},
"type": "object",
- "required": ["alert_id"],
- "title": "UpdateAlertRequest"
+ "required": ["data_source_id","metric_query","metric","start","end"],
+ "title": "MetricDataRequest"
}
- , "UpdateAlertStateRequest": {
- "properties" : {"alert_id" : {"type": "string","title": "ALERT_ID"},"access_key" : {"type": "string","title": "ACCESS_KEY"},"responder" : {"type": "string","title": "RESPONDER"}},
+ , "MetricInfo": {
+ "properties" : {"key" : {"type": "string","title": "KEY"},"name" : {"type": "string","title": "NAME"},"group" : {"type": "string","title": "GROUP"},"unit" : {"type": "object","title": "UNIT"},"metric_query" : {"type": "object","title": "METRIC_QUERY"}},
"type": "object",
- "required": ["alert_id","access_key"],
- "title": "UpdateAlertStateRequest"
+ "required": ["key","name","group","unit","metric_query"],
+ "title": "MetricInfo"
+ }
+ , "MetricRequest": {
+ "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"resources" : {"items": {"type": "string"},
+ "type": "array","title": "RESOURCES"}},
+ "type": "object",
+ "required": ["data_source_id","resources"],
+ "title": "MetricRequest"
+ }
+ , "MetricsInfo": {
+ "properties" : {"metrics" : {"items": {"$ref": "#/components/schemas/MetricInfo"},
+ "type": "array","$ref": "#/components/schemas/MetricInfo","title": "METRICS"},"available_resources" : {"type": "object","title": "AVAILABLE_RESOURCES"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["metrics","available_resources","domain_id"],
+ "title": "MetricsInfo"
}
, "CreateWebhookRequest": {
"properties" : {"name" : {"type": "string","title": "NAME"},"plugin_info" : {"$ref": "#/components/schemas/WebhookPluginInfo","title": "PLUGIN_INFO"},"tags" : {"type": "object","title": "TAGS"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
@@ -2425,18 +2437,6 @@
"type": "object",
"required": ["results","total_count"],
"title": "WebhooksInfo"
- }
- , "LogDataInfo": {
- "properties" : {"results" : {"type": "array","title": "RESULTS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["results","domain_id"],
- "title": "LogDataInfo"
- }
- , "LogRequest": {
- "properties" : {"data_source_id" : {"type": "string","title": "DATA_SOURCE_ID"},"resource_id" : {"type": "string","title": "RESOURCE_ID"},"keyword" : {"type": "string","title": "KEYWORD"},"start" : {"type": "string","title": "START"},"end" : {"type": "string","title": "END"},"sort" : {"type": "object","title": "SORT"},"limit" : {"type": "integer","title": "LIMIT"}},
- "type": "object",
- "required": ["data_source_id","resource_id"],
- "title": "LogRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/notification/v1/openapi.json b/dist/openapi/cloudforet/api/notification/v1/openapi.json
index 577b59e33..384826e8e 100755
--- a/dist/openapi/cloudforet/api/notification/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/notification/v1/openapi.json
@@ -1083,44 +1083,6 @@
"required": ["results","total_count"],
"title": "UserChannelsInfo"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
@@ -1290,6 +1252,44 @@
"required": ["path","filter"],
"title": "Unwind"
}
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
+ }
, "CreateProjectChannelRequest": {
"properties" : {"protocol_id" : {"type": "string","title": "PROTOCOL_ID"},"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"is_subscribe" : {"type": "boolean","title": "IS_SUBSCRIBE"},"subscriptions" : {"items": {"type": "string"},
"type": "array","title": "SUBSCRIPTIONS"},"notification_level" : {"type": "string","title": "NOTIFICATION_LEVEL"},"is_scheduled" : {"type": "boolean","title": "IS_SCHEDULED"},"schedule" : {"$ref": "#/components/schemas/ProjectChannelSchedule","title": "SCHEDULE"},"tags" : {"type": "object","title": "TAGS"},"project_id" : {"type": "string","title": "PROJECT_ID"}},
diff --git a/dist/openapi/cloudforet/api/plugin/v1/openapi.json b/dist/openapi/cloudforet/api/plugin/v1/openapi.json
index f53c0a76a..62b0ff8ce 100755
--- a/dist/openapi/cloudforet/api/plugin/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/plugin/v1/openapi.json
@@ -41,73 +41,75 @@
},
"components":{
"schemas": {
- "PluginEndpoint": {
- "properties" : {"endpoint" : {"type": "string","title": "ENDPOINT"},"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"updated_version" : {"type": "string","title": "UPDATED_VERSION"}},
+ "PluginInfo": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"state" : {"type": "string","title": "STATE"},"endpoint" : {"type": "string","title": "ENDPOINT"},"managed" : {"type": "boolean","title": "MANAGED"},"endpoints" : {"items": {"type": "string"},
+ "type": "array","title": "ENDPOINTS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"supervisor_name" : {"type": "string","title": "SUPERVISOR_NAME"}},
"type": "object",
- "required": ["endpoint","access_token"],
- "title": "PluginEndpoint"
+ "required": ["plugin_id","version","state","endpoint","managed","endpoints","domain_id","supervisor_id","supervisor_name"],
+ "title": "PluginInfo"
}
- , "PluginEndpointRequest": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"},"labels" : {"type": "object","title": "LABELS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "PluginQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"hostname" : {"type": "string","title": "HOSTNAME"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"state" : {"type": "string","title": "STATE"},"endpoint" : {"type": "string","title": "ENDPOINT"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["plugin_id","domain_id"],
- "title": "PluginEndpointRequest"
+ "required": ["domain_id"],
+ "title": "PluginQuery"
}
- , "PluginFailureRequest": {
- "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"version" : {"type": "string","title": "VERSION"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
+ , "PluginsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PluginInfo"},
+ "type": "array","$ref": "#/components/schemas/PluginInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["supervisor_id","version","domain_id","plugin_id"],
- "title": "PluginFailureRequest"
+ "required": ["results","total_count"],
+ "title": "PluginsInfo"
}
- , "PluginMetadata": {
- "properties" : {"metadata" : {"type": "object","title": "METADATA"}},
+ , "PublishSupervisorRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"hostname" : {"type": "string","title": "HOSTNAME"},"secret_key" : {"type": "string","title": "SECRET_KEY"},"plugin_info" : {"items": {"$ref": "#/components/schemas/PluginInfo"},
+ "type": "array","$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["metadata"],
- "title": "PluginMetadata"
+ "required": ["name","hostname","domain_id"],
+ "title": "PublishSupervisorRequest"
}
- , "PluginMetadataRequest": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"},"options" : {"type": "object","title": "OPTIONS"}},
+ , "RecoverPluginRequest": {
+ "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"version" : {"type": "string","title": "VERSION"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
"type": "object",
- "required": ["plugin_id"],
- "title": "PluginMetadataRequest"
+ "required": ["supervisor_id","version","domain_id","plugin_id"],
+ "title": "RecoverPluginRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "RegisterSupervisorRequest": {
+ "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"name" : {"type": "string","title": "NAME"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"priority" : {"type": "integer","title": "PRIORITY"},"labels" : {"type": "object","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
+ "required": ["supervisor_id","domain_id"],
+ "title": "RegisterSupervisorRequest"
}
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ , "SupervisorInfo": {
+ "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"name" : {"type": "string","title": "NAME"},"hostname" : {"type": "string","title": "HOSTNAME"},"state" : {"type": "string","title": "STATE"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"labels" : {"type": "object","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
+ "required": ["supervisor_id","name","hostname","state","is_public","labels","tags","domain_id","created_at","updated_at"],
+ "title": "SupervisorInfo"
}
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ , "SupervisorQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"name" : {"type": "string","title": "NAME"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
+ "required": ["domain_id"],
+ "title": "SupervisorQuery"
}
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
+ , "SupervisorRequest": {
+ "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
+ "required": ["supervisor_id","domain_id"],
+ "title": "SupervisorRequest"
}
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ , "SupervisorStatQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
+ "required": ["query","domain_id"],
+ "title": "SupervisorStatQuery"
}
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ , "SupervisorsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/SupervisorInfo"},
+ "type": "array","$ref": "#/components/schemas/SupervisorInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
- "required": ["version"],
- "title": "VersionInfo"
+ "required": ["results","total_count"],
+ "title": "SupervisorsInfo"
}
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
@@ -278,75 +280,73 @@
"required": ["path","filter"],
"title": "Unwind"
}
- , "PluginInfo": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"state" : {"type": "string","title": "STATE"},"endpoint" : {"type": "string","title": "ENDPOINT"},"managed" : {"type": "boolean","title": "MANAGED"},"endpoints" : {"items": {"type": "string"},
- "type": "array","title": "ENDPOINTS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"supervisor_name" : {"type": "string","title": "SUPERVISOR_NAME"}},
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["plugin_id","version","state","endpoint","managed","endpoints","domain_id","supervisor_id","supervisor_name"],
- "title": "PluginInfo"
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
}
- , "PluginQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"hostname" : {"type": "string","title": "HOSTNAME"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"state" : {"type": "string","title": "STATE"},"endpoint" : {"type": "string","title": "ENDPOINT"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
"type": "object",
- "required": ["domain_id"],
- "title": "PluginQuery"
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
}
- , "PluginsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PluginInfo"},
- "type": "array","$ref": "#/components/schemas/PluginInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "PluginsInfo"
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
}
- , "PublishSupervisorRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"hostname" : {"type": "string","title": "HOSTNAME"},"secret_key" : {"type": "string","title": "SECRET_KEY"},"plugin_info" : {"items": {"$ref": "#/components/schemas/PluginInfo"},
- "type": "array","$ref": "#/components/schemas/PluginInfo","title": "PLUGIN_INFO"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
"type": "object",
- "required": ["name","hostname","domain_id"],
- "title": "PublishSupervisorRequest"
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
}
- , "RecoverPluginRequest": {
- "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"version" : {"type": "string","title": "VERSION"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
"type": "object",
- "required": ["supervisor_id","version","domain_id","plugin_id"],
- "title": "RecoverPluginRequest"
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
}
- , "RegisterSupervisorRequest": {
- "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"name" : {"type": "string","title": "NAME"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"priority" : {"type": "integer","title": "PRIORITY"},"labels" : {"type": "object","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["supervisor_id","domain_id"],
- "title": "RegisterSupervisorRequest"
+ "required": ["version"],
+ "title": "VersionInfo"
}
- , "SupervisorInfo": {
- "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"name" : {"type": "string","title": "NAME"},"hostname" : {"type": "string","title": "HOSTNAME"},"state" : {"type": "string","title": "STATE"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"labels" : {"type": "object","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ , "PluginEndpoint": {
+ "properties" : {"endpoint" : {"type": "string","title": "ENDPOINT"},"access_token" : {"type": "string","title": "ACCESS_TOKEN"},"updated_version" : {"type": "string","title": "UPDATED_VERSION"}},
"type": "object",
- "required": ["supervisor_id","name","hostname","state","is_public","labels","tags","domain_id","created_at","updated_at"],
- "title": "SupervisorInfo"
+ "required": ["endpoint","access_token"],
+ "title": "PluginEndpoint"
}
- , "SupervisorQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"name" : {"type": "string","title": "NAME"},"is_public" : {"type": "boolean","title": "IS_PUBLIC"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "PluginEndpointRequest": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"},"labels" : {"type": "object","title": "LABELS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["domain_id"],
- "title": "SupervisorQuery"
+ "required": ["plugin_id","domain_id"],
+ "title": "PluginEndpointRequest"
}
- , "SupervisorRequest": {
- "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "PluginFailureRequest": {
+ "properties" : {"supervisor_id" : {"type": "string","title": "SUPERVISOR_ID"},"version" : {"type": "string","title": "VERSION"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
"type": "object",
- "required": ["supervisor_id","domain_id"],
- "title": "SupervisorRequest"
+ "required": ["supervisor_id","version","domain_id","plugin_id"],
+ "title": "PluginFailureRequest"
}
- , "SupervisorStatQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "PluginMetadata": {
+ "properties" : {"metadata" : {"type": "object","title": "METADATA"}},
"type": "object",
- "required": ["query","domain_id"],
- "title": "SupervisorStatQuery"
+ "required": ["metadata"],
+ "title": "PluginMetadata"
}
- , "SupervisorsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/SupervisorInfo"},
- "type": "array","$ref": "#/components/schemas/SupervisorInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "PluginMetadataRequest": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"version" : {"type": "string","title": "VERSION"},"upgrade_mode" : {"type": "string","title": "UPGRADE_MODE"},"options" : {"type": "object","title": "OPTIONS"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "SupervisorsInfo"
+ "required": ["plugin_id"],
+ "title": "PluginMetadataRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/repository/v1/openapi.json b/dist/openapi/cloudforet/api/repository/v1/openapi.json
index 0643d0ade..332211378 100755
--- a/dist/openapi/cloudforet/api/repository/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/repository/v1/openapi.json
@@ -8,20 +8,20 @@
"title": "Repository API",
"version": "3.1.0"
},
- "paths":{"/repository/plugin/register": {
+ "paths":{"/repository/dashboard-template/register": {
"post": {
- "tags": ["repository > plugin"],
+ "tags": ["repository > dashboard-template"],
"summary": "Register",
"operationId" : "",
- "description": "### Description \nRegisters a Plugin. The parameter `registry_type`, meaning container registry type, can be either `DOCKER_HUB` or `AWS_PRIVATE_ECR`. The default value of the `registry_type` is `DOCKER_HUB`. The parameter `registry_url` is required if the `registry_type` is not `DOCKER_HUB`. The parameter `image` is limited to 40 characters.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |resource_type||string|True|\n |image||string|True|\n |provider||string||\n |registry_type|DOCKER_HUB, AWS_PRIVATE_ECR, HARBOR, GITHUB |string||\n |registry_config||Struct||\n |capability||Struct||\n |labels||array||\n |tags||Struct||\n |plugin_id|if plugin_id is not provided, it will be generated by image name |string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |template_id||string||\n |template_type|MULTI, SINGLE |string||\n |dashboards||array||\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"image" : {"type": "string","title": "IMAGE" },"provider" : {"type": "string","title": "PROVIDER" },"registry_type" : {"type": "string","title": "REGISTRY_TYPE" },"registry_config" : {"type": "object","title": "REGISTRY_CONFIG" },"capability" : {"type": "object","title": "CAPABILITY" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" },"name" : {"type": "string","title": "NAME" },"template_type" : {"type": "string","title": "TEMPLATE_TYPE" },"dashboards" : {"type": "array","title": "DASHBOARDS" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"JIRA Software Collector\",\n \"service_type\": \"inventory.Collector\",\n \"image\": \"cloudforet/plugin-jira-noti-protocol\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"provider\": \"jira\",\n \"capability\": {\n \"supported_schema\": [\n \"jira-software-secret-api-token\"\n ]\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n }\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -30,29 +30,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PluginInfo"},
+ "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
- "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/plugin/update": {
+ },"/repository/dashboard-template/update": {
"post": {
- "tags": ["repository > plugin"],
+ "tags": ["repository > dashboard-template"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdates a specific Plugin registered. A Plugin can be updated only if its Repository's `repository_type` is `local`. You can make changes in Plugin settings, including `template` and its options, `schema`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n |name||string||\n |capability||Struct||\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n |name||string||\n |template_type|MULTI, SINGLE |string||\n |dashboards||array||\n |labels||array||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"name" : {"type": "string","title": "NAME" },"capability" : {"type": "object","title": "CAPABILITY" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" },"name" : {"type": "string","title": "NAME" },"template_type" : {"type": "string","title": "TEMPLATE_TYPE" },"dashboards" : {"type": "array","title": "DASHBOARDS" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"JIRA Software Collector\",\n \"capability\": {\n \"supported_schema\": [\n \"jira-software-secret-api-token\"\n ]\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n }\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -61,29 +59,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PluginInfo"},
+ "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
- "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/plugin/deregister": {
+ },"/repository/dashboard-template/deregister": {
"post": {
- "tags": ["repository > plugin"],
+ "tags": ["repository > dashboard-template"],
"summary": "Deregister",
"operationId" : "",
- "description": "### Description \nDeregisters and deletes a specific Plugin. You must specify the `plugin_id` of the Plugin to deregister.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -93,20 +89,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/plugin/enable": {
+ },"/repository/dashboard-template/enable": {
"post": {
- "tags": ["repository > plugin"],
+ "tags": ["repository > dashboard-template"],
"summary": "Enable",
"operationId" : "",
- "description": "### Description \nEnables a specific Plugin. If the Plugin is enabled, the Plugin can be used as its parameter `state` becomes `ENABLED`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -115,29 +111,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PluginInfo"},
+ "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
- "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/plugin/disable": {
+ },"/repository/dashboard-template/disable": {
"post": {
- "tags": ["repository > plugin"],
+ "tags": ["repository > dashboard-template"],
"summary": "Disable",
"operationId" : "",
- "description": "### Description \nDisables a specific Plugin. If the Plugin is disabled, the Plugin cannot be used as its parameter `state` becomes `DISABLED`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
+ "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -146,29 +140,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PluginInfo"},
+ "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
- "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/plugin/get-versions": {
+ },"/repository/dashboard-template/get": {
"post": {
- "tags": ["repository > plugin"],
- "summary": "Get Versions",
+ "tags": ["repository > dashboard-template"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \nGets all version data of a specific Plugin from its Repository. The parameter `plugin_id` is used as an identifier of a Plugin to get version data.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n |repository_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n |repository_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
+ "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -177,29 +169,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/VersionsInfo"},
+ "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/VersionsInfo"},"Default Example":{
- "value": "{\n \"total_count\": 1,\n \"results\": [\n \"1.2.2\",\n \"1.2.1.20220429.104002\",\n \"1.2.1.20220422.161421\",\n \"1.2.1.20220411.113807\",\n \"1.2.1\"\n ]\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/plugin/get": {
+ },"/repository/dashboard-template/list": {
"post": {
- "tags": ["repository > plugin"],
- "summary": "Get",
+ "tags": ["repository > dashboard-template"],
+ "summary": "List",
"operationId" : "",
- "description": "### Description \nGets a specific Plugin. Prints detailed information about the Plugin, including `image`, `registry_url`, and `state`.",
+ "description": "### Description \n",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n |repository_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |template_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |template_type|MULTI, SINGLE |string||\n |repository_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"template_id" : {"type": "string","title": "TEMPLATE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"template_type" : {"type": "string","title": "TEMPLATE_TYPE" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
+ "examples":{"Schema":{}
}
}
},"required": true
@@ -208,27 +198,25 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PluginInfo"},
+ "schema": {"$ref": "#/components/schemas/DashboardTemplatesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
- "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
- }}
+ "Schema": {"$ref": "#/components/schemas/DashboardTemplatesInfo"}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/plugin/list": {
+ },"/repository/repository/list": {
"post": {
- "tags": ["repository > plugin"],
+ "tags": ["repository > repository"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Plugins registered in a specific Repository. The parameter `repository_id` is used as an identifier of a Repository to get its list of Plugins. You can use a query to get a filtered list of Plugins.",
+ "description": "### Description \nGets a list of all Repositories regardless of `domain`. You can use a query to get a filtered list of Repositories.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |plugin_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |resource_type||string||\n |provider||string||\n |registry_type|DOCKER_HUB, AWS_PRIVATE_ECR, HARBOR, GITHUB |string||\n |repository_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |repository_id||string||\n |repository_type||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"registry_type" : {"type": "string","title": "REGISTRY_TYPE" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
+ "properties": {"repository_id" : {"type": "string","title": "REPOSITORY_ID" },"repository_type" : {"type": "string","title": "REPOSITORY_TYPE" } }
},
"examples":{"Default Example":{"value": "{\n \"query\": {},\n \"repository_id\": \"repo-123456789012\"\n}"},"Schema":{}
}
@@ -239,29 +227,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/PluginsInfo"},
+ "schema": {"$ref": "#/components/schemas/RepositoriesInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/PluginsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"plugin_id\": \"plugin-api-direct-mon-webhook\",\n \"name\": \"API Direct Webhook\",\n \"image\": \"pyengine/plugin-api-direct-mon-webhook\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"monitoring.Webhook\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {},\n \"template\": {},\n \"labels\": [],\n \"tags\": {\n \"icon\": \"https://icon-url/icon.svg\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-987654321098\",\n \"created_at\": \"2022-01-01T03:25:10.408Z\",\n \"updated_at\": \"2022-01-01T03:25:10.408Z\"\n },\n {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"name\": \"AWS HyperBilling Cost Analysis Data Source\",\n \"image\": \"pyengine/plugin-aws-hyperbilling-cost-datasource\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"cost_analysis.DataSoruce\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {},\n \"template\": {},\n \"labels\": [],\n \"tags\": {},\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-987654321098\",\n \"created_at\": \"2022-01-01T04:56:55.082Z\",\n \"updated_at\": \"2022-01-01T04:56:55.082Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/RepositoriesInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Open Source Marketplace\",\n \"repository_type\": \"remote\",\n \"endpoint\": \"grpc+ssl://repository.portal.spaceone.megazone.io:443\",\n }\n ],\n \"total_count\": 1\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/dashboard-template/register": {
+ },"/repository/plugin/register": {
"post": {
- "tags": ["repository > dashboard-template"],
+ "tags": ["repository > plugin"],
"summary": "Register",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nRegisters a Plugin. The parameter `registry_type`, meaning container registry type, can be either `DOCKER_HUB` or `AWS_PRIVATE_ECR`. The default value of the `registry_type` is `DOCKER_HUB`. The parameter `registry_url` is required if the `registry_type` is not `DOCKER_HUB`. The parameter `image` is limited to 40 characters.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |template_id||string||\n |template_type|MULTI, SINGLE |string||\n |dashboards||array||\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |resource_type||string|True|\n |image||string|True|\n |docs| {'en': {}, 'ko': {}, 'ja':{}}|Struct|True|\n |provider||string||\n |registry_type|DOCKER_HUB, AWS_PRIVATE_ECR, HARBOR, GITHUB |string||\n |registry_config||Struct||\n |capability||Struct||\n |labels||array||\n |tags||Struct||\n |plugin_id|if plugin_id is not provided, it will be generated by image name |string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" },"name" : {"type": "string","title": "NAME" },"template_type" : {"type": "string","title": "TEMPLATE_TYPE" },"dashboards" : {"type": "array","title": "DASHBOARDS" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"image" : {"type": "string","title": "IMAGE" },"provider" : {"type": "string","title": "PROVIDER" },"registry_type" : {"type": "string","title": "REGISTRY_TYPE" },"registry_config" : {"type": "object","title": "REGISTRY_CONFIG" },"capability" : {"type": "object","title": "CAPABILITY" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"docs" : {"type": "object","title": "DOCS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"JIRA Software Collector\",\n \"service_type\": \"inventory.Collector\",\n \"image\": \"cloudforet/plugin-jira-noti-protocol\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"provider\": \"jira\",\n \"capability\": {\n \"supported_schema\": [\n \"jira-software-secret-api-token\"\n ]\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -270,27 +258,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
+ "schema": {"$ref": "#/components/schemas/PluginInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
+ "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/dashboard-template/update": {
+ },"/repository/plugin/update": {
"post": {
- "tags": ["repository > dashboard-template"],
+ "tags": ["repository > plugin"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nUpdates a specific Plugin registered. A Plugin can be updated only if its Repository's `repository_type` is `local`. You can make changes in Plugin settings, including `template` and its options, `schema`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n |name||string||\n |template_type|MULTI, SINGLE |string||\n |dashboards||array||\n |labels||array||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n |name||string||\n |capability||Struct||\n |labels||array||\n |tags||Struct||\n |docs||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" },"name" : {"type": "string","title": "NAME" },"template_type" : {"type": "string","title": "TEMPLATE_TYPE" },"dashboards" : {"type": "array","title": "DASHBOARDS" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"name" : {"type": "string","title": "NAME" },"capability" : {"type": "object","title": "CAPABILITY" },"labels" : {"type": "array","title": "LABELS" },"tags" : {"type": "object","title": "TAGS" },"docs" : {"type": "object","title": "DOCS" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"JIRA Software Collector\",\n \"capability\": {\n \"supported_schema\": [\n \"jira-software-secret-api-token\"\n ]\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n }\n}"},"Schema":{}
}
}
},"required": true
@@ -299,27 +289,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
+ "schema": {"$ref": "#/components/schemas/PluginInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
+ "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/dashboard-template/deregister": {
+ },"/repository/plugin/deregister": {
"post": {
- "tags": ["repository > dashboard-template"],
+ "tags": ["repository > plugin"],
"summary": "Deregister",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDeregisters and deletes a specific Plugin. You must specify the `plugin_id` of the Plugin to deregister.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" } }
+ "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
}
}
},"required": true
@@ -329,20 +321,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/dashboard-template/enable": {
+ },"/repository/plugin/enable": {
"post": {
- "tags": ["repository > dashboard-template"],
+ "tags": ["repository > plugin"],
"summary": "Enable",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nEnables a specific Plugin. If the Plugin is enabled, the Plugin can be used as its parameter `state` becomes `ENABLED`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" } }
+ "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
}
}
},"required": true
@@ -351,27 +343,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
+ "schema": {"$ref": "#/components/schemas/PluginInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
+ "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/dashboard-template/disable": {
+ },"/repository/plugin/disable": {
"post": {
- "tags": ["repository > dashboard-template"],
+ "tags": ["repository > plugin"],
"summary": "Disable",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nDisables a specific Plugin. If the Plugin is disabled, the Plugin cannot be used as its parameter `state` becomes `DISABLED`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" } }
+ "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
}
}
},"required": true
@@ -380,27 +374,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
+ "schema": {"$ref": "#/components/schemas/PluginInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
+ "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/dashboard-template/get": {
+ },"/repository/plugin/get-versions": {
"post": {
- "tags": ["repository > dashboard-template"],
- "summary": "Get",
+ "tags": ["repository > plugin"],
+ "summary": "Get Versions",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets all version data of a specific Plugin from its Repository. The parameter `plugin_id` is used as an identifier of a Plugin to get version data.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |template_id||string|True|\n |repository_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n |repository_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"template_id" : {"type": "string","title": "TEMPLATE_ID" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
+ "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
}
}
},"required": true
@@ -409,27 +405,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
+ "schema": {"$ref": "#/components/schemas/VersionsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DashboardTemplateInfo"}}
+ "Schema": {"$ref": "#/components/schemas/VersionsInfo"},"Default Example":{
+ "value": "{\n \"total_count\": 1,\n \"results\": [\n \"1.2.2\",\n \"1.2.1.20220429.104002\",\n \"1.2.1.20220422.161421\",\n \"1.2.1.20220411.113807\",\n \"1.2.1\"\n ]\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/dashboard-template/list": {
+ },"/repository/plugin/get": {
"post": {
- "tags": ["repository > dashboard-template"],
- "summary": "List",
+ "tags": ["repository > plugin"],
+ "summary": "Get",
"operationId" : "",
- "description": "### Description \n",
+ "description": "### Description \nGets a specific Plugin. Prints detailed information about the Plugin, including `image`, `registry_url`, and `state`.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |template_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |template_type|MULTI, SINGLE |string||\n |repository_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |plugin_id||string|True|\n |repository_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"template_id" : {"type": "string","title": "TEMPLATE_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"template_type" : {"type": "string","title": "TEMPLATE_TYPE" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
+ "properties": {"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
},
- "examples":{"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"plugin_id\": \"plugin-aws-sns-mon-webhook\",\n}"},"Schema":{}
}
}
},"required": true
@@ -438,25 +436,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/DashboardTemplatesInfo"},
+ "schema": {"$ref": "#/components/schemas/PluginInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/DashboardTemplatesInfo"}}
+ "Schema": {"$ref": "#/components/schemas/PluginInfo"},"Default Example":{
+ "value": "{\n \"plugin_id\": \"plugin-jira-noti-protocol\",\n \"name\": \"JIRA Issue notification\",\n \"image\": \"pyengine/plugin-jira-noti-protocol\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"notification.Procotol\",\n \"provider\": \"atlassian\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {\n \"supported_schema\": [\n \"atlassian_jira\"\n ]\n },\n \"template\": {\n \"options\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\",\n \"title\": \"Project ID\",\n \"minLength\": 4.0\n },\n \"sa_name\": {\n \"title\": \"Service Account\",\n \"type\": \"string\",\n \"minLength\": 4.0\n }\n }\n }\n }\n },\n \"labels\": [\n \"jira\",\n \"atlassian\",\n \"notification\"\n ],\n \"tags\": {\n \"description\": \"Atlassian JIRA Issue notification\",\n \"icon\": \"https://icon-path/jira-icon.png\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T08:02:38.094Z\",\n \"updated_at\": \"2022-01-01T08:02:38.094Z\"\n}"
+ }}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/repository/repository/list": {
+ },"/repository/plugin/list": {
"post": {
- "tags": ["repository > repository"],
+ "tags": ["repository > plugin"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nGets a list of all Repositories regardless of `domain`. You can use a query to get a filtered list of Repositories.",
+ "description": "### Description \nGets a list of all Plugins registered in a specific Repository. The parameter `repository_id` is used as an identifier of a Repository to get its list of Plugins. You can use a query to get a filtered list of Plugins.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |repository_id||string||\n |repository_type||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |plugin_id||string||\n |name||string||\n |state|ENABLED, DISABLED |string||\n |resource_type||string||\n |provider||string||\n |registry_type|DOCKER_HUB, AWS_PRIVATE_ECR, HARBOR, GITHUB |string||\n |repository_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"repository_id" : {"type": "string","title": "REPOSITORY_ID" },"repository_type" : {"type": "string","title": "REPOSITORY_TYPE" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"plugin_id" : {"type": "string","title": "PLUGIN_ID" },"name" : {"type": "string","title": "NAME" },"state" : {"type": "string","title": "STATE" },"resource_type" : {"type": "string","title": "RESOURCE_TYPE" },"provider" : {"type": "string","title": "PROVIDER" },"registry_type" : {"type": "string","title": "REGISTRY_TYPE" },"repository_id" : {"type": "string","title": "REPOSITORY_ID" } }
},
"examples":{"Default Example":{"value": "{\n \"query\": {},\n \"repository_id\": \"repo-123456789012\"\n}"},"Schema":{}
}
@@ -467,10 +467,10 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/RepositoriesInfo"},
+ "schema": {"$ref": "#/components/schemas/PluginsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/RepositoriesInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Open Source Marketplace\",\n \"repository_type\": \"remote\",\n \"endpoint\": \"grpc+ssl://repository.portal.spaceone.megazone.io:443\",\n }\n ],\n \"total_count\": 1\n}"
+ "Schema": {"$ref": "#/components/schemas/PluginsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"plugin_id\": \"plugin-api-direct-mon-webhook\",\n \"name\": \"API Direct Webhook\",\n \"image\": \"pyengine/plugin-api-direct-mon-webhook\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"monitoring.Webhook\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {},\n \"template\": {},\n \"labels\": [],\n \"tags\": {\n \"icon\": \"https://icon-url/icon.svg\"\n },\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-987654321098\",\n \"created_at\": \"2022-01-01T03:25:10.408Z\",\n \"updated_at\": \"2022-01-01T03:25:10.408Z\"\n },\n {\n \"plugin_id\": \"plugin-aws-hyperbilling-cost-datasource\",\n \"name\": \"AWS HyperBilling Cost Analysis Data Source\",\n \"image\": \"pyengine/plugin-aws-hyperbilling-cost-datasource\",\n \"registry_url\": \"registry.hub.docker.com\",\n \"state\": \"ENABLED\",\n \"service_type\": \"cost_analysis.DataSoruce\",\n \"registry_type\": \"DOCKER_HUB\",\n \"registry_config\": {},\n \"capability\": {},\n \"template\": {},\n \"labels\": [],\n \"tags\": {},\n \"repository_info\": {\n \"repository_id\": \"repo-123456789012\",\n \"name\": \"Marketplace\",\n \"repository_type\": \"remote\"\n },\n \"domain_id\": \"domain-987654321098\",\n \"created_at\": \"2022-01-01T04:56:55.082Z\",\n \"updated_at\": \"2022-01-01T04:56:55.082Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
@@ -480,94 +480,48 @@
},
"components":{
"schemas": {
- "PluginInfo": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"image" : {"type": "string","title": "IMAGE"},"provider" : {"type": "string","title": "PROVIDER"},"registry_type" : {"type": "string","title": "REGISTRY_TYPE"},"registry_url" : {"type": "string","title": "REGISTRY_URL"},"registry_config" : {"type": "object","title": "REGISTRY_CONFIG"},"capability" : {"type": "object","title": "CAPABILITY"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"repository_info" : {"$ref": "#/components/schemas/RepositoryInfo","title": "REPOSITORY_INFO"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "DashboardTemplateInfo": {
+ "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"dashboards" : {"type": "array","title": "DASHBOARDS"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"repository_info" : {"$ref": "#/components/schemas/RepositoryInfo","title": "REPOSITORY_INFO"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
"type": "object",
- "required": ["plugin_id","name","state","resource_type","image","provider","registry_type","registry_url","registry_config","capability","labels","tags","domain_id","repository_info","created_at","updated_at"],
- "title": "PluginInfo"
+ "required": ["template_id","name","state","template_type","dashboards","labels","tags","domain_id","repository_info","created_at","updated_at"],
+ "title": "DashboardTemplateInfo"
}
- , "PluginQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"registry_type" : {"type": "string","title": "REGISTRY_TYPE"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
+ , "DashboardTemplateQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
"type": "object",
"required": [],
- "title": "PluginQuery"
+ "title": "DashboardTemplateQuery"
}
- , "PluginRequest": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
+ , "DashboardTemplateRequest": {
+ "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"}},
"type": "object",
- "required": ["plugin_id"],
- "title": "PluginRequest"
+ "required": ["template_id"],
+ "title": "DashboardTemplateRequest"
}
- , "PluginsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PluginInfo"},
- "type": "array","$ref": "#/components/schemas/PluginInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "DashboardTemplatesInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
+ "type": "array","$ref": "#/components/schemas/DashboardTemplateInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "PluginsInfo"
- }
- , "RegisterPluginRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"image" : {"type": "string","title": "IMAGE"},"provider" : {"type": "string","title": "PROVIDER"},"registry_type" : {"type": "string","title": "REGISTRY_TYPE"},"registry_config" : {"type": "object","title": "REGISTRY_CONFIG"},"capability" : {"type": "object","title": "CAPABILITY"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
- "type": "object",
- "required": ["name","resource_type","image"],
- "title": "RegisterPluginRequest"
- }
- , "RepositoryPluginRequest": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
- "type": "object",
- "required": ["plugin_id"],
- "title": "RepositoryPluginRequest"
- }
- , "UpdatePluginRequest": {
- "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"name" : {"type": "string","title": "NAME"},"capability" : {"type": "object","title": "CAPABILITY"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["plugin_id"],
- "title": "UpdatePluginRequest"
- }
- , "VersionsInfo": {
- "properties" : {"version" : {"items": {"type": "string"},
- "type": "array","title": "VERSION"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"},"results" : {"items": {"type": "string"},
- "type": "array","title": "RESULTS"}},
- "type": "object",
- "required": ["version","total_count","results"],
- "title": "VersionsInfo"
- }
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
+ "title": "DashboardTemplatesInfo"
}
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
+ , "RegisterDashboardTemplateRequest": {
+ "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"dashboards" : {"type": "array","title": "DASHBOARDS"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
+ "required": ["name"],
+ "title": "RegisterDashboardTemplateRequest"
}
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ , "RepositoryDashboardTemplateRequest": {
+ "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
"type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
+ "required": ["template_id"],
+ "title": "RepositoryDashboardTemplateRequest"
}
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ , "UpdateDashboardTemplateRequest": {
+ "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"dashboards" : {"type": "array","title": "DASHBOARDS"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["version"],
- "title": "VersionInfo"
+ "required": ["template_id"],
+ "title": "UpdateDashboardTemplateRequest"
}
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
@@ -738,48 +692,43 @@
"required": ["path","filter"],
"title": "Unwind"
}
- , "DashboardTemplateInfo": {
- "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"dashboards" : {"type": "array","title": "DASHBOARDS"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"repository_info" : {"$ref": "#/components/schemas/RepositoryInfo","title": "REPOSITORY_INFO"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
- "type": "object",
- "required": ["template_id","name","state","template_type","dashboards","labels","tags","domain_id","repository_info","created_at","updated_at"],
- "title": "DashboardTemplateInfo"
- }
- , "DashboardTemplateQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": [],
- "title": "DashboardTemplateQuery"
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
}
- , "DashboardTemplateRequest": {
- "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"}},
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
"type": "object",
- "required": ["template_id"],
- "title": "DashboardTemplateRequest"
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
}
- , "DashboardTemplatesInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/DashboardTemplateInfo"},
- "type": "array","$ref": "#/components/schemas/DashboardTemplateInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
"type": "object",
- "required": ["results","total_count"],
- "title": "DashboardTemplatesInfo"
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
}
- , "RegisterDashboardTemplateRequest": {
- "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"dashboards" : {"type": "array","title": "DASHBOARDS"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
"type": "object",
- "required": ["name"],
- "title": "RegisterDashboardTemplateRequest"
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
}
- , "RepositoryDashboardTemplateRequest": {
- "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
"type": "object",
- "required": ["template_id"],
- "title": "RepositoryDashboardTemplateRequest"
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
}
- , "UpdateDashboardTemplateRequest": {
- "properties" : {"template_id" : {"type": "string","title": "TEMPLATE_ID"},"name" : {"type": "string","title": "NAME"},"template_type" : {"type": "string","title": "TEMPLATE_TYPE"},"dashboards" : {"type": "array","title": "DASHBOARDS"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"}},
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
"type": "object",
- "required": ["template_id"],
- "title": "UpdateDashboardTemplateRequest"
+ "required": ["version"],
+ "title": "VersionInfo"
}
, "RepositoriesInfo": {
"properties" : {"results" : {"items": {"$ref": "#/components/schemas/RepositoryInfo"},
@@ -799,6 +748,57 @@
"type": "object",
"required": [],
"title": "RepositoryQuery"
+ }
+ , "PluginInfo": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"image" : {"type": "string","title": "IMAGE"},"provider" : {"type": "string","title": "PROVIDER"},"registry_type" : {"type": "string","title": "REGISTRY_TYPE"},"registry_url" : {"type": "string","title": "REGISTRY_URL"},"registry_config" : {"type": "object","title": "REGISTRY_CONFIG"},"capability" : {"type": "object","title": "CAPABILITY"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"docs" : {"type": "object","title": "DOCS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"repository_info" : {"$ref": "#/components/schemas/RepositoryInfo","title": "REPOSITORY_INFO"},"created_at" : {"type": "string","title": "CREATED_AT"},"updated_at" : {"type": "string","title": "UPDATED_AT"}},
+ "type": "object",
+ "required": ["plugin_id","name","state","resource_type","image","provider","registry_type","registry_url","registry_config","capability","labels","tags","docs","domain_id","repository_info","created_at","updated_at"],
+ "title": "PluginInfo"
+ }
+ , "PluginQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"name" : {"type": "string","title": "NAME"},"state" : {"type": "string","title": "STATE"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"provider" : {"type": "string","title": "PROVIDER"},"registry_type" : {"type": "string","title": "REGISTRY_TYPE"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
+ "type": "object",
+ "required": [],
+ "title": "PluginQuery"
+ }
+ , "PluginRequest": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"}},
+ "type": "object",
+ "required": ["plugin_id"],
+ "title": "PluginRequest"
+ }
+ , "PluginsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/PluginInfo"},
+ "type": "array","$ref": "#/components/schemas/PluginInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "PluginsInfo"
+ }
+ , "RegisterPluginRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"resource_type" : {"type": "string","title": "RESOURCE_TYPE"},"image" : {"type": "string","title": "IMAGE"},"provider" : {"type": "string","title": "PROVIDER"},"registry_type" : {"type": "string","title": "REGISTRY_TYPE"},"registry_config" : {"type": "object","title": "REGISTRY_CONFIG"},"capability" : {"type": "object","title": "CAPABILITY"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"docs" : {"type": "object","title": "DOCS"}},
+ "type": "object",
+ "required": ["name","resource_type","image","docs"],
+ "title": "RegisterPluginRequest"
+ }
+ , "RepositoryPluginRequest": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"repository_id" : {"type": "string","title": "REPOSITORY_ID"}},
+ "type": "object",
+ "required": ["plugin_id"],
+ "title": "RepositoryPluginRequest"
+ }
+ , "UpdatePluginRequest": {
+ "properties" : {"plugin_id" : {"type": "string","title": "PLUGIN_ID"},"name" : {"type": "string","title": "NAME"},"capability" : {"type": "object","title": "CAPABILITY"},"labels" : {"type": "array","title": "LABELS"},"tags" : {"type": "object","title": "TAGS"},"docs" : {"type": "object","title": "DOCS"}},
+ "type": "object",
+ "required": ["plugin_id"],
+ "title": "UpdatePluginRequest"
+ }
+ , "VersionsInfo": {
+ "properties" : {"version" : {"items": {"type": "string"},
+ "type": "array","title": "VERSION"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"},"results" : {"items": {"type": "string"},
+ "type": "array","title": "RESULTS"}},
+ "type": "object",
+ "required": ["version","total_count","results"],
+ "title": "VersionsInfo"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/search/v1/openapi.json b/dist/openapi/cloudforet/api/search/v1/openapi.json
index f96a32db4..f1f2cdd9f 100755
--- a/dist/openapi/cloudforet/api/search/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/search/v1/openapi.json
@@ -61,44 +61,6 @@
"required": ["resource_type"],
"title": "SearchResourceRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
@@ -267,6 +229,44 @@
"type": "object",
"required": ["path","filter"],
"title": "Unwind"
+ }
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/secret/v1/openapi.json b/dist/openapi/cloudforet/api/secret/v1/openapi.json
index 393ef1228..12c8c7441 100755
--- a/dist/openapi/cloudforet/api/secret/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/secret/v1/openapi.json
@@ -8,20 +8,20 @@
"title": "Secret API",
"version": "3.1.0"
},
- "paths":{"/secret/trusted-secret/create": {
+ "paths":{"/secret/user-secret/create": {
"post": {
- "tags": ["secret > trusted-secret"],
+ "tags": ["secret > user-secret"],
"summary": "Create",
"operationId" : "",
- "description": "### Description \nCreate a new trusted secret.\nCreated trusted secret is encrypted and stored securely.",
+ "description": "### Description \nCreate a new user secret.\nCreated user secret is encrypted and stored securely.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data||Struct|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |schema_id||string||\n |tags||Struct||\n |workspace_id||string||\n |trusted_account_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data||Struct|True|\n |schema_id||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"Cloudforet Broker Account - Managed\",\n \"data\": \"********\",\n \"schema_id\": \"aws_access_key\",\n \"trusted_account_id\": \"trusted-sa-123456789012\",\n \"tags\": {}\n \"resource_group\": \"DOMAIN\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"Cloudforet AWS Dev\",\n \"data\": \"********\",\n \"schema_id\": \"aws_access_key\",\n}"},"Schema":{}
}
}
},"required": true
@@ -30,29 +30,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},
+ "schema": {"$ref": "#/components/schemas/UserSecretInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},"Default Example":{
- "value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/UserSecretInfo"},"Default Example":{
+ "value": "{\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema_id\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/trusted-secret/update": {
+ },"/secret/user-secret/update": {
"post": {
- "tags": ["secret > trusted-secret"],
+ "tags": ["secret > user-secret"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdates a specific trusted secret's information.\nYou can only change the 'name' and 'tags', and to change the data you must use the update_data API.",
+ "description": "### Description \nUpdates a specific user secret's information.\nYou can only change the 'name' and 'tags', and to change the data you must use the update_data API.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev2\",\n \"tags\": { \"a\": \"b\"}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\",\n \"name\": \"aws-dev2\",\n \"tags\": { \"a\": \"b\"}\n}"},"Schema":{}
}
}
},"required": true
@@ -61,29 +61,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},
+ "schema": {"$ref": "#/components/schemas/UserSecretInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},"Default Example":{
- "value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/UserSecretInfo"},"Default Example":{
+ "value": "{\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema_id\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/trusted-secret/delete": {
+ },"/secret/user-secret/delete": {
"post": {
- "tags": ["secret > trusted-secret"],
+ "tags": ["secret > user-secret"],
"summary": "Delete",
"operationId" : "",
- "description": "### Description \nDeletes a specific trusted secret.\nIf a trusted secret is attached to a Secret, it cannot be deleted.",
+ "description": "### Description \nDeletes a specific user secret.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" } }
+ "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -93,20 +93,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/trusted-secret/update-data": {
+ },"/secret/user-secret/update-data": {
"post": {
- "tags": ["secret > trusted-secret"],
+ "tags": ["secret > user-secret"],
"summary": "Update Data",
"operationId" : "",
- "description": "### Description \nUpdates a specific trusted secret's data.\nUpdated trusted secret is encrypted and stored securely.",
+ "description": "### Description \nUpdates a specific user secret's data.\nUpdated user_secret is encrypted and stored securely.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n |schema_id||string|True|\n |data||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n |schema_id||string|True|\n |data||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"data" : {"type": "object","title": "DATA" } }
+ "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"data" : {"type": "object","title": "DATA" } }
},
- "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-12345abcde\",\n \"data\": \"********\",\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\",\n \"data\": \"********\"\n}"},"Schema":{}
}
}
},"required": true
@@ -116,20 +116,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/trusted-secret/get": {
+ },"/secret/user-secret/get": {
"post": {
- "tags": ["secret > trusted-secret"],
+ "tags": ["secret > user-secret"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGet a specific trusted secret's information.",
+ "description": "### Description \nGet a specific user secret's information.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" } }
+ "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -138,27 +138,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},
+ "schema": {"$ref": "#/components/schemas/UserSecretInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},"Default Example":{
- "value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/UserSecretInfo"},"Default Example":{
+ "value": "{\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema_id\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/trusted-secret/list": {
+ },"/secret/user-secret/list": {
"post": {
- "tags": ["secret > trusted-secret"],
+ "tags": ["secret > user-secret"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nQueries a list of trusted secrets.\nYou can use a query to get a filtered list of trusted secrets.",
+ "description": "### Description \nQueries a list of user secrets.\nYou can use a query to get a filtered list of user secrets.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |trusted_secret_id||string||\n |name||string||\n |schema_id||string||\n |provider||string||\n |workspace_id||string||\n |trusted_account_id||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_secret_id||string||\n |name||string||\n |schema_id||string||\n |provider||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"provider" : {"type": "string","title": "PROVIDER" } }
},
"examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
@@ -169,18 +169,18 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/TrustedSecretsInfo"},
+ "schema": {"$ref": "#/components/schemas/UserSecretsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/TrustedSecretsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"trusted_secret_id\": \"trusted-secret-12345abcde\",\n \"name\": \"Cloudforet Broker Account - Managed\",\n \"schema_id\": \"aws-secret-access-key\",\n \"tags\": {\"foo\": \"bar\"},\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-12345abcde\",\n \"domain_id\": \"domain-12345abcde\",\n \"created_at\": \"2022-01-01T06:10:14Z\"\n },\n {\n \"trusted_secret_id\": \"trusted-secret-56789abcde\",\n \"name\": \"Customer Broker Account\",\n \"schema_id\": \"aws-secret-access-key\",\n \"provider\": \"aws\",\n \"resource_group\": \"WORKSPACE\",\n \"trusted_account_id\": \"ta-56789abcde\",\n \"domain_id\": \"domain-12345abcde\",\n \"workspace_id\": \"workspace-12345abcde\",\n \"created_at\": \"2023-11-04T00:00:00Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/UserSecretsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n },\n {\n \"user_secret_id\": \"user_secret-987654321098\",\n \"name\": \"plugin-credentials\",\n \"tags\": {},\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T02:31:01.709Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/trusted-secret/stat": {
+ },"/secret/user-secret/stat": {
"post": {
- "tags": ["secret > trusted-secret"],
+ "tags": ["secret > user-secret"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -468,20 +468,20 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/user-secret/create": {
+ },"/secret/trusted-secret/create": {
"post": {
- "tags": ["secret > user-secret"],
+ "tags": ["secret > trusted-secret"],
"summary": "Create",
"operationId" : "",
- "description": "### Description \nCreate a new user secret.\nCreated user secret is encrypted and stored securely.",
+ "description": "### Description \nCreate a new trusted secret.\nCreated trusted secret is encrypted and stored securely.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data||Struct|True|\n |schema_id||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |name||string|True|\n |data||Struct|True|\n |resource_group|DOMAIN, WORKSPACE |string|True|\n |schema_id||string||\n |tags||Struct||\n |workspace_id||string||\n |trusted_account_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"name" : {"type": "string","title": "NAME" },"data" : {"type": "object","title": "DATA" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"tags" : {"type": "object","title": "TAGS" },"resource_group" : {"type": "string","title": "RESOURCE_GROUP" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"name\": \"Cloudforet AWS Dev\",\n \"data\": \"********\",\n \"schema_id\": \"aws_access_key\",\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"name\": \"Cloudforet Broker Account - Managed\",\n \"data\": \"********\",\n \"schema_id\": \"aws_access_key\",\n \"trusted_account_id\": \"trusted-sa-123456789012\",\n \"tags\": {}\n \"resource_group\": \"DOMAIN\"\n}"},"Schema":{}
}
}
},"required": true
@@ -490,29 +490,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserSecretInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserSecretInfo"},"Default Example":{
- "value": "{\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema_id\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},"Default Example":{
+ "value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/user-secret/update": {
+ },"/secret/trusted-secret/update": {
"post": {
- "tags": ["secret > user-secret"],
+ "tags": ["secret > trusted-secret"],
"summary": "Update",
"operationId" : "",
- "description": "### Description \nUpdates a specific user secret's information.\nYou can only change the 'name' and 'tags', and to change the data you must use the update_data API.",
+ "description": "### Description \nUpdates a specific trusted secret's information.\nYou can only change the 'name' and 'tags', and to change the data you must use the update_data API.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n |name||string||\n |tags||Struct||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n |name||string||\n |tags||Struct||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
+ "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"tags" : {"type": "object","title": "TAGS" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\",\n \"name\": \"aws-dev2\",\n \"tags\": { \"a\": \"b\"}\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev2\",\n \"tags\": { \"a\": \"b\"}\n}"},"Schema":{}
}
}
},"required": true
@@ -521,29 +521,29 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserSecretInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserSecretInfo"},"Default Example":{
- "value": "{\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema_id\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},"Default Example":{
+ "value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/user-secret/delete": {
+ },"/secret/trusted-secret/delete": {
"post": {
- "tags": ["secret > user-secret"],
+ "tags": ["secret > trusted-secret"],
"summary": "Delete",
"operationId" : "",
- "description": "### Description \nDeletes a specific user secret.",
+ "description": "### Description \nDeletes a specific trusted secret.\nIf a trusted secret is attached to a Secret, it cannot be deleted.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" } }
+ "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -553,20 +553,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/user-secret/update-data": {
+ },"/secret/trusted-secret/update-data": {
"post": {
- "tags": ["secret > user-secret"],
+ "tags": ["secret > trusted-secret"],
"summary": "Update Data",
"operationId" : "",
- "description": "### Description \nUpdates a specific user secret's data.\nUpdated user_secret is encrypted and stored securely.",
+ "description": "### Description \nUpdates a specific trusted secret's data.\nUpdated trusted secret is encrypted and stored securely.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n |schema_id||string|True|\n |data||Struct|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n |schema_id||string|True|\n |data||Struct|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"data" : {"type": "object","title": "DATA" } }
+ "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"data" : {"type": "object","title": "DATA" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\",\n \"data\": \"********\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-12345abcde\",\n \"data\": \"********\",\n}"},"Schema":{}
}
}
},"required": true
@@ -576,20 +576,20 @@
"description": "Successfull Response"}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/user-secret/get": {
+ },"/secret/trusted-secret/get": {
"post": {
- "tags": ["secret > user-secret"],
+ "tags": ["secret > trusted-secret"],
"summary": "Get",
"operationId" : "",
- "description": "### Description \nGet a specific user secret's information.",
+ "description": "### Description \nGet a specific trusted secret's information.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |user_secret_id||string|True|\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |trusted_secret_id||string|True|\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" } }
+ "properties": {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" } }
},
- "examples":{"Default Example":{"value": "{\n \"user_secret_id\": \"user-secret-123456789012\"\n}"},"Schema":{}
+ "examples":{"Default Example":{"value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\"\n}"},"Schema":{}
}
}
},"required": true
@@ -598,27 +598,27 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserSecretInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserSecretInfo"},"Default Example":{
- "value": "{\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema_id\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
+ "Schema": {"$ref": "#/components/schemas/TrustedSecretInfo"},"Default Example":{
+ "value": "{\n \"trusted_secret_id\": \"trusted-secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-123456789012\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/user-secret/list": {
+ },"/secret/trusted-secret/list": {
"post": {
- "tags": ["secret > user-secret"],
+ "tags": ["secret > trusted-secret"],
"summary": "List",
"operationId" : "",
- "description": "### Description \nQueries a list of user secrets.\nYou can use a query to get a filtered list of user secrets.",
+ "description": "### Description \nQueries a list of trusted secrets.\nYou can use a query to get a filtered list of trusted secrets.",
"requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |user_secret_id||string||\n |name||string||\n |schema_id||string||\n |provider||string||\n
",
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |query||Query||\n |trusted_secret_id||string||\n |name||string||\n |schema_id||string||\n |provider||string||\n |workspace_id||string||\n |trusted_account_id||string||\n
",
"content": {
"application/json": {
"schema": {
- "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"user_secret_id" : {"type": "string","title": "USER_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"provider" : {"type": "string","title": "PROVIDER" } }
+ "properties": {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY" },"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID" },"name" : {"type": "string","title": "NAME" },"schema_id" : {"type": "string","title": "SCHEMA_ID" },"provider" : {"type": "string","title": "PROVIDER" },"workspace_id" : {"type": "string","title": "WORKSPACE_ID" },"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID" } }
},
"examples":{"Default Example":{"value": "{\n \"query\": {}\n}"},"Schema":{}
}
@@ -629,18 +629,18 @@
"200": {
"description": "Successfull Response","content":{
"application/json": {
- "schema": {"$ref": "#/components/schemas/UserSecretsInfo"},
+ "schema": {"$ref": "#/components/schemas/TrustedSecretsInfo"},
"examples": {
- "Schema": {"$ref": "#/components/schemas/UserSecretsInfo"},"Default Example":{
- "value": "{\n \"results\": [\n {\n \"user_secret_id\": \"user_secret-123456789012\",\n \"name\": \"aws-dev\",\n \"tags\": {},\n \"schema\": \"aws_access_key\",\n \"provider\": \"aws\",\n \"user_id\": \"whdalsrnt@gmail\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T06:10:14.851Z\"\n },\n {\n \"user_secret_id\": \"user_secret-987654321098\",\n \"name\": \"plugin-credentials\",\n \"tags\": {},\n \"user_id\": \"whdalsrnt@gmail.com\",\n \"domain_id\": \"domain-123456789012\",\n \"created_at\": \"2022-01-01T02:31:01.709Z\"\n }\n ],\n \"total_count\": 2\n}"
+ "Schema": {"$ref": "#/components/schemas/TrustedSecretsInfo"},"Default Example":{
+ "value": "{\n \"results\": [\n {\n \"trusted_secret_id\": \"trusted-secret-12345abcde\",\n \"name\": \"Cloudforet Broker Account - Managed\",\n \"schema_id\": \"aws-secret-access-key\",\n \"tags\": {\"foo\": \"bar\"},\n \"provider\": \"aws\",\n \"resource_group\": \"DOMAIN\",\n \"trusted_account_id\": \"ta-12345abcde\",\n \"domain_id\": \"domain-12345abcde\",\n \"created_at\": \"2022-01-01T06:10:14Z\"\n },\n {\n \"trusted_secret_id\": \"trusted-secret-56789abcde\",\n \"name\": \"Customer Broker Account\",\n \"schema_id\": \"aws-secret-access-key\",\n \"provider\": \"aws\",\n \"resource_group\": \"WORKSPACE\",\n \"trusted_account_id\": \"ta-56789abcde\",\n \"domain_id\": \"domain-12345abcde\",\n \"workspace_id\": \"workspace-12345abcde\",\n \"created_at\": \"2023-11-04T00:00:00Z\"\n }\n ],\n \"total_count\": 2\n}"
}}
}
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/secret/user-secret/stat": {
+ },"/secret/trusted-secret/stat": {
"post": {
- "tags": ["secret > user-secret"],
+ "tags": ["secret > trusted-secret"],
"summary": "Stat",
"operationId" : "",
"description": "### Description \n",
@@ -671,104 +671,66 @@
},
"components":{
"schemas": {
- "CreateTrustedSecretRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
+ "CreateUserSecretRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"tags" : {"type": "object","title": "TAGS"}},
"type": "object",
- "required": ["name","data","resource_group"],
- "title": "CreateTrustedSecretRequest"
+ "required": ["name","data"],
+ "title": "CreateUserSecretRequest"
}
- , "GetTrustedSecretDataRequest": {
- "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ , "GetUserSecretDataRequest": {
+ "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["trusted_secret_id","domain_id"],
- "title": "GetTrustedSecretDataRequest"
+ "required": ["user_secret_id","domain_id"],
+ "title": "GetUserSecretDataRequest"
}
- , "TrustedSecretDataInfo": {
+ , "UpdateUserSecretDataRequest": {
+ "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"data" : {"type": "object","title": "DATA"}},
+ "type": "object",
+ "required": ["user_secret_id","schema_id","data"],
+ "title": "UpdateUserSecretDataRequest"
+ }
+ , "UpdateUserSecretRequest": {
+ "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["user_secret_id"],
+ "title": "UpdateUserSecretRequest"
+ }
+ , "UserSecretDataInfo": {
"properties" : {"encrypted" : {"type": "boolean","title": "ENCRYPTED"},"encrypt_options" : {"type": "object","title": "ENCRYPT_OPTIONS"},"data" : {"type": "object","title": "DATA"}},
"type": "object",
"required": ["encrypted","encrypt_options","data"],
- "title": "TrustedSecretDataInfo"
+ "title": "UserSecretDataInfo"
}
- , "TrustedSecretInfo": {
- "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"tags" : {"type": "object","title": "TAGS"},"provider" : {"type": "string","title": "PROVIDER"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "UserSecretInfo": {
+ "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["trusted_secret_id","name","schema_id","tags","provider","resource_group","domain_id","workspace_id","trusted_account_id","created_at"],
- "title": "TrustedSecretInfo"
+ "required": ["user_secret_id","name","schema_id","provider","tags","domain_id","user_id","created_at"],
+ "title": "UserSecretInfo"
}
- , "TrustedSecretQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
+ , "UserSecretQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"provider" : {"type": "string","title": "PROVIDER"}},
"type": "object",
"required": [],
- "title": "TrustedSecretQuery"
+ "title": "UserSecretQuery"
}
- , "TrustedSecretRequest": {
- "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"}},
+ , "UserSecretRequest": {
+ "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"}},
"type": "object",
- "required": ["trusted_secret_id"],
- "title": "TrustedSecretRequest"
+ "required": ["user_secret_id"],
+ "title": "UserSecretRequest"
}
- , "TrustedSecretStatQuery": {
+ , "UserSecretStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
"required": ["query","domain_id"],
- "title": "TrustedSecretStatQuery"
+ "title": "UserSecretStatQuery"
}
- , "TrustedSecretsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/TrustedSecretInfo"},
- "type": "array","$ref": "#/components/schemas/TrustedSecretInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "UserSecretsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserSecretInfo"},
+ "type": "array","$ref": "#/components/schemas/UserSecretInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "TrustedSecretsInfo"
- }
- , "UpdateTrustedSecretDataRequest": {
- "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"data" : {"type": "object","title": "DATA"}},
- "type": "object",
- "required": ["trusted_secret_id","schema_id","data"],
- "title": "UpdateTrustedSecretDataRequest"
- }
- , "UpdateTrustedSecretRequest": {
- "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["trusted_secret_id"],
- "title": "UpdateTrustedSecretRequest"
- }
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
+ "title": "UserSecretsInfo"
}
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
@@ -939,6 +901,44 @@
"required": ["path","filter"],
"title": "Unwind"
}
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
+ }
, "CreateSecretRequest": {
"properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"service_account_id" : {"type": "string","title": "SERVICE_ACCOUNT_ID"},"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"}},
"type": "object",
@@ -1000,66 +1000,66 @@
"required": ["secret_id"],
"title": "UpdateSecretRequest"
}
- , "CreateUserSecretRequest": {
- "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"tags" : {"type": "object","title": "TAGS"}},
- "type": "object",
- "required": ["name","data"],
- "title": "CreateUserSecretRequest"
- }
- , "GetUserSecretDataRequest": {
- "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["user_secret_id","domain_id"],
- "title": "GetUserSecretDataRequest"
- }
- , "UpdateUserSecretDataRequest": {
- "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"data" : {"type": "object","title": "DATA"}},
+ , "CreateTrustedSecretRequest": {
+ "properties" : {"name" : {"type": "string","title": "NAME"},"data" : {"type": "object","title": "DATA"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"tags" : {"type": "object","title": "TAGS"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
"type": "object",
- "required": ["user_secret_id","schema_id","data"],
- "title": "UpdateUserSecretDataRequest"
+ "required": ["name","data","resource_group"],
+ "title": "CreateTrustedSecretRequest"
}
- , "UpdateUserSecretRequest": {
- "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ , "GetTrustedSecretDataRequest": {
+ "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
- "required": ["user_secret_id"],
- "title": "UpdateUserSecretRequest"
+ "required": ["trusted_secret_id","domain_id"],
+ "title": "GetTrustedSecretDataRequest"
}
- , "UserSecretDataInfo": {
+ , "TrustedSecretDataInfo": {
"properties" : {"encrypted" : {"type": "boolean","title": "ENCRYPTED"},"encrypt_options" : {"type": "object","title": "ENCRYPT_OPTIONS"},"data" : {"type": "object","title": "DATA"}},
"type": "object",
"required": ["encrypted","encrypt_options","data"],
- "title": "UserSecretDataInfo"
+ "title": "TrustedSecretDataInfo"
}
- , "UserSecretInfo": {
- "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"provider" : {"type": "string","title": "PROVIDER"},"tags" : {"type": "object","title": "TAGS"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"user_id" : {"type": "string","title": "USER_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ , "TrustedSecretInfo": {
+ "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"tags" : {"type": "object","title": "TAGS"},"provider" : {"type": "string","title": "PROVIDER"},"resource_group" : {"type": "string","title": "RESOURCE_GROUP"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
"type": "object",
- "required": ["user_secret_id","name","schema_id","provider","tags","domain_id","user_id","created_at"],
- "title": "UserSecretInfo"
+ "required": ["trusted_secret_id","name","schema_id","tags","provider","resource_group","domain_id","workspace_id","trusted_account_id","created_at"],
+ "title": "TrustedSecretInfo"
}
- , "UserSecretQuery": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"provider" : {"type": "string","title": "PROVIDER"}},
+ , "TrustedSecretQuery": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"provider" : {"type": "string","title": "PROVIDER"},"workspace_id" : {"type": "string","title": "WORKSPACE_ID"},"trusted_account_id" : {"type": "string","title": "TRUSTED_ACCOUNT_ID"}},
"type": "object",
"required": [],
- "title": "UserSecretQuery"
+ "title": "TrustedSecretQuery"
}
- , "UserSecretRequest": {
- "properties" : {"user_secret_id" : {"type": "string","title": "USER_SECRET_ID"}},
+ , "TrustedSecretRequest": {
+ "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"}},
"type": "object",
- "required": ["user_secret_id"],
- "title": "UserSecretRequest"
+ "required": ["trusted_secret_id"],
+ "title": "TrustedSecretRequest"
}
- , "UserSecretStatQuery": {
+ , "TrustedSecretStatQuery": {
"properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
"type": "object",
"required": ["query","domain_id"],
- "title": "UserSecretStatQuery"
+ "title": "TrustedSecretStatQuery"
}
- , "UserSecretsInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/UserSecretInfo"},
- "type": "array","$ref": "#/components/schemas/UserSecretInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ , "TrustedSecretsInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/TrustedSecretInfo"},
+ "type": "array","$ref": "#/components/schemas/TrustedSecretInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
"type": "object",
"required": ["results","total_count"],
- "title": "UserSecretsInfo"
+ "title": "TrustedSecretsInfo"
+ }
+ , "UpdateTrustedSecretDataRequest": {
+ "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"schema_id" : {"type": "string","title": "SCHEMA_ID"},"data" : {"type": "object","title": "DATA"}},
+ "type": "object",
+ "required": ["trusted_secret_id","schema_id","data"],
+ "title": "UpdateTrustedSecretDataRequest"
+ }
+ , "UpdateTrustedSecretRequest": {
+ "properties" : {"trusted_secret_id" : {"type": "string","title": "TRUSTED_SECRET_ID"},"name" : {"type": "string","title": "NAME"},"tags" : {"type": "object","title": "TAGS"}},
+ "type": "object",
+ "required": ["trusted_secret_id"],
+ "title": "UpdateTrustedSecretRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/openapi/cloudforet/api/statistics/v1/openapi.json b/dist/openapi/cloudforet/api/statistics/v1/openapi.json
index b8717cc1c..d5f3e500d 100755
--- a/dist/openapi/cloudforet/api/statistics/v1/openapi.json
+++ b/dist/openapi/cloudforet/api/statistics/v1/openapi.json
@@ -234,35 +234,6 @@
}}
}
,"security": [{"HTTPBearer": []}] }
- },"/statistics/resource/stat": {
- "post": {
- "tags": ["statistics > resource"],
- "summary": "Stat",
- "operationId" : "",
- "description": "### Description \nEnables data preprocessing of different services. Although limited, it is possible to create not only basic queries but also data suitable for users' needs, such as joins between two tables created by the query, handling missing values, and sorting.",
- "requestBody": {
- "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |aggregate||array|True|\n |page||StatPage||\n
",
- "content": {
- "application/json": {
- "schema": {
- "properties": {"aggregate" : {"items": {"$ref": "#/components/schemas/StatAggregate"}, "type": "array","title": "AGGREGATE" },"page" : {"$ref": "#/components/schemas/StatPage","title": "PAGE" } }
- },
- "examples":{"Schema":{}
- }
- }
- },"required": true
- },
- "responses": {
- "200": {
- "description": "Successfull Response","content":{
- "application/json": {
- "schema": {"type": "object"},
- "examples": {
- "Schema": {"type": "object"}}
- }
- }}
- }
- ,"security": [{"HTTPBearer": []}] }
},"/statistics/history/create": {
"post": {
"tags": ["statistics > history"],
@@ -344,6 +315,35 @@
}}
}
,"security": [{"HTTPBearer": []}] }
+ },"/statistics/resource/stat": {
+ "post": {
+ "tags": ["statistics > resource"],
+ "summary": "Stat",
+ "operationId" : "",
+ "description": "### Description \nEnables data preprocessing of different services. Although limited, it is possible to create not only basic queries but also data suitable for users' needs, such as joins between two tables created by the query, handling missing values, and sorting.",
+ "requestBody": {
+ "description": "\n| Key | Description | Type | Required|\n|-------------------|---------------------------------------------------------------|-----------|-------|\n |aggregate||array|True|\n |page||StatPage||\n
",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {"aggregate" : {"items": {"$ref": "#/components/schemas/StatAggregate"}, "type": "array","title": "AGGREGATE" },"page" : {"$ref": "#/components/schemas/StatPage","title": "PAGE" } }
+ },
+ "examples":{"Schema":{}
+ }
+ }
+ },"required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successfull Response","content":{
+ "application/json": {
+ "schema": {"type": "object"},
+ "examples": {
+ "Schema": {"type": "object"}}
+ }
+ }}
+ }
+ ,"security": [{"HTTPBearer": []}] }
},"securitySchemes": {"HTTPBearer": {"type": "http","scheme": "bearer","bearerFormat": "JWT"}}
},
"components":{
@@ -405,44 +405,6 @@
"required": ["schedule_id"],
"title": "UpdateScheduleRequest"
}
- , "AuthenticationRequest": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
- "type": "object",
- "required": ["domain_id"],
- "title": "AuthenticationRequest"
- }
- , "AuthenticationResponse": {
- "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
- "type": "object",
- "required": ["domain_id","public_key"],
- "title": "AuthenticationResponse"
- }
- , "AuthorizationRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
- "type": "object",
- "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
- "title": "AuthorizationRequest"
- }
- , "AuthorizationResponse": {
- "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
- "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
- "type": "array","title": "PROJECT_GROUPS"}},
- "type": "object",
- "required": ["role_type","projects","project_groups"],
- "title": "AuthorizationResponse"
- }
- , "EventRequest": {
- "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
- "type": "object",
- "required": ["service","resource","verb","status","message"],
- "title": "EventRequest"
- }
- , "VersionInfo": {
- "properties" : {"version" : {"type": "string","title": "VERSION"}},
- "type": "object",
- "required": ["version"],
- "title": "VersionInfo"
- }
, "AggregateCount": {
"properties" : {"name" : {"type": "string","title": "NAME"}},
"type": "object",
@@ -612,6 +574,75 @@
"required": ["path","filter"],
"title": "Unwind"
}
+ , "AuthenticationRequest": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"}},
+ "type": "object",
+ "required": ["domain_id"],
+ "title": "AuthenticationRequest"
+ }
+ , "AuthenticationResponse": {
+ "properties" : {"domain_id" : {"type": "string","title": "DOMAIN_ID"},"public_key" : {"type": "string","title": "PUBLIC_KEY"}},
+ "type": "object",
+ "required": ["domain_id","public_key"],
+ "title": "AuthenticationResponse"
+ }
+ , "AuthorizationRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"scope" : {"type": "Scope","title": "SCOPE"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"project_id" : {"type": "string","title": "PROJECT_ID"},"project_group_id" : {"type": "string","title": "PROJECT_GROUP_ID"},"user_id" : {"type": "string","title": "USER_ID"},"require_project_id" : {"type": "boolean","title": "REQUIRE_PROJECT_ID"},"require_project_group_id" : {"type": "boolean","title": "REQUIRE_PROJECT_GROUP_ID"},"require_user_id" : {"type": "boolean","title": "REQUIRE_USER_ID"},"require_domain_id" : {"type": "boolean","title": "REQUIRE_DOMAIN_ID"}},
+ "type": "object",
+ "required": ["service","resource","verb","scope","domain_id","project_id","project_group_id","user_id","require_project_id","require_project_group_id","require_user_id","require_domain_id"],
+ "title": "AuthorizationRequest"
+ }
+ , "AuthorizationResponse": {
+ "properties" : {"role_type" : {"type": "string","title": "ROLE_TYPE"},"projects" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECTS"},"project_groups" : {"items": {"type": "string"},
+ "type": "array","title": "PROJECT_GROUPS"}},
+ "type": "object",
+ "required": ["role_type","projects","project_groups"],
+ "title": "AuthorizationResponse"
+ }
+ , "EventRequest": {
+ "properties" : {"service" : {"type": "string","title": "SERVICE"},"resource" : {"type": "string","title": "RESOURCE"},"verb" : {"type": "string","title": "VERB"},"status" : {"type": "string","title": "STATUS"},"message" : {"type": "object","title": "MESSAGE"}},
+ "type": "object",
+ "required": ["service","resource","verb","status","message"],
+ "title": "EventRequest"
+ }
+ , "VersionInfo": {
+ "properties" : {"version" : {"type": "string","title": "VERSION"}},
+ "type": "object",
+ "required": ["version"],
+ "title": "VersionInfo"
+ }
+ , "CreateHistoryRequest": {
+ "properties" : {"schedule_id" : {"type": "string","title": "SCHEDULE_ID"}},
+ "type": "object",
+ "required": ["schedule_id"],
+ "title": "CreateHistoryRequest"
+ }
+ , "HistoryInfo": {
+ "properties" : {"results" : {"items": {"$ref": "#/components/schemas/HistoryValueInfo"},
+ "type": "array","$ref": "#/components/schemas/HistoryValueInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
+ "type": "object",
+ "required": ["results","total_count"],
+ "title": "HistoryInfo"
+ }
+ , "HistoryStatRequest": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"topic" : {"type": "string","title": "TOPIC"}},
+ "type": "object",
+ "required": ["query"],
+ "title": "HistoryStatRequest"
+ }
+ , "HistoryValueInfo": {
+ "properties" : {"topic" : {"type": "string","title": "TOPIC"},"values" : {"type": "object","title": "VALUES"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
+ "type": "object",
+ "required": ["topic","values","domain_id","created_at"],
+ "title": "HistoryValueInfo"
+ }
+ , "QueryHistoryRequest": {
+ "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"topic" : {"type": "string","title": "TOPIC"}},
+ "type": "object",
+ "required": [],
+ "title": "QueryHistoryRequest"
+ }
, "ResourceStatRequest": {
"properties" : {"aggregate" : {"items": {"$ref": "#/components/schemas/StatAggregate"},
"type": "array","$ref": "#/components/schemas/StatAggregate","title": "AGGREGATE"},"page" : {"$ref": "#/components/schemas/StatPage","title": "PAGE"}},
@@ -661,37 +692,6 @@
"type": "object",
"required": ["limit"],
"title": "StatPage"
- }
- , "CreateHistoryRequest": {
- "properties" : {"schedule_id" : {"type": "string","title": "SCHEDULE_ID"}},
- "type": "object",
- "required": ["schedule_id"],
- "title": "CreateHistoryRequest"
- }
- , "HistoryInfo": {
- "properties" : {"results" : {"items": {"$ref": "#/components/schemas/HistoryValueInfo"},
- "type": "array","$ref": "#/components/schemas/HistoryValueInfo","title": "RESULTS"},"total_count" : {"type": "integer","title": "TOTAL_COUNT"}},
- "type": "object",
- "required": ["results","total_count"],
- "title": "HistoryInfo"
- }
- , "HistoryStatRequest": {
- "properties" : {"query" : {"$ref": "#/components/schemas/StatisticsQuery","title": "QUERY"},"topic" : {"type": "string","title": "TOPIC"}},
- "type": "object",
- "required": ["query"],
- "title": "HistoryStatRequest"
- }
- , "HistoryValueInfo": {
- "properties" : {"topic" : {"type": "string","title": "TOPIC"},"values" : {"type": "object","title": "VALUES"},"domain_id" : {"type": "string","title": "DOMAIN_ID"},"created_at" : {"type": "string","title": "CREATED_AT"}},
- "type": "object",
- "required": ["topic","values","domain_id","created_at"],
- "title": "HistoryValueInfo"
- }
- , "QueryHistoryRequest": {
- "properties" : {"query" : {"$ref": "#/components/schemas/Query","title": "QUERY"},"topic" : {"type": "string","title": "TOPIC"}},
- "type": "object",
- "required": [],
- "title": "QueryHistoryRequest"
}
},
"Struct": {"properties": {"type": "object","title": "Struct"}},
diff --git a/dist/python/build/lib/spaceone/api/repository/v1/plugin_pb2.py b/dist/python/build/lib/spaceone/api/repository/v1/plugin_pb2.py
index afcea749d..e55564ce6 100644
--- a/dist/python/build/lib/spaceone/api/repository/v1/plugin_pb2.py
+++ b/dist/python/build/lib/spaceone/api/repository/v1/plugin_pb2.py
@@ -19,7 +19,7 @@
from spaceone.api.repository.v1 import repository_pb2 as spaceone_dot_api_dot_repository_dot_v1_dot_repository__pb2
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'spaceone/api/repository/v1/plugin.proto\x12\x1aspaceone.api.repository.v1\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1cgoogle/api/annotations.proto\x1a spaceone/api/core/v2/query.proto\x1a+spaceone/api/repository/v1/repository.proto\"\xe9\x02\n\x15RegisterPluginRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x15\n\rresource_type\x18\x02 \x01(\t\x12\r\n\x05image\x18\x03 \x01(\t\x12\x10\n\x08provider\x18\x04 \x01(\t\x12\x45\n\rregistry_type\x18\x05 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x30\n\x0fregistry_config\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\x07 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tplugin_id\x18\n \x01(\t\"\xb6\x01\n\x13UpdatePluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12+\n\ncapability\x18\x03 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x05 \x01(\x0b\x32\x17.google.protobuf.Struct\"\"\n\rPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\"C\n\x17RepositoryPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x15\n\rrepository_id\x18\x15 \x01(\t\"\xcd\x02\n\x0bPluginQuery\x12*\n\x05query\x18\x01 \x01(\x0b\x32\x1b.spaceone.api.core.v2.Query\x12\x11\n\tplugin_id\x18\x02 \x01(\t\x12\x0c\n\x04name\x18\x03 \x01(\t\x12<\n\x05state\x18\x04 \x01(\x0e\x32-.spaceone.api.repository.v1.PluginQuery.State\x12\x15\n\rresource_type\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x15\n\rrepository_id\x18\x15 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"\xdf\x04\n\nPluginInfo\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12;\n\x05state\x18\x03 \x01(\x0e\x32,.spaceone.api.repository.v1.PluginInfo.State\x12\x15\n\rresource_type\x18\x04 \x01(\t\x12\r\n\x05image\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x14\n\x0cregistry_url\x18\x08 \x01(\t\x12\x30\n\x0fregistry_config\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\n \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x0c \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tdomain_id\x18\x15 \x01(\t\x12\x43\n\x0frepository_info\x18\x16 \x01(\x0b\x32*.spaceone.api.repository.v1.RepositoryInfo\x12\x12\n\ncreated_at\x18\x1f \x01(\t\x12\x12\n\nupdated_at\x18 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"[\n\x0bPluginsInfo\x12\x37\n\x07results\x18\x01 \x03(\x0b\x32&.spaceone.api.repository.v1.PluginInfo\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\"E\n\x0cVersionsInfo\x12\x0f\n\x07version\x18\x01 \x03(\t\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\x12\x0f\n\x07results\x18\x03 \x03(\t*i\n\x12PublicRegistryType\x12\x16\n\x12NONE_REGISTRY_TYPE\x10\x00\x12\x0e\n\nDOCKER_HUB\x10\x01\x12\x13\n\x0f\x41WS_PRIVATE_ECR\x10\x02\x12\n\n\x06HARBOR\x10\x03\x12\n\n\x06GITHUB\x10\x04\x32\xe1\x08\n\x06Plugin\x12\x90\x01\n\x08register\x12\x31.spaceone.api.repository.v1.RegisterPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\")\x82\xd3\xe4\x93\x02#\"\x1e/repository/v1/plugin/register:\x01*\x12\x8a\x01\n\x06update\x12/.spaceone.api.repository.v1.UpdatePluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/update:\x01*\x12|\n\nderegister\x12).spaceone.api.repository.v1.PluginRequest\x1a\x16.google.protobuf.Empty\"+\x82\xd3\xe4\x93\x02%\" /repository/v1/plugin/deregister:\x01*\x12\x84\x01\n\x06\x65nable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/enable:\x01*\x12\x86\x01\n\x07\x64isable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"(\x82\xd3\xe4\x93\x02\"\"\x1d/repository/v1/plugin/disable:\x01*\x12\x9c\x01\n\x0cget_versions\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a(.spaceone.api.repository.v1.VersionsInfo\"-\x82\xd3\xe4\x93\x02\'\"\"/repository/v1/plugin/get-versions:\x01*\x12\x88\x01\n\x03get\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/repository/v1/plugin/get:\x01*\x12\x7f\n\x04list\x12\'.spaceone.api.repository.v1.PluginQuery\x1a\'.spaceone.api.repository.v1.PluginsInfo\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/repository/v1/plugin/list:\x01*BAZ?github.com/cloudforet-io/api/dist/go/spaceone/api/repository/v1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'spaceone/api/repository/v1/plugin.proto\x12\x1aspaceone.api.repository.v1\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1cgoogle/api/annotations.proto\x1a spaceone/api/core/v2/query.proto\x1a+spaceone/api/repository/v1/repository.proto\"\x90\x03\n\x15RegisterPluginRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x15\n\rresource_type\x18\x02 \x01(\t\x12\r\n\x05image\x18\x03 \x01(\t\x12\x10\n\x08provider\x18\x04 \x01(\t\x12\x45\n\rregistry_type\x18\x05 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x30\n\x0fregistry_config\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\x07 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tplugin_id\x18\n \x01(\t\x12%\n\x04\x64ocs\x18\x0b \x01(\x0b\x32\x17.google.protobuf.Struct\"\xdd\x01\n\x13UpdatePluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12+\n\ncapability\x18\x03 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x05 \x01(\x0b\x32\x17.google.protobuf.Struct\x12%\n\x04\x64ocs\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\"\"\n\rPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\"C\n\x17RepositoryPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x15\n\rrepository_id\x18\x15 \x01(\t\"\xcd\x02\n\x0bPluginQuery\x12*\n\x05query\x18\x01 \x01(\x0b\x32\x1b.spaceone.api.core.v2.Query\x12\x11\n\tplugin_id\x18\x02 \x01(\t\x12\x0c\n\x04name\x18\x03 \x01(\t\x12<\n\x05state\x18\x04 \x01(\x0e\x32-.spaceone.api.repository.v1.PluginQuery.State\x12\x15\n\rresource_type\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x15\n\rrepository_id\x18\x15 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"\x86\x05\n\nPluginInfo\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12;\n\x05state\x18\x03 \x01(\x0e\x32,.spaceone.api.repository.v1.PluginInfo.State\x12\x15\n\rresource_type\x18\x04 \x01(\t\x12\r\n\x05image\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x14\n\x0cregistry_url\x18\x08 \x01(\t\x12\x30\n\x0fregistry_config\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\n \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x0c \x01(\x0b\x32\x17.google.protobuf.Struct\x12%\n\x04\x64ocs\x18\r \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tdomain_id\x18\x15 \x01(\t\x12\x43\n\x0frepository_info\x18\x16 \x01(\x0b\x32*.spaceone.api.repository.v1.RepositoryInfo\x12\x12\n\ncreated_at\x18\x1f \x01(\t\x12\x12\n\nupdated_at\x18 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"[\n\x0bPluginsInfo\x12\x37\n\x07results\x18\x01 \x03(\x0b\x32&.spaceone.api.repository.v1.PluginInfo\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\"E\n\x0cVersionsInfo\x12\x0f\n\x07version\x18\x01 \x03(\t\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\x12\x0f\n\x07results\x18\x03 \x03(\t*i\n\x12PublicRegistryType\x12\x16\n\x12NONE_REGISTRY_TYPE\x10\x00\x12\x0e\n\nDOCKER_HUB\x10\x01\x12\x13\n\x0f\x41WS_PRIVATE_ECR\x10\x02\x12\n\n\x06HARBOR\x10\x03\x12\n\n\x06GITHUB\x10\x04\x32\xe1\x08\n\x06Plugin\x12\x90\x01\n\x08register\x12\x31.spaceone.api.repository.v1.RegisterPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\")\x82\xd3\xe4\x93\x02#\"\x1e/repository/v1/plugin/register:\x01*\x12\x8a\x01\n\x06update\x12/.spaceone.api.repository.v1.UpdatePluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/update:\x01*\x12|\n\nderegister\x12).spaceone.api.repository.v1.PluginRequest\x1a\x16.google.protobuf.Empty\"+\x82\xd3\xe4\x93\x02%\" /repository/v1/plugin/deregister:\x01*\x12\x84\x01\n\x06\x65nable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/enable:\x01*\x12\x86\x01\n\x07\x64isable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"(\x82\xd3\xe4\x93\x02\"\"\x1d/repository/v1/plugin/disable:\x01*\x12\x9c\x01\n\x0cget_versions\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a(.spaceone.api.repository.v1.VersionsInfo\"-\x82\xd3\xe4\x93\x02\'\"\"/repository/v1/plugin/get-versions:\x01*\x12\x88\x01\n\x03get\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/repository/v1/plugin/get:\x01*\x12\x7f\n\x04list\x12\'.spaceone.api.repository.v1.PluginQuery\x1a\'.spaceone.api.repository.v1.PluginsInfo\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/repository/v1/plugin/list:\x01*BAZ?github.com/cloudforet-io/api/dist/go/spaceone/api/repository/v1b\x06proto3')
_globals = globals()
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -43,28 +43,28 @@
_globals['_PLUGIN'].methods_by_name['get']._serialized_options = b'\202\323\344\223\002\036\"\031/repository/v1/plugin/get:\001*'
_globals['_PLUGIN'].methods_by_name['list']._loaded_options = None
_globals['_PLUGIN'].methods_by_name['list']._serialized_options = b'\202\323\344\223\002\037\"\032/repository/v1/plugin/list:\001*'
- _globals['_PUBLICREGISTRYTYPE']._serialized_start=2003
- _globals['_PUBLICREGISTRYTYPE']._serialized_end=2108
+ _globals['_PUBLICREGISTRYTYPE']._serialized_start=2120
+ _globals['_PUBLICREGISTRYTYPE']._serialized_end=2225
_globals['_REGISTERPLUGINREQUEST']._serialized_start=240
- _globals['_REGISTERPLUGINREQUEST']._serialized_end=601
- _globals['_UPDATEPLUGINREQUEST']._serialized_start=604
- _globals['_UPDATEPLUGINREQUEST']._serialized_end=786
- _globals['_PLUGINREQUEST']._serialized_start=788
- _globals['_PLUGINREQUEST']._serialized_end=822
- _globals['_REPOSITORYPLUGINREQUEST']._serialized_start=824
- _globals['_REPOSITORYPLUGINREQUEST']._serialized_end=891
- _globals['_PLUGINQUERY']._serialized_start=894
- _globals['_PLUGINQUERY']._serialized_end=1227
- _globals['_PLUGINQUERY_STATE']._serialized_start=1183
- _globals['_PLUGINQUERY_STATE']._serialized_end=1227
- _globals['_PLUGININFO']._serialized_start=1230
- _globals['_PLUGININFO']._serialized_end=1837
- _globals['_PLUGININFO_STATE']._serialized_start=1183
- _globals['_PLUGININFO_STATE']._serialized_end=1227
- _globals['_PLUGINSINFO']._serialized_start=1839
- _globals['_PLUGINSINFO']._serialized_end=1930
- _globals['_VERSIONSINFO']._serialized_start=1932
- _globals['_VERSIONSINFO']._serialized_end=2001
- _globals['_PLUGIN']._serialized_start=2111
- _globals['_PLUGIN']._serialized_end=3232
+ _globals['_REGISTERPLUGINREQUEST']._serialized_end=640
+ _globals['_UPDATEPLUGINREQUEST']._serialized_start=643
+ _globals['_UPDATEPLUGINREQUEST']._serialized_end=864
+ _globals['_PLUGINREQUEST']._serialized_start=866
+ _globals['_PLUGINREQUEST']._serialized_end=900
+ _globals['_REPOSITORYPLUGINREQUEST']._serialized_start=902
+ _globals['_REPOSITORYPLUGINREQUEST']._serialized_end=969
+ _globals['_PLUGINQUERY']._serialized_start=972
+ _globals['_PLUGINQUERY']._serialized_end=1305
+ _globals['_PLUGINQUERY_STATE']._serialized_start=1261
+ _globals['_PLUGINQUERY_STATE']._serialized_end=1305
+ _globals['_PLUGININFO']._serialized_start=1308
+ _globals['_PLUGININFO']._serialized_end=1954
+ _globals['_PLUGININFO_STATE']._serialized_start=1261
+ _globals['_PLUGININFO_STATE']._serialized_end=1305
+ _globals['_PLUGINSINFO']._serialized_start=1956
+ _globals['_PLUGINSINFO']._serialized_end=2047
+ _globals['_VERSIONSINFO']._serialized_start=2049
+ _globals['_VERSIONSINFO']._serialized_end=2118
+ _globals['_PLUGIN']._serialized_start=2228
+ _globals['_PLUGIN']._serialized_end=3349
# @@protoc_insertion_point(module_scope)
diff --git a/dist/python/dist/spaceone-api-2.0.232.tar.gz b/dist/python/dist/spaceone-api-2.0.232.tar.gz
deleted file mode 100644
index b52fd1ccf..000000000
Binary files a/dist/python/dist/spaceone-api-2.0.232.tar.gz and /dev/null differ
diff --git a/dist/python/dist/spaceone-api-2.0.233.tar.gz b/dist/python/dist/spaceone-api-2.0.233.tar.gz
new file mode 100644
index 000000000..10c37a3b1
Binary files /dev/null and b/dist/python/dist/spaceone-api-2.0.233.tar.gz differ
diff --git a/dist/python/dist/spaceone_api-2.0.232-py3-none-any.whl b/dist/python/dist/spaceone_api-2.0.233-py3-none-any.whl
similarity index 88%
rename from dist/python/dist/spaceone_api-2.0.232-py3-none-any.whl
rename to dist/python/dist/spaceone_api-2.0.233-py3-none-any.whl
index c87feec22..9fc65a7cf 100644
Binary files a/dist/python/dist/spaceone_api-2.0.232-py3-none-any.whl and b/dist/python/dist/spaceone_api-2.0.233-py3-none-any.whl differ
diff --git a/dist/python/spaceone/api/repository/v1/plugin_pb2.py b/dist/python/spaceone/api/repository/v1/plugin_pb2.py
index afcea749d..e55564ce6 100755
--- a/dist/python/spaceone/api/repository/v1/plugin_pb2.py
+++ b/dist/python/spaceone/api/repository/v1/plugin_pb2.py
@@ -19,7 +19,7 @@
from spaceone.api.repository.v1 import repository_pb2 as spaceone_dot_api_dot_repository_dot_v1_dot_repository__pb2
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'spaceone/api/repository/v1/plugin.proto\x12\x1aspaceone.api.repository.v1\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1cgoogle/api/annotations.proto\x1a spaceone/api/core/v2/query.proto\x1a+spaceone/api/repository/v1/repository.proto\"\xe9\x02\n\x15RegisterPluginRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x15\n\rresource_type\x18\x02 \x01(\t\x12\r\n\x05image\x18\x03 \x01(\t\x12\x10\n\x08provider\x18\x04 \x01(\t\x12\x45\n\rregistry_type\x18\x05 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x30\n\x0fregistry_config\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\x07 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tplugin_id\x18\n \x01(\t\"\xb6\x01\n\x13UpdatePluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12+\n\ncapability\x18\x03 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x05 \x01(\x0b\x32\x17.google.protobuf.Struct\"\"\n\rPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\"C\n\x17RepositoryPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x15\n\rrepository_id\x18\x15 \x01(\t\"\xcd\x02\n\x0bPluginQuery\x12*\n\x05query\x18\x01 \x01(\x0b\x32\x1b.spaceone.api.core.v2.Query\x12\x11\n\tplugin_id\x18\x02 \x01(\t\x12\x0c\n\x04name\x18\x03 \x01(\t\x12<\n\x05state\x18\x04 \x01(\x0e\x32-.spaceone.api.repository.v1.PluginQuery.State\x12\x15\n\rresource_type\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x15\n\rrepository_id\x18\x15 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"\xdf\x04\n\nPluginInfo\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12;\n\x05state\x18\x03 \x01(\x0e\x32,.spaceone.api.repository.v1.PluginInfo.State\x12\x15\n\rresource_type\x18\x04 \x01(\t\x12\r\n\x05image\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x14\n\x0cregistry_url\x18\x08 \x01(\t\x12\x30\n\x0fregistry_config\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\n \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x0c \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tdomain_id\x18\x15 \x01(\t\x12\x43\n\x0frepository_info\x18\x16 \x01(\x0b\x32*.spaceone.api.repository.v1.RepositoryInfo\x12\x12\n\ncreated_at\x18\x1f \x01(\t\x12\x12\n\nupdated_at\x18 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"[\n\x0bPluginsInfo\x12\x37\n\x07results\x18\x01 \x03(\x0b\x32&.spaceone.api.repository.v1.PluginInfo\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\"E\n\x0cVersionsInfo\x12\x0f\n\x07version\x18\x01 \x03(\t\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\x12\x0f\n\x07results\x18\x03 \x03(\t*i\n\x12PublicRegistryType\x12\x16\n\x12NONE_REGISTRY_TYPE\x10\x00\x12\x0e\n\nDOCKER_HUB\x10\x01\x12\x13\n\x0f\x41WS_PRIVATE_ECR\x10\x02\x12\n\n\x06HARBOR\x10\x03\x12\n\n\x06GITHUB\x10\x04\x32\xe1\x08\n\x06Plugin\x12\x90\x01\n\x08register\x12\x31.spaceone.api.repository.v1.RegisterPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\")\x82\xd3\xe4\x93\x02#\"\x1e/repository/v1/plugin/register:\x01*\x12\x8a\x01\n\x06update\x12/.spaceone.api.repository.v1.UpdatePluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/update:\x01*\x12|\n\nderegister\x12).spaceone.api.repository.v1.PluginRequest\x1a\x16.google.protobuf.Empty\"+\x82\xd3\xe4\x93\x02%\" /repository/v1/plugin/deregister:\x01*\x12\x84\x01\n\x06\x65nable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/enable:\x01*\x12\x86\x01\n\x07\x64isable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"(\x82\xd3\xe4\x93\x02\"\"\x1d/repository/v1/plugin/disable:\x01*\x12\x9c\x01\n\x0cget_versions\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a(.spaceone.api.repository.v1.VersionsInfo\"-\x82\xd3\xe4\x93\x02\'\"\"/repository/v1/plugin/get-versions:\x01*\x12\x88\x01\n\x03get\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/repository/v1/plugin/get:\x01*\x12\x7f\n\x04list\x12\'.spaceone.api.repository.v1.PluginQuery\x1a\'.spaceone.api.repository.v1.PluginsInfo\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/repository/v1/plugin/list:\x01*BAZ?github.com/cloudforet-io/api/dist/go/spaceone/api/repository/v1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'spaceone/api/repository/v1/plugin.proto\x12\x1aspaceone.api.repository.v1\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1cgoogle/api/annotations.proto\x1a spaceone/api/core/v2/query.proto\x1a+spaceone/api/repository/v1/repository.proto\"\x90\x03\n\x15RegisterPluginRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x15\n\rresource_type\x18\x02 \x01(\t\x12\r\n\x05image\x18\x03 \x01(\t\x12\x10\n\x08provider\x18\x04 \x01(\t\x12\x45\n\rregistry_type\x18\x05 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x30\n\x0fregistry_config\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\x07 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tplugin_id\x18\n \x01(\t\x12%\n\x04\x64ocs\x18\x0b \x01(\x0b\x32\x17.google.protobuf.Struct\"\xdd\x01\n\x13UpdatePluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12+\n\ncapability\x18\x03 \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x05 \x01(\x0b\x32\x17.google.protobuf.Struct\x12%\n\x04\x64ocs\x18\x06 \x01(\x0b\x32\x17.google.protobuf.Struct\"\"\n\rPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\"C\n\x17RepositoryPluginRequest\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x15\n\rrepository_id\x18\x15 \x01(\t\"\xcd\x02\n\x0bPluginQuery\x12*\n\x05query\x18\x01 \x01(\x0b\x32\x1b.spaceone.api.core.v2.Query\x12\x11\n\tplugin_id\x18\x02 \x01(\t\x12\x0c\n\x04name\x18\x03 \x01(\t\x12<\n\x05state\x18\x04 \x01(\x0e\x32-.spaceone.api.repository.v1.PluginQuery.State\x12\x15\n\rresource_type\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x15\n\rrepository_id\x18\x15 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"\x86\x05\n\nPluginInfo\x12\x11\n\tplugin_id\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12;\n\x05state\x18\x03 \x01(\x0e\x32,.spaceone.api.repository.v1.PluginInfo.State\x12\x15\n\rresource_type\x18\x04 \x01(\t\x12\r\n\x05image\x18\x05 \x01(\t\x12\x10\n\x08provider\x18\x06 \x01(\t\x12\x45\n\rregistry_type\x18\x07 \x01(\x0e\x32..spaceone.api.repository.v1.PublicRegistryType\x12\x14\n\x0cregistry_url\x18\x08 \x01(\t\x12\x30\n\x0fregistry_config\x18\t \x01(\x0b\x32\x17.google.protobuf.Struct\x12+\n\ncapability\x18\n \x01(\x0b\x32\x17.google.protobuf.Struct\x12*\n\x06labels\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.ListValue\x12%\n\x04tags\x18\x0c \x01(\x0b\x32\x17.google.protobuf.Struct\x12%\n\x04\x64ocs\x18\r \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x11\n\tdomain_id\x18\x15 \x01(\t\x12\x43\n\x0frepository_info\x18\x16 \x01(\x0b\x32*.spaceone.api.repository.v1.RepositoryInfo\x12\x12\n\ncreated_at\x18\x1f \x01(\t\x12\x12\n\nupdated_at\x18 \x01(\t\",\n\x05State\x12\x08\n\x04NONE\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02\"[\n\x0bPluginsInfo\x12\x37\n\x07results\x18\x01 \x03(\x0b\x32&.spaceone.api.repository.v1.PluginInfo\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\"E\n\x0cVersionsInfo\x12\x0f\n\x07version\x18\x01 \x03(\t\x12\x13\n\x0btotal_count\x18\x02 \x01(\x05\x12\x0f\n\x07results\x18\x03 \x03(\t*i\n\x12PublicRegistryType\x12\x16\n\x12NONE_REGISTRY_TYPE\x10\x00\x12\x0e\n\nDOCKER_HUB\x10\x01\x12\x13\n\x0f\x41WS_PRIVATE_ECR\x10\x02\x12\n\n\x06HARBOR\x10\x03\x12\n\n\x06GITHUB\x10\x04\x32\xe1\x08\n\x06Plugin\x12\x90\x01\n\x08register\x12\x31.spaceone.api.repository.v1.RegisterPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\")\x82\xd3\xe4\x93\x02#\"\x1e/repository/v1/plugin/register:\x01*\x12\x8a\x01\n\x06update\x12/.spaceone.api.repository.v1.UpdatePluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/update:\x01*\x12|\n\nderegister\x12).spaceone.api.repository.v1.PluginRequest\x1a\x16.google.protobuf.Empty\"+\x82\xd3\xe4\x93\x02%\" /repository/v1/plugin/deregister:\x01*\x12\x84\x01\n\x06\x65nable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"\'\x82\xd3\xe4\x93\x02!\"\x1c/repository/v1/plugin/enable:\x01*\x12\x86\x01\n\x07\x64isable\x12).spaceone.api.repository.v1.PluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"(\x82\xd3\xe4\x93\x02\"\"\x1d/repository/v1/plugin/disable:\x01*\x12\x9c\x01\n\x0cget_versions\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a(.spaceone.api.repository.v1.VersionsInfo\"-\x82\xd3\xe4\x93\x02\'\"\"/repository/v1/plugin/get-versions:\x01*\x12\x88\x01\n\x03get\x12\x33.spaceone.api.repository.v1.RepositoryPluginRequest\x1a&.spaceone.api.repository.v1.PluginInfo\"$\x82\xd3\xe4\x93\x02\x1e\"\x19/repository/v1/plugin/get:\x01*\x12\x7f\n\x04list\x12\'.spaceone.api.repository.v1.PluginQuery\x1a\'.spaceone.api.repository.v1.PluginsInfo\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/repository/v1/plugin/list:\x01*BAZ?github.com/cloudforet-io/api/dist/go/spaceone/api/repository/v1b\x06proto3')
_globals = globals()
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -43,28 +43,28 @@
_globals['_PLUGIN'].methods_by_name['get']._serialized_options = b'\202\323\344\223\002\036\"\031/repository/v1/plugin/get:\001*'
_globals['_PLUGIN'].methods_by_name['list']._loaded_options = None
_globals['_PLUGIN'].methods_by_name['list']._serialized_options = b'\202\323\344\223\002\037\"\032/repository/v1/plugin/list:\001*'
- _globals['_PUBLICREGISTRYTYPE']._serialized_start=2003
- _globals['_PUBLICREGISTRYTYPE']._serialized_end=2108
+ _globals['_PUBLICREGISTRYTYPE']._serialized_start=2120
+ _globals['_PUBLICREGISTRYTYPE']._serialized_end=2225
_globals['_REGISTERPLUGINREQUEST']._serialized_start=240
- _globals['_REGISTERPLUGINREQUEST']._serialized_end=601
- _globals['_UPDATEPLUGINREQUEST']._serialized_start=604
- _globals['_UPDATEPLUGINREQUEST']._serialized_end=786
- _globals['_PLUGINREQUEST']._serialized_start=788
- _globals['_PLUGINREQUEST']._serialized_end=822
- _globals['_REPOSITORYPLUGINREQUEST']._serialized_start=824
- _globals['_REPOSITORYPLUGINREQUEST']._serialized_end=891
- _globals['_PLUGINQUERY']._serialized_start=894
- _globals['_PLUGINQUERY']._serialized_end=1227
- _globals['_PLUGINQUERY_STATE']._serialized_start=1183
- _globals['_PLUGINQUERY_STATE']._serialized_end=1227
- _globals['_PLUGININFO']._serialized_start=1230
- _globals['_PLUGININFO']._serialized_end=1837
- _globals['_PLUGININFO_STATE']._serialized_start=1183
- _globals['_PLUGININFO_STATE']._serialized_end=1227
- _globals['_PLUGINSINFO']._serialized_start=1839
- _globals['_PLUGINSINFO']._serialized_end=1930
- _globals['_VERSIONSINFO']._serialized_start=1932
- _globals['_VERSIONSINFO']._serialized_end=2001
- _globals['_PLUGIN']._serialized_start=2111
- _globals['_PLUGIN']._serialized_end=3232
+ _globals['_REGISTERPLUGINREQUEST']._serialized_end=640
+ _globals['_UPDATEPLUGINREQUEST']._serialized_start=643
+ _globals['_UPDATEPLUGINREQUEST']._serialized_end=864
+ _globals['_PLUGINREQUEST']._serialized_start=866
+ _globals['_PLUGINREQUEST']._serialized_end=900
+ _globals['_REPOSITORYPLUGINREQUEST']._serialized_start=902
+ _globals['_REPOSITORYPLUGINREQUEST']._serialized_end=969
+ _globals['_PLUGINQUERY']._serialized_start=972
+ _globals['_PLUGINQUERY']._serialized_end=1305
+ _globals['_PLUGINQUERY_STATE']._serialized_start=1261
+ _globals['_PLUGINQUERY_STATE']._serialized_end=1305
+ _globals['_PLUGININFO']._serialized_start=1308
+ _globals['_PLUGININFO']._serialized_end=1954
+ _globals['_PLUGININFO_STATE']._serialized_start=1261
+ _globals['_PLUGININFO_STATE']._serialized_end=1305
+ _globals['_PLUGINSINFO']._serialized_start=1956
+ _globals['_PLUGINSINFO']._serialized_end=2047
+ _globals['_VERSIONSINFO']._serialized_start=2049
+ _globals['_VERSIONSINFO']._serialized_end=2118
+ _globals['_PLUGIN']._serialized_start=2228
+ _globals['_PLUGIN']._serialized_end=3349
# @@protoc_insertion_point(module_scope)
diff --git a/dist/python/spaceone_api.egg-info/PKG-INFO b/dist/python/spaceone_api.egg-info/PKG-INFO
index 79c22658e..1eaf5f94d 100644
--- a/dist/python/spaceone_api.egg-info/PKG-INFO
+++ b/dist/python/spaceone_api.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.0
Name: spaceone-api
-Version: 2.0.232
+Version: 2.0.233
Summary: Coreforet API Protobuf
Home-page: https://cloudforet.io/
Author: MEGAZONE Cloud Corp.