@@ -948,6 +948,10 @@ def followers(self, entity):
948948 def schema_entity_read (self , project_entity = None ):
949949 """Gets all active entities defined in the schema.
950950
951+ :param dict project_entity: Optional, if set, each field's visibility is reported accordingly
952+ to the specified project's current visibility settings.
953+ If None, all fields are reported as visible.
954+
951955 :returns: dict of Entity Type to dict containing the display name.
952956 """
953957
@@ -964,6 +968,10 @@ def schema_entity_read(self, project_entity=None):
964968 def schema_read (self , project_entity = None ):
965969 """Gets the schema for all fields in all entities.
966970
971+ :param dict project_entity: Optional, if set, each field's visibility is reported accordingly
972+ to the specified project's current visibility settings.
973+ If None, all fields are reported as visible.
974+
967975 :returns: nested dicts
968976 """
969977
@@ -988,6 +996,10 @@ def schema_field_read(self, entity_type, field_name=None, project_entity=None):
988996 definition for. If not supplied all fields for the entity type are
989997 returned.
990998
999+ :param dict project_entity: Optional, if set, each field's visibility is reported accordingly
1000+ to the specified project's current visibility settings.
1001+ If None, all fields are reported as visible.
1002+
9911003 :returns: dict of field name to nested dicts which describe the field
9921004 """
9931005
0 commit comments