Skip to content

Commit f84ea6f

Browse files
committed
fix docs
1 parent ff2667a commit f84ea6f

1 file changed

Lines changed: 22 additions & 11 deletions

File tree

  • api_core/google/api_core

api_core/google/api_core/iam.py

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -170,22 +170,33 @@ def _contains_conditions(self):
170170

171171
@property
172172
def bindings(self):
173-
""":obj:`list` of :obj:`dict`: The policy's bindings list.
173+
"""The policy's list of bindings.
174174
175175
A binding is specified by a dictionary with keys:
176-
role (str): Role that is assigned to `members`.
177-
members (:obj:`set` of str): Specifies the identities associated to this binding.
178-
condition (dict of str:str): Specifies a condition under which this binding will apply.
179-
- title (str): Title for the condition.
180-
- description (:obj:str, optional): Description of the condition.
181-
- expression: A CEL expression.
176+
177+
* role (str): Role that is assigned to `members`.
178+
179+
* members (:obj:`set` of str): Specifies the identities associated to this binding.
180+
181+
* condition (:obj:`dict` of str:str): Specifies a condition under which this binding will apply.
182+
183+
* title (str): Title for the condition.
184+
185+
* description (:obj:str, optional): Description of the condition.
186+
187+
* expression: A CEL expression.
188+
189+
Type:
190+
:obj:`list` of :obj:`dict`
182191
183192
See:
184193
Policy versions https://cloud.google.com/iam/docs/policies#versions
185194
Conditions overview https://cloud.google.com/iam/docs/conditions-overview.
186195
187196
Example:
197+
188198
.. code-block:: python
199+
189200
USER = "user:phred@example.com"
190201
ADMIN_GROUP = "group:admins@groups.example.com"
191202
SERVICE_ACCOUNT = "serviceAccount:account-1234@accounts.example.com"
@@ -199,10 +210,10 @@ def bindings(self):
199210
policy.version = 3
200211
201212
policy.bindings = [
202-
{
203-
"role": "roles/viewer",
204-
"members": {USER, ADMIN_GROUP, SERVICE_ACCOUNT},
205-
"condition": CONDITION
213+
{
214+
"role": "roles/viewer",
215+
"members": {USER, ADMIN_GROUP, SERVICE_ACCOUNT},
216+
"condition": CONDITION
206217
},
207218
...
208219
]

0 commit comments

Comments
 (0)