fabric-rest-api-specs/sqlEndpoint/definitions.json

{
  "swagger": "2.0",
  "info": {
      "version": "v1",
      "title": "SQLEndpoint data types"
  },
  "paths": {},
  "definitions": {
      "SQLEndpoints": {
        "description": "A list of SQL endpoints.",
          "required": ["value"],
          "type": "object",
          "properties": {
              "value": {
                  "description": "A list of SQL endpoints.",
                  "type": "array",
                  "items": {
                      "$ref": "#/definitions/SQLEndpoint"
                  }
              }
          },
          "allOf": [
              {
                  "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
              }
          ]
      },
    "SQLEndpoint": {
        "description": "A SQL endpoint object.",
        "type": "object",
        "required": ["type"],
        "allOf": [
          {
              "$ref": "../common/definitions.json#/definitions/Item"
          }
        ]
    },
    "SqlEndpointRefreshMetadataRequest": {
      "description": "The request payload for refreshing a SQL analytics endpoint.",
      "properties": {
        "timeout": {
          "description": "The amount of time the request can run before timing out. Defaults to 15 minutes, with a maximum of 24 hours.",
          "$ref": "../common/definitions.json#/definitions/Duration"
        },
        "recreateTables": {
          "description": "When set to true, this property instructs the system to drop and recreate all tables on the SQL analytics endpoint during the refresh process. Use this option if you need to fully rebuild tables from their source definitions, for example, to resolve inconsistencies or ensure a clean refresh. When combined with `tables`, the sync state reset is scoped only to the specified tables. The default value is false.",
          "type": "boolean"
        },
        "tables": {
          "description": "When provided, scopes the refresh to only the listed tables. When omitted or empty, all tables are refreshed. Each entry specifies a schema and one or more table names to refresh under that schema. The maximum number of tables that can be synchronized in a single request is 25. Table resolution depends on whether the SQL endpoint's parent item is schema-enabled. For schema-enabled items, tables are resolved using the caller-provided schema. For non-schema-enabled items, all tables resolve under the default schema regardless of the caller-provided schema value; tables under a non-default schema cannot be resolved and will be reported with a `DeltaTableNotFound` error.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/TableDefinition"
          }
        }
      }
    },
    "TableDefinition": {
      "description": "A pair of schema and table names for scoping a selective refresh.",
      "type": "object",
      "required": ["schema", "tableNames"],
      "properties": {
        "schema": {
          "description": "The schema name for table resolution. Must not be a reserved system schema.",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "tableNames": {
          "description": "One or more table names to refresh under the specified schema.",
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          }
        }
      }
    },
    "TableSyncStatuses": {
      "description": "A list of table synchronization statuses.",
      "required": ["value"],
      "type": "object",
      "properties": {
        "value": {
          "description": "A list of table synchronization statuses.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/TableSyncStatus"
          }
        }
      }
    },
    "TableSyncStatus": {
      "description": "A table synchronization status object.",
      "type": "object",
      "required": [
        "tableName",
        "startDateTime",
        "endDateTime",
        "status",
        "lastSuccessfulSyncDateTime"
      ],
      "properties": {
        "tableName": {
          "description": "The name of the table that synchronized. For schema-enabled items, the table name is prefixed with the schema name (e.g., \"schema.tableName\").",
          "type": "string"
        },
        "startDateTime": {
          "description": "The date and time when the table synchronization started in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
          "type": "string",
          "format": "date-time"
        },
        "endDateTime": {
          "description": "The date and time when the table synchronization completed in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
          "type": "string",
          "format": "date-time"
        },
        "error": {
          "description": "The error response details",
          "$ref": "../common/definitions.json#/definitions/ErrorResponseDetails"
        },
        "status": {
          "description": "Whether the table synchronized without errors.",
          "$ref": "#/definitions/SyncStatus"
        },
        "lastSuccessfulSyncDateTime": {
          "description": "The date and time when the table synchronization was successful in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "SyncStatus": {
      "description": "The status of the synchronization operation. Additional SyncStatus types may be added over time.",
      "type": "string",
      "enum": [
        "Success",
        "Failure",
        "NotRun"
      ],
      "x-ms-enum": {
        "name": "SyncStatus",
        "modelAsString": true,
        "values": [
          {
            "value": "Success",
            "description": "Indicates a success."
          },
          {
            "value": "Failure",
            "description": "Indicates a failure."
          },
          {
            "value": "NotRun",
            "description": "Indicates that the operation did not run."
          }
        ]
      }
    },
    "ConnectionStringResponse": {
      "description": "The SQL connection string for the workspace containing this SQL endpoint.",
      "type": "object",
      "properties": {
        "connectionString": {
          "description": "The SQL connection string for the workspace containing this SQL endpoint.",
          "type": "string",
          "readOnly": false
        }
      }
    }
  }
}