Update swagger documentation for roles and users examples

pull/10616/head
Chris Goller 2017-03-01 19:39:03 -06:00
parent 51c65f9111
commit 03b6d4ce60
1 changed files with 117 additions and 21 deletions

View File

@ -2565,6 +2565,34 @@
"$ref": "#/definitions/Role" "$ref": "#/definitions/Role"
} }
} }
},
"example": {
"roles": [
{
"users": [
{
"name": "admin",
"links": {
"self": "/chronograf/v1/sources/3/users/admin"
}
}
],
"name": "timetravelers",
"permissions": [
{
"scope": "database",
"name": "telegraf",
"allowed": [
"ReadData",
"WriteData"
]
}
],
"links": {
"self": "/chronograf/v1/sources/3/roles/timetravelers"
}
}
]
} }
}, },
"Role": { "Role": {
@ -2596,6 +2624,30 @@
} }
} }
} }
},
"example": {
"users": [
{
"name": "admin",
"links": {
"self": "/chronograf/v1/sources/3/users/admin"
}
}
],
"name": "timetravelers",
"permissions": [
{
"scope": "database",
"name": "telegraf",
"allowed": [
"ReadData",
"WriteData"
]
}
],
"links": {
"self": "/chronograf/v1/sources/3/roles/timetravelers"
}
} }
}, },
"Users": { "Users": {
@ -2616,21 +2668,43 @@
{ {
"scope": "all", "scope": "all",
"allowed": [ "allowed": [
"ViewAdmin",
"ViewChronograf", "ViewChronograf",
"ReadData" "CreateDatabase",
] "CreateUserAndRole",
}, "DropDatabase",
{ "DropData",
"scope": "database", "ReadData",
"name": "telegraf", "WriteData",
"allowed": [ "ManageShard",
"ViewChronograf", "ManageContinuousQuery",
"ReadData" "ManageQuery",
"ManageSubscription",
"Monitor",
"KapacitorAPI"
] ]
} }
], ],
"roles": [
{
"name": "timetravelers",
"permissions": [
{
"scope": "database",
"name": "telegraf",
"allowed": [
"ReadData",
"WriteData"
]
}
],
"links": {
"self": "/chronograf/v1/sources/3/roles/timetravelers"
}
}
],
"links": { "links": {
"self": "/chronograf/v1/source/1/users/docbrown" "self": "/chronograf/v1/sources/3/users/docbrown"
} }
} }
] ]
@ -2669,21 +2743,43 @@
{ {
"scope": "all", "scope": "all",
"allowed": [ "allowed": [
"ViewAdmin",
"ViewChronograf", "ViewChronograf",
"ReadData" "CreateDatabase",
] "CreateUserAndRole",
}, "DropDatabase",
{ "DropData",
"scope": "database", "ReadData",
"name": "telegraf", "WriteData",
"allowed": [ "ManageShard",
"ViewChronograf", "ManageContinuousQuery",
"ReadData" "ManageQuery",
"ManageSubscription",
"Monitor",
"KapacitorAPI"
] ]
} }
], ],
"roles": [
{
"name": "timetravelers",
"permissions": [
{
"scope": "database",
"name": "telegraf",
"allowed": [
"ReadData",
"WriteData"
]
}
],
"links": {
"self": "/chronograf/v1/sources/3/roles/timetravelers"
}
}
],
"links": { "links": {
"self": "/chronograf/v1/source/1/users/docbrown" "self": "/chronograf/v1/sources/3/users/docbrown"
} }
} }
}, },