summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBrian Rosmaita <rosmaita.fossdev@gmail.com>2018-11-26 15:15:26 -0500
committerBrian Rosmaita <rosmaita.fossdev@gmail.com>2018-11-26 15:15:26 -0500
commit64f3501c0e56570066e7bd1e723a0ebef44af3be (patch)
tree13127da1243de1c9ea9f68e8984c99b9d081da6c /doc
parenta10275772627caad4c4fa66effa26ecd2a6ecd7b (diff)
downloadoslo-policy-64f3501c0e56570066e7bd1e723a0ebef44af3be.tar.gz
Correct typo in docs
In the "special checks" section, 'role' and 'rule' are keywords and should not be enclosed in '< >'. Change-Id: Ia3c1b47f1c8452bcca62961de4414d21d7ebf481
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/policy-json-file.rst4
-rw-r--r--doc/source/admin/policy-yaml-file.rst4
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/source/admin/policy-json-file.rst b/doc/source/admin/policy-json-file.rst
index b5356a8..8d918d8 100644
--- a/doc/source/admin/policy-json-file.rst
+++ b/doc/source/admin/policy-json-file.rst
@@ -194,10 +194,10 @@ Rules can be:
Special checks are:
-- ``<role>:<role name>``, a test whether the API credentials contain
+- ``role:<role name>``, a test whether the API credentials contain
this role.
-- ``<rule>:<rule name>``, the definition of an alias.
+- ``rule:<rule name>``, the definition of an alias.
- ``http:<target URL>``, which delegates the check to a remote server.
The API is authorized when the server returns True.
diff --git a/doc/source/admin/policy-yaml-file.rst b/doc/source/admin/policy-yaml-file.rst
index 057f493..0018f8a 100644
--- a/doc/source/admin/policy-yaml-file.rst
+++ b/doc/source/admin/policy-yaml-file.rst
@@ -186,10 +186,10 @@ Rules can be:
Special checks are:
-- ``<role>:<role name>``, a test whether the API credentials contain
+- ``role:<role name>``, a test whether the API credentials contain
this role.
-- ``<rule>:<rule name>``, the definition of an alias.
+- ``rule:<rule name>``, the definition of an alias.
- ``http:<target URL>``, which delegates the check to a remote server.
The API is authorized when the server returns True.