databay-cli 0.1.0__py3-none-any.whl

databay/operations/canvas.py

@@ -0,0 +1,136 @@
+"""The ``canvas`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+CANVAS_ACTIVATE = Operation(
+    operation_id='canvas_activate',
+    noun='canvas',
+    verb='activate',
+    method='post',
+    path='/api/cdc/canvases/{project_id}/activate',
+    summary='Activate',
+    description='',
+    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='Activate',
+        fields=(
+            Param(
+                name='acknowledge_org_visible',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Acknowledge Org Visible',
+            ),
+            Param(
+                name='item_ids',
+                location='body',
+                kind='list',
+                required=False,
+                description='Item Ids',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='Revision',
+            ),
+            Param(
+                name='secrets',
+                location='body',
+                kind='json',
+                required=False,
+                description='Secrets',
+                secret=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='canvas:ActivationOut',
+        shape='object',
+    ),
+    examples=(
+        'databay canvas activate --revision 7 --item-ids <item_id>',
+    ),
+)
+
+CANVAS_LIST = Operation(
+    operation_id='canvas_list',
+    noun='canvas',
+    verb='list',
+    method='get',
+    path='/api/cdc/canvases',
+    summary='Summaries',
+    description='One entry for every project the caller can view: canvas revision, live pipes and drafts.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='canvas:CanvasListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay canvas list',
+    ),
+)
+
+CANVAS_VOLUMES = Operation(
+    operation_id='canvas_volumes',
+    noun='canvas',
+    verb='volumes',
+    method='get',
+    path='/api/cdc/canvases/{project_id}/volumes',
+    summary='Volumes',
+    description='Rows in warehouse per live pipe. Always 200; unmeasured pipes carry a code.',
+    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='canvas:ProjectVolumes',
+        shape='object',
+    ),
+    examples=(
+        'databay canvas volumes',
+    ),
+)
+
+OPERATIONS = (
+    CANVAS_ACTIVATE,
+    CANVAS_LIST,
+    CANVAS_VOLUMES,
+)

databay/operations/canvas_graph.py

@@ -0,0 +1,102 @@
+"""The ``canvas-graph`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+CANVAS_GRAPH_GET = Operation(
+    operation_id='canvas_graph_get',
+    noun='canvas-graph',
+    verb='get',
+    method='get',
+    path='/api/cdc/canvases/{project_id}/graph',
+    summary='Get Graph',
+    description='',
+    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='canvas_graph:ProjectGraphOut',
+        shape='object',
+    ),
+    examples=(
+        'databay canvas-graph get',
+    ),
+)
+
+CANVAS_GRAPH_PUT = Operation(
+    operation_id='canvas_graph_put',
+    noun='canvas-graph',
+    verb='put',
+    method='put',
+    path='/api/cdc/canvases/{project_id}/graph',
+    summary='Save Graph',
+    description='',
+    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='X-Realtime-Conn-Id',
+            location='header',
+            kind='string',
+            required=False,
+            description='X-Realtime-Conn-Id',
+            nullable=True,
+        ),
+    ),
+    body=Body(
+        schema='GraphSave',
+        fields=(
+            Param(
+                name='graph',
+                location='body',
+                kind='json',
+                required=True,
+                secret=True,
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='Revision',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='canvas_graph:ProjectGraphOut',
+        shape='object',
+    ),
+    examples=(
+        'databay canvas-graph put --file graph.json --yes',
+    ),
+)
+
+OPERATIONS = (
+    CANVAS_GRAPH_GET,
+    CANVAS_GRAPH_PUT,
+)

databay/operations/canvas_table_check.py

@@ -0,0 +1,101 @@
+"""The ``canvas-table-check`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+CANVAS_TABLE_CHECK_GET = Operation(
+    operation_id='canvas_table_check_get',
+    noun='canvas-table-check',
+    verb='get',
+    method='get',
+    path='/api/cdc/canvases/{project_id}/table-checks/{run_id}',
+    summary='Table Check Get',
+    description="One check run as it is now, each failing table's SQL under its row. Past its retention: 404.",
+    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='run_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Run Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='canvas_table_check:TableCheckRunOut',
+        shape='object',
+    ),
+    examples=(
+        'databay canvas-table-check get <project_id> <run_id>',
+    ),
+)
+
+CANVAS_TABLE_CHECK_START = Operation(
+    operation_id='canvas_table_check_start',
+    noun='canvas-table-check',
+    verb='start',
+    method='post',
+    path='/api/cdc/canvases/{project_id}/table-checks',
+    summary='Table Check Start',
+    description="Start checking tables on a source and answer at once, with the run's id, one row per table and its deadlines.\n\nOne bounded call to the source reads every table, in the background, and each result goes on the caller's\n``user:{sub}`` socket channel after it's stored. A run proves nothing for later: activate and ``POST /pipe`` check\nagain. A source that can't be reached ends the run with every row ``unknown`` and ``code``\n``source_check_unreachable``. Refusals: 400 ``source_operation_unsupported`` for a type with no table checks here,\n404 ``resource_not_visible``, 429 ``precheck_rate_limited``, and 503 ``precheck_busy`` or\n``precheck_limiter_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',
+        ),
+    ),
+    body=Body(
+        schema='TableCheckRunStart',
+        fields=(
+            Param(
+                name='source_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='the source the tables are on',
+            ),
+            Param(
+                name='tables',
+                location='body',
+                kind='json',
+                required=True,
+                description='the tables to check',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='canvas_table_check:TableCheckRunOut',
+        shape='object',
+    ),
+    examples=(
+        'databay canvas-table-check start --source-id <source_id> --file <file>',
+    ),
+)
+
+OPERATIONS = (
+    CANVAS_TABLE_CHECK_GET,
+    CANVAS_TABLE_CHECK_START,
+)