databay-cli 0.1.0__py3-none-any.whl

databay/operations/warehouse_access_settings.py

@@ -0,0 +1,172 @@
+"""The ``warehouse-access-settings`` 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_SETTINGS_GET = Operation(
+    operation_id='warehouse_access_settings_get',
+    noun='warehouse-access-settings',
+    verb='get',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/settings',
+    summary='Get Settings',
+    description='Return whether personal logins are on, and the default role; no workspace call.',
+    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_settings:AccessSettingsOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-settings get <project_id>',
+    ),
+)
+
+WAREHOUSE_ACCESS_SETTINGS_GET_DEFAULT_ROLE = Operation(
+    operation_id='warehouse_access_settings_get_default_role',
+    noun='warehouse-access-settings',
+    verb='get-default-role',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/default-role',
+    summary='Get Default Role',
+    description='Return the role members with no assignment hold.',
+    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_settings:DefaultRoleOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-settings get-default-role <project_id>',
+    ),
+)
+
+WAREHOUSE_ACCESS_SETTINGS_SET = Operation(
+    operation_id='warehouse_access_settings_set',
+    noun='warehouse-access-settings',
+    verb='set',
+    method='put',
+    path='/api/configstore/projects/{project_id}/warehouse-access/settings',
+    summary='Put Settings',
+    description='Turn personal logins on or off; off disables every personal login in the project until its member rotates it.',
+    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',
+        ),
+    ),
+    body=Body(
+        schema='AccessSettingsPut',
+        fields=(
+            Param(
+                name='personal_logins_enabled',
+                location='body',
+                kind='boolean',
+                required=True,
+                description='Personal Logins Enabled',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_settings:AccessSettingsOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-settings set <project_id> --personal-logins-enabled --yes',
+    ),
+)
+
+WAREHOUSE_ACCESS_SETTINGS_SET_DEFAULT_ROLE = Operation(
+    operation_id='warehouse_access_settings_set_default_role',
+    noun='warehouse-access-settings',
+    verb='set-default-role',
+    method='put',
+    path='/api/configstore/projects/{project_id}/warehouse-access/default-role',
+    summary='Put Default Role',
+    description='Change or clear (``role_id`` null) the default 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',
+        ),
+    ),
+    body=Body(
+        schema='DefaultRolePut',
+        fields=(
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='Revision',
+            ),
+            Param(
+                name='role_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Role Id',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_access_settings:DefaultRoleOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-access-settings set-default-role <project_id> --file default-role.json',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_ACCESS_SETTINGS_GET,
+    WAREHOUSE_ACCESS_SETTINGS_GET_DEFAULT_ROLE,
+    WAREHOUSE_ACCESS_SETTINGS_SET,
+    WAREHOUSE_ACCESS_SETTINGS_SET_DEFAULT_ROLE,
+)

databay/operations/warehouse_login.py

@@ -0,0 +1,308 @@
+"""The ``warehouse-login`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+WAREHOUSE_LOGIN_CREATE = Operation(
+    operation_id='warehouse_login_create',
+    noun='warehouse-login',
+    verb='create',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/personal-logins',
+    summary='Create Personal Login',
+    description="Create the caller's login for one warehouse and return its password, once.\n\n403 ``personal_logins_disabled`` while the project's personal logins are off; a replay of the same\n``Idempotency-Key`` is 409 ``credential_already_issued``, since the password is not stored.",
+    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='LoginCreate',
+        fields=(
+            Param(
+                name='allowed_hosts',
+                location='body',
+                kind='list',
+                required=False,
+                description='IP addresses or networks; null: any',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='db_uuid',
+                location='body',
+                kind='string',
+                required=True,
+                description='Db Uuid',
+            ),
+            Param(
+                name='valid_until',
+                location='body',
+                kind='string',
+                required=False,
+                description='null: the login does not expire',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:IssuedLoginOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-login create <project_id> --db-uuid <db_uuid>',
+    ),
+)
+
+WAREHOUSE_LOGIN_DELETE = Operation(
+    operation_id='warehouse_login_delete',
+    noun='warehouse-login',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/projects/{project_id}/warehouse-access/personal-logins/{principal_id}',
+    summary='Delete Personal Login',
+    description='Delete the login; the warehouse drops 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='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay warehouse-login delete <project_id> <principal_id> --yes',
+    ),
+)
+
+WAREHOUSE_LOGIN_LIST = Operation(
+    operation_id='warehouse_login_list',
+    noun='warehouse-login',
+    verb='list',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/personal-logins',
+    summary='List Personal Logins',
+    description="List the caller's own personal logins in the project.",
+    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_login:WarehouseLoginListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-login list <project_id>',
+    ),
+    columns=(
+        'principal_id',
+        'warehouse_name',
+        'native_username',
+        'state',
+        'valid_until',
+    ),
+)
+
+WAREHOUSE_LOGIN_LIST_MINE = Operation(
+    operation_id='warehouse_login_list_mine',
+    noun='warehouse-login',
+    verb='list-mine',
+    method='get',
+    path='/api/configstore/warehouse-access/my-logins',
+    summary='List Own Logins',
+    description="List the caller's personal logins in every project, in every state.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_login:WarehouseLoginListMineResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-login list-mine',
+    ),
+    columns=(
+        'principal_id',
+        'project_id',
+        'warehouse_name',
+        'native_username',
+        'state',
+        'valid_until',
+    ),
+)
+
+WAREHOUSE_LOGIN_POLICY = Operation(
+    operation_id='warehouse_login_policy',
+    noun='warehouse-login',
+    verb='policy',
+    method='get',
+    path='/api/configstore/warehouse-access/login-policy',
+    summary='Get Login Policy',
+    description='Return how far ahead a login may expire and how many days before expiry it reads as expiring soon.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_login:LoginPolicyOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-login policy',
+    ),
+)
+
+WAREHOUSE_LOGIN_ROTATE = Operation(
+    operation_id='warehouse_login_rotate',
+    noun='warehouse-login',
+    verb='rotate',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/personal-logins/{principal_id}/rotate',
+    summary='Rotate Personal Login',
+    description='Issue a new password, shown once; the old one stops working at the next reconcile.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:IssuedLoginOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-login rotate <project_id> <principal_id> --yes',
+    ),
+)
+
+WAREHOUSE_LOGIN_UPDATE = Operation(
+    operation_id='warehouse_login_update',
+    noun='warehouse-login',
+    verb='update',
+    method='patch',
+    path='/api/configstore/projects/{project_id}/warehouse-access/personal-logins/{principal_id}',
+    summary='Update Personal Login',
+    description="Change the login's expiry or allowed hosts; ``null`` clears one.",
+    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='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=Body(
+        schema='LoginPatch',
+        fields=(
+            Param(
+                name='allowed_hosts',
+                location='body',
+                kind='list',
+                required=False,
+                description='Allowed Hosts',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='valid_until',
+                location='body',
+                kind='string',
+                required=False,
+                description='Valid Until',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:LoginOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-login update <project_id> <principal_id> --valid-until 2027-01-31T00:00:00Z',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_LOGIN_CREATE,
+    WAREHOUSE_LOGIN_DELETE,
+    WAREHOUSE_LOGIN_LIST,
+    WAREHOUSE_LOGIN_LIST_MINE,
+    WAREHOUSE_LOGIN_POLICY,
+    WAREHOUSE_LOGIN_ROTATE,
+    WAREHOUSE_LOGIN_UPDATE,
+)

databay/operations/warehouse_principal.py

@@ -0,0 +1,174 @@
+"""The ``warehouse-principal`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+WAREHOUSE_PRINCIPAL_DISABLE = Operation(
+    operation_id='warehouse_principal_disable',
+    noun='warehouse-principal',
+    verb='disable',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/principals/{principal_id}/disable',
+    summary='Disable Principal',
+    description='Disable a personal or service login: its password stops working at the next reconcile.\n\nThe reason (at most 200 characters, 422 ``disable_reason_too_long``) is kept for admins only.',
+    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='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=Body(
+        schema='DisableIn',
+        fields=(
+            Param(
+                name='reason',
+                location='body',
+                kind='string',
+                required=True,
+                description='Reason',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_principal:PrincipalStateOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-principal disable <project_id> <principal_id> --reason "left the team" --yes',
+    ),
+)
+
+WAREHOUSE_PRINCIPAL_ENABLE = Operation(
+    operation_id='warehouse_principal_enable',
+    noun='warehouse-principal',
+    verb='enable',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/principals/{principal_id}/enable',
+    summary='Enable Principal',
+    description='Lift a disable; the login needs a rotate before it has a password again.\n\n403 ``personal_logins_disabled`` for a personal login while the project has them off.',
+    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='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_principal:PrincipalStateOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-principal enable <project_id> <principal_id>',
+    ),
+)
+
+WAREHOUSE_PRINCIPAL_LIST = Operation(
+    operation_id='warehouse_principal_list',
+    noun='warehouse-principal',
+    verb='list',
+    method='get',
+    path='/api/configstore/warehouse-access/principals',
+    summary='List Principals',
+    description='List every personal and service login of the organization, with who disabled it and why.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_principal:WarehousePrincipalListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-principal list',
+    ),
+    columns=(
+        'principal_id',
+        'project_id',
+        'kind',
+        'holder_id',
+        'warehouse_name',
+        'state',
+    ),
+)
+
+WAREHOUSE_PRINCIPAL_LIST_PROJECT = Operation(
+    operation_id='warehouse_principal_list_project',
+    noun='warehouse-principal',
+    verb='list-project',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/logins',
+    summary='List Project Logins',
+    description="List the project's personal and service logins, with who disabled each one and why.",
+    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_principal:WarehousePrincipalListProjectResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-principal list-project <project_id>',
+    ),
+    columns=(
+        'principal_id',
+        'kind',
+        'holder_id',
+        'warehouse_name',
+        'state',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_PRINCIPAL_DISABLE,
+    WAREHOUSE_PRINCIPAL_ENABLE,
+    WAREHOUSE_PRINCIPAL_LIST,
+    WAREHOUSE_PRINCIPAL_LIST_PROJECT,
+)