databay-cli 0.1.0__py3-none-any.whl

databay/operations/warehouse_access_assignment.py

@@ -0,0 +1,179 @@
+"""The ``warehouse-access-assignment`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+WAREHOUSE_ACCESS_ASSIGNMENT_LIST = Operation(
+    operation_id='warehouse_access_assignment_list',
+    noun='warehouse-access-assignment',
+    verb='list',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/assignments',
+    summary='List Assignments',
+    description="List every holder's explicit roles; a member not listed holds the default role.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_access_assignment:WarehouseAccessAssignmentListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-access-assignment list <project_id>',
+    ),
+    columns=(
+        'holder_kind',
+        'holder_id',
+        'role_ids',
+    ),
+)
+
+WAREHOUSE_ACCESS_ASSIGNMENT_PREVIEW = Operation(
+    operation_id='warehouse_access_assignment_preview',
+    noun='warehouse-access-assignment',
+    verb='preview',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/preview',
+    summary='Preview',
+    description='Show what one holder reads now and with ``role_ids``, and any table conflict; nothing changes.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='AccessPreviewIn',
+        fields=(
+            Param(
+                name='holder_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Holder Id',
+            ),
+            Param(
+                name='holder_kind',
+                location='body',
+                kind='string',
+                required=True,
+                choices=(
+                    'member',
+                    'service',
+                ),
+            ),
+            Param(
+                name='role_ids',
+                location='body',
+                kind='list',
+                required=True,
+                description='the proposed role set; empty is the default role for a member and nothing for a service account',
+                item_kind='string',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_assignment:AccessPreviewOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-assignment preview <project_id> --file preview.json',
+    ),
+)
+
+WAREHOUSE_ACCESS_ASSIGNMENT_SET = Operation(
+    operation_id='warehouse_access_assignment_set',
+    noun='warehouse-access-assignment',
+    verb='set',
+    method='put',
+    path='/api/configstore/projects/{project_id}/warehouse-access/assignments',
+    summary='Put Assignment',
+    description="Replace one holder's roles (revision-checked); 409 ``conflicting_table_rules`` when they clash on a table.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='AssignmentPut',
+        fields=(
+            Param(
+                name='holder_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Holder Id',
+            ),
+            Param(
+                name='holder_kind',
+                location='body',
+                kind='string',
+                required=True,
+                choices=(
+                    'member',
+                    'service',
+                ),
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description="the holder's assignment revision the change is based on; 0 for none",
+            ),
+            Param(
+                name='role_ids',
+                location='body',
+                kind='list',
+                required=True,
+                description="the holder's whole role set; empty clears it",
+                item_kind='string',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_assignment:AssignmentOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-assignment set <project_id> --file assignment.json',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_ACCESS_ASSIGNMENT_LIST,
+    WAREHOUSE_ACCESS_ASSIGNMENT_PREVIEW,
+    WAREHOUSE_ACCESS_ASSIGNMENT_SET,
+)

databay/operations/warehouse_access_role.py

@@ -0,0 +1,473 @@
+"""The ``warehouse-access-role`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+WAREHOUSE_ACCESS_ROLE_CREATE = Operation(
+    operation_id='warehouse_access_role_create',
+    noun='warehouse-access-role',
+    verb='create',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles',
+    summary='Create Role',
+    description='Create an access role with no rules; add them with ``PUT .../rules``.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='AccessRoleCreate',
+        fields=(
+            Param(
+                name='description',
+                location='body',
+                kind='string',
+                required=False,
+                description='Description',
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='Name',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:AccessRoleOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-role create <project_id> --name analysts',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_DELETE = Operation(
+    operation_id='warehouse_access_role_delete',
+    noun='warehouse-access-role',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles/{role_id}',
+    summary='Delete Role',
+    description='Delete a role: its holders lose it now, and the warehouse loses it at the next reconcile.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='role_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Role Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay warehouse-access-role delete <project_id> <role_id> --yes',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_GET_METRICS = Operation(
+    operation_id='warehouse_access_role_get_metrics',
+    noun='warehouse-access-role',
+    verb='get-metrics',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles/{role_id}/metrics',
+    summary='Get Metric Grant',
+    description='Show which semantic-layer metrics the role reads; ``grant`` null means every metric over what it reads.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='role_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Role Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:RoleMetricsOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-role get-metrics <project_id> <role_id>',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_LIST = Operation(
+    operation_id='warehouse_access_role_list',
+    noun='warehouse-access-role',
+    verb='list',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles',
+    summary='List Roles',
+    description="List the project's access roles and their rules.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:WarehouseAccessRoleListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-access-role list <project_id>',
+    ),
+    columns=(
+        'uuid',
+        'name',
+        'scope_mode',
+        'is_default',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_LIST_TABLES = Operation(
+    operation_id='warehouse_access_role_list_tables',
+    noun='warehouse-access-role',
+    verb='list-tables',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/warehouses/{db_uuid}/schema',
+    summary='Warehouse Schema',
+    description='List the tables and columns a rule can name in one warehouse of the project; 503 ``warehouse_unavailable``.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='Db Uuid',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:WarehouseSchemaOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-role list-tables <project_id> <db_uuid>',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_SET_METRICS = Operation(
+    operation_id='warehouse_access_role_set_metrics',
+    noun='warehouse-access-role',
+    verb='set-metrics',
+    method='put',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles/{role_id}/metrics',
+    summary='Put Metric Grant',
+    description="Replace the role's metric grant (revision-checked); names are stored as given, semantic checks them.\n\n``include`` reads only the named metrics, ``exclude`` all but them. Refusals: 422 ``request_invalid`` for a\nname that is not a distinct snake_case identifier; 409 ``access_role_revision_conflict``.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='role_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Role Id',
+        ),
+    ),
+    body=Body(
+        schema='MetricGrantPut',
+        fields=(
+            Param(
+                name='metrics',
+                location='body',
+                kind='list',
+                required=True,
+                description='Metrics',
+                item_kind='string',
+            ),
+            Param(
+                name='mode',
+                location='body',
+                kind='string',
+                required=True,
+                choices=(
+                    'include',
+                    'exclude',
+                ),
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description="the role's revision the change is based on",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:RoleMetricsOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-role set-metrics <project_id> <role_id> --file metrics.json',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_SET_RULES = Operation(
+    operation_id='warehouse_access_role_set_rules',
+    noun='warehouse-access-role',
+    verb='set-rules',
+    method='put',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles/{role_id}/rules',
+    summary='Put Rules',
+    description='Replace the role\'s rules (revision-checked), each checked at write time.\n\nA rule naming a built relation (``built_database``) reads every column of it and may carry a ``row_filter``\nover the relation\'s own columns; the warehouse and the semantic layer both apply it. For example\n``{"db_uuid": "...", "built_database": "...", "table_name": "orders_daily", "row_filter": {"all": [{"column":\n"channel", "op": "in", "value": ["web", "pos"]}, {"column": "country", "op": "is_not_null"}]}}``.\n\nRefusals: 422 ``rule_duplicate_table``, ``rule_scope_invalid``, ``rule_overlap``,\n``rule_warehouse_not_managed``, ``rule_warehouse_not_visible``, ``access_capability_unsupported``,\n``rule_table_unknown``, ``rule_column_unknown``, ``row_filter_invalid``, ``built_table_restricted_upstream``;\n409 ``conflicting_table_rules`` and ``access_role_revision_conflict``.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='role_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Role Id',
+        ),
+    ),
+    body=Body(
+        schema='AccessRulesPut',
+        fields=(
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description="the role's revision the change is based on",
+            ),
+            Param(
+                name='rules',
+                location='body',
+                kind='json',
+                required=True,
+                description="the role's whole rule set",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:AccessRoleOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-role set-rules <project_id> <role_id> --file rules.json',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_SET_SCOPE_MODE = Operation(
+    operation_id='warehouse_access_role_set_scope_mode',
+    noun='warehouse-access-role',
+    verb='set-scope-mode',
+    method='put',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles/{role_id}/scope-mode',
+    summary='Set Scope Mode',
+    description='Switch the default role between every visible warehouse (``all_visible``) and explicit rules.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='role_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Role Id',
+        ),
+    ),
+    body=Body(
+        schema='AccessScopeModePut',
+        fields=(
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='Revision',
+            ),
+            Param(
+                name='scope_mode',
+                location='body',
+                kind='string',
+                required=True,
+                choices=(
+                    'rules',
+                    'all_visible',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:AccessRoleOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-role set-scope-mode <project_id> <role_id> --scope-mode rules --revision 1 --yes',
+    ),
+)
+
+WAREHOUSE_ACCESS_ROLE_UPDATE = Operation(
+    operation_id='warehouse_access_role_update',
+    noun='warehouse-access-role',
+    verb='update',
+    method='patch',
+    path='/api/configstore/projects/{project_id}/warehouse-access/roles/{role_id}',
+    summary='Update Role',
+    description='Rename or redescribe a role (revision-checked).',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='role_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Role Id',
+        ),
+    ),
+    body=Body(
+        schema='AccessRolePatch',
+        fields=(
+            Param(
+                name='description',
+                location='body',
+                kind='string',
+                required=False,
+                description='Description',
+                nullable=True,
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=False,
+                description='Name',
+                nullable=True,
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description="the role's revision the change is based on",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_role:AccessRoleOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-role update <project_id> <role_id> --name finance --revision 1',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_ACCESS_ROLE_CREATE,
+    WAREHOUSE_ACCESS_ROLE_DELETE,
+    WAREHOUSE_ACCESS_ROLE_GET_METRICS,
+    WAREHOUSE_ACCESS_ROLE_LIST,
+    WAREHOUSE_ACCESS_ROLE_LIST_TABLES,
+    WAREHOUSE_ACCESS_ROLE_SET_METRICS,
+    WAREHOUSE_ACCESS_ROLE_SET_RULES,
+    WAREHOUSE_ACCESS_ROLE_SET_SCOPE_MODE,
+    WAREHOUSE_ACCESS_ROLE_UPDATE,
+)