Merge "Document API methods in policy code"

This commit is contained in:
Zuul 2018-06-08 23:34:50 +00:00 committed by Gerrit Code Review
commit dfa49097e0
6 changed files with 28 additions and 25 deletions

View File

@ -21,7 +21,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:definition:post',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Post alarm definition role',
description='Create an alarm definition.',
operations=[
{
'path': '/v2.0/alarm-definitions/',
@ -32,7 +32,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:definition:get',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Get alarm definition role',
description='List or get the details of the specified alarm definition.',
operations=[
{
'path': '/v2.0/alarm-definitions/{alarm_definition_id}',
@ -47,7 +47,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:definition:put',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Put alarm definition role',
description='Update/Replace the specified alarm definition.',
operations=[
{
'path': '/v2.0/alarm-definitions/{alarm_definition_id}',
@ -58,7 +58,8 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:definition:patch',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Patch alarm definition role',
description='Update selected parameters of the specified alarm definition, '
'and enable/disable its actions.',
operations=[
{
'path': '/v2.0/alarm-definitions/{alarm_definition_id}',
@ -69,7 +70,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:definition:delete',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Delete alarm definition role',
description='Delete the specified alarm definition.',
operations=[
{
'path': '/v2.0/alarm-definitions/{alarm_definition_id}',
@ -80,7 +81,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:put',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Put alarm role',
description='Update/Replace the entire state of the specified alarm.',
operations=[
{
'path': '/v2.0/alarms/{alarm_id}',
@ -91,7 +92,8 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:patch',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Patch alarm role',
description='Update selected parameters of a specified alarm,'
' set the alarm state and enable/disable it.',
operations=[
{
'path': '/v2.0/alarms/{alarm_id}',
@ -102,7 +104,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:delete',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Delete alarm role',
description='Delete the specified alarm.',
operations=[
{
'path': '/v2.0/alarms/{alarm_id}',
@ -113,7 +115,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:get',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Get alarm role',
description='List or get the details of the specified alarm.',
operations=[
{
'path': '/v2.0/alarms/',
@ -128,7 +130,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:count',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Count alarm role',
description='Get the number of alarms that match the criteria.',
operations=[
{
'path': '/v2.0/alarms/count/',
@ -139,7 +141,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:alarms:state_history',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Alarm state history role',
description='List alarm state history for alarms.',
operations=[
{
'path': '/v2.0/alarms/state-history',

View File

@ -20,8 +20,8 @@ rules = [
policy.RuleDefault(
name='api:delegate',
check_str=DELEGATE_AUTHORIZED_ROLES,
description='The rules that allowes to access the API on'
' behalf of another tenant role',
description='The rules which allow to access the API on'
' behalf of another tenant.',
)
]

View File

@ -20,7 +20,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:healthcheck',
check_str=HEALTHCHECK_ROLES,
description='Healthcheck role',
description='Check healthiness.',
operations=[
{'path': '/healthcheck', 'method': 'GET'}
]

View File

@ -23,7 +23,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:metrics:get',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Get metrics role',
description='List metrics, measurements, metric statistics or metric names.',
operations=[
{'path': '/v2.0/metrics', 'method': 'GET'},
{'path': '/v2.0/metrics/measurements', 'method': 'GET'},
@ -34,7 +34,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:metrics:post',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + AGENT_AUTHORIZED_ROLES,
description='Post metrics role',
description='Create metrics.',
operations=[
{'path': '/v2.0/metrics', 'method': 'POST'}
]
@ -42,7 +42,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:metrics:dimension:values',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Get metrics dimension values role',
description='List dimension values.',
operations=[
{'path': '/v2.0/metrics/dimensions/names/values', 'method': 'GET'}
]
@ -50,7 +50,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:metrics:dimension:names',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Get metrics dimension names role',
description='List dimension names.',
operations=[
{'path': '/v2.0/metrics/dimensions/names', 'method': 'GET'}
]

View File

@ -22,7 +22,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:notifications:put',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Put notifications role',
description='Update the specified notification method.',
operations=[
{
'path': '/v2.0/notification-methods/{notification_method_id}',
@ -33,7 +33,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:notifications:patch',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Patch notifications role',
description='Update selected parameters of the specified notification method.',
operations=[
{
'path': '/v2.0/notification-methods/{notification_method_id}',
@ -44,7 +44,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:notifications:delete',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Delete notifications role',
description='Delete the specified notification method.',
operations=[
{
'path': '/v2.0/notification-methods/{notification_method_id}',
@ -55,7 +55,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:notifications:get',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Get notifications role',
description='List or get the details of the specified notification method.',
operations=[
{
'path': '/v2.0/notification-methods',
@ -70,7 +70,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:notifications:post',
check_str=DEFAULT_AUTHORIZED_ROLES,
description='Post notifications role',
description='Create a notification method.',
operations=[
{
'path': '/v2.0/notification-methods',
@ -81,7 +81,7 @@ rules = [
policy.DocumentedRuleDefault(
name='api:notifications:type',
check_str=DEFAULT_AUTHORIZED_ROLES + ' or ' + READ_ONLY_AUTHORIZED_ROLES,
description='Get notifications type role',
description='List supported notification method types.',
operations=[
{
'path': '/v2.0/notification-methods/types',

View File

@ -20,7 +20,8 @@ rules = [
policy.DocumentedRuleDefault(
name='api:versions',
check_str=VERSIONS_ROLES,
description='Get versions role',
description='List supported versions '
'or get the details about the specified version of Monasca API.',
operations=[
{'path': '/', 'method': 'GET'},
{'path': '/v2.0', 'method': 'GET'}