diff --git a/docs/_includes/generated/rest_v1_dispatcher.html b/docs/_includes/generated/rest_v1_dispatcher.html index c515225111034..113c37e480aae 100644 --- a/docs/_includes/generated/rest_v1_dispatcher.html +++ b/docs/_includes/generated/rest_v1_dispatcher.html @@ -67,21 +67,6 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration", "properties" : { - "refresh-interval" : { - "type" : "integer" - }, - "timezone-name" : { - "type" : "string" - }, - "timezone-offset" : { - "type" : "integer" - }, - "flink-version" : { - "type" : "string" - }, - "flink-revision" : { - "type" : "string" - }, "features" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration:Features", @@ -90,6 +75,21 @@ "type" : "boolean" } } + }, + "flink-revision" : { + "type" : "string" + }, + "flink-version" : { + "type" : "string" + }, + "refresh-interval" : { + "type" : "integer" + }, + "timezone-name" : { + "type" : "string" + }, + "timezone-offset" : { + "type" : "integer" } } } @@ -141,29 +141,29 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarFileInfo", "properties" : { - "id" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "uploaded" : { - "type" : "integer" - }, "entry" : { "type" : "array", "items" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarEntryInfo", "properties" : { - "name" : { + "description" : { "type" : "string" }, - "description" : { + "name" : { "type" : "string" } } } + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "uploaded" : { + "type" : "integer" } } } @@ -319,6 +319,12 @@ "entryClass" : { "type" : "string" }, + "jobId" : { + "type" : "any" + }, + "parallelism" : { + "type" : "integer" + }, "programArgs" : { "type" : "string" }, @@ -327,12 +333,6 @@ "items" : { "type" : "string" } - }, - "parallelism" : { - "type" : "integer" - }, - "jobId" : { - "type" : "any" } } } @@ -409,6 +409,12 @@ "entryClass" : { "type" : "string" }, + "jobId" : { + "type" : "any" + }, + "parallelism" : { + "type" : "integer" + }, "programArgs" : { "type" : "string" }, @@ -417,12 +423,6 @@ "items" : { "type" : "string" } - }, - "parallelism" : { - "type" : "integer" - }, - "jobId" : { - "type" : "any" } } } @@ -498,9 +498,18 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunRequestBody", "properties" : { + "allowNonRestoredState" : { + "type" : "boolean" + }, "entryClass" : { "type" : "string" }, + "jobId" : { + "type" : "any" + }, + "parallelism" : { + "type" : "integer" + }, "programArgs" : { "type" : "string" }, @@ -510,15 +519,6 @@ "type" : "string" } }, - "parallelism" : { - "type" : "integer" - }, - "jobId" : { - "type" : "any" - }, - "allowNonRestoredState" : { - "type" : "boolean" - }, "savepointPath" : { "type" : "string" } @@ -726,15 +726,6 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitRequestBody", "properties" : { - "jobGraphFileName" : { - "type" : "string" - }, - "jobJarFileNames" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, "jobArtifactFileNames" : { "type" : "array", "items" : { @@ -749,6 +740,15 @@ } } } + }, + "jobGraphFileName" : { + "type" : "string" + }, + "jobJarFileNames" : { + "type" : "array", + "items" : { + "type" : "string" + } } } } @@ -917,30 +917,39 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo", "properties" : { + "duration" : { + "type" : "integer" + }, + "end-time" : { + "type" : "integer" + }, + "isStoppable" : { + "type" : "boolean" + }, "jid" : { "type" : "any" }, "name" : { "type" : "string" }, - "isStoppable" : { - "type" : "boolean" + "now" : { + "type" : "integer" }, - "state" : { - "type" : "string", - "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ] + "plan" : { + "type" : "string" }, "start-time" : { "type" : "integer" }, - "end-time" : { - "type" : "integer" - }, - "duration" : { - "type" : "integer" + "state" : { + "type" : "string", + "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ] }, - "now" : { - "type" : "integer" + "status-counts" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer" + } }, "timestamps" : { "type" : "object", @@ -954,33 +963,14 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo:JobVertexDetailsInfo", "properties" : { - "id" : { - "type" : "any" - }, - "name" : { - "type" : "string" - }, - "parallelism" : { - "type" : "integer" - }, - "status" : { - "type" : "string", - "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] - }, - "start-time" : { + "duration" : { "type" : "integer" }, "end-time" : { "type" : "integer" }, - "duration" : { - "type" : "integer" - }, - "tasks" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer" - } + "id" : { + "type" : "any" }, "metrics" : { "type" : "object", @@ -992,16 +982,16 @@ "read-bytes-complete" : { "type" : "boolean" }, - "write-bytes" : { + "read-records" : { "type" : "integer" }, - "write-bytes-complete" : { + "read-records-complete" : { "type" : "boolean" }, - "read-records" : { + "write-bytes" : { "type" : "integer" }, - "read-records-complete" : { + "write-bytes-complete" : { "type" : "boolean" }, "write-records" : { @@ -1011,18 +1001,28 @@ "type" : "boolean" } } + }, + "name" : { + "type" : "string" + }, + "parallelism" : { + "type" : "integer" + }, + "start-time" : { + "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] + }, + "tasks" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer" + } } } } - }, - "status-counts" : { - "type" : "object", - "additionalProperties" : { - "type" : "integer" - } - }, - "plan" : { - "type" : "string" } } } @@ -1147,6 +1147,12 @@ "type" : "any" } }, + "serialized-user-task-accumulators" : { + "type" : "object", + "additionalProperties" : { + "type" : "any" + } + }, "user-task-accumulators" : { "type" : "array", "items" : { @@ -1164,12 +1170,6 @@ } } } - }, - "serialized-user-task-accumulators" : { - "type" : "object", - "additionalProperties" : { - "type" : "any" - } } } } @@ -1226,53 +1226,71 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Counts", "properties" : { - "restored" : { + "completed" : { "type" : "integer" }, - "total" : { + "failed" : { "type" : "integer" }, "in_progress" : { "type" : "integer" }, - "completed" : { + "restored" : { "type" : "integer" }, - "failed" : { + "total" : { "type" : "integer" } } }, - "summary" : { - "type" : "object", - "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Summary", - "properties" : { - "state_size" : { - "type" : "object", - "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics", - "properties" : { - "min" : { - "type" : "integer" - }, - "max" : { - "type" : "integer" - }, - "avg" : { - "type" : "integer" - } - } - }, - "end_to_end_duration" : { - "type" : "object", - "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" - }, - "alignment_buffered" : { - "type" : "object", - "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" - } - } - }, - "latest" : { + "history" : { + "type" : "array", + "items" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics", + "properties" : { + "alignment_buffered" : { + "type" : "integer" + }, + "end_to_end_duration" : { + "type" : "integer" + }, + "id" : { + "type" : "integer" + }, + "is_savepoint" : { + "type" : "boolean" + }, + "latest_ack_timestamp" : { + "type" : "integer" + }, + "num_acknowledged_subtasks" : { + "type" : "integer" + }, + "num_subtasks" : { + "type" : "integer" + }, + "state_size" : { + "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] + }, + "tasks" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics" + } + }, + "trigger_timestamp" : { + "type" : "integer" + } + } + } + }, + "latest" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:LatestCheckpoints", "properties" : { @@ -1280,118 +1298,117 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics", "properties" : { - "id" : { + "alignment_buffered" : { "type" : "integer" }, - "status" : { - "type" : "string", - "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] - }, - "is_savepoint" : { + "discarded" : { "type" : "boolean" }, - "trigger_timestamp" : { + "end_to_end_duration" : { "type" : "integer" }, - "latest_ack_timestamp" : { - "type" : "integer" + "external_path" : { + "type" : "string" }, - "state_size" : { + "id" : { "type" : "integer" }, - "end_to_end_duration" : { + "is_savepoint" : { + "type" : "boolean" + }, + "latest_ack_timestamp" : { "type" : "integer" }, - "alignment_buffered" : { + "num_acknowledged_subtasks" : { "type" : "integer" }, "num_subtasks" : { "type" : "integer" }, - "num_acknowledged_subtasks" : { + "state_size" : { "type" : "integer" }, + "status" : { + "type" : "string", + "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] + }, "tasks" : { "type" : "object", "additionalProperties" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics", "properties" : { - "id" : { + "alignment_buffered" : { "type" : "integer" }, - "status" : { - "type" : "string", - "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] - }, - "latest_ack_timestamp" : { + "end_to_end_duration" : { "type" : "integer" }, - "state_size" : { + "id" : { "type" : "integer" }, - "end_to_end_duration" : { + "latest_ack_timestamp" : { "type" : "integer" }, - "alignment_buffered" : { + "num_acknowledged_subtasks" : { "type" : "integer" }, "num_subtasks" : { "type" : "integer" }, - "num_acknowledged_subtasks" : { + "state_size" : { "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] } } } }, - "external_path" : { - "type" : "string" - }, - "discarded" : { - "type" : "boolean" + "trigger_timestamp" : { + "type" : "integer" } } }, - "savepoint" : { - "type" : "object", - "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics" - }, "failed" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:FailedCheckpointStatistics", "properties" : { - "id" : { + "alignment_buffered" : { "type" : "integer" }, - "status" : { - "type" : "string", - "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] + "end_to_end_duration" : { + "type" : "integer" }, - "is_savepoint" : { - "type" : "boolean" + "failure_message" : { + "type" : "string" }, - "trigger_timestamp" : { + "failure_timestamp" : { "type" : "integer" }, - "latest_ack_timestamp" : { + "id" : { "type" : "integer" }, - "state_size" : { - "type" : "integer" + "is_savepoint" : { + "type" : "boolean" }, - "end_to_end_duration" : { + "latest_ack_timestamp" : { "type" : "integer" }, - "alignment_buffered" : { + "num_acknowledged_subtasks" : { "type" : "integer" }, "num_subtasks" : { "type" : "integer" }, - "num_acknowledged_subtasks" : { + "state_size" : { "type" : "integer" }, + "status" : { + "type" : "string", + "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] + }, "tasks" : { "type" : "object", "additionalProperties" : { @@ -1399,11 +1416,8 @@ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics" } }, - "failure_timestamp" : { + "trigger_timestamp" : { "type" : "integer" - }, - "failure_message" : { - "type" : "string" } } }, @@ -1411,64 +1425,50 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:RestoredCheckpointStatistics", "properties" : { - "id" : { - "type" : "integer" + "external_path" : { + "type" : "string" }, - "restore_timestamp" : { + "id" : { "type" : "integer" }, "is_savepoint" : { "type" : "boolean" }, - "external_path" : { - "type" : "string" + "restore_timestamp" : { + "type" : "integer" } } + }, + "savepoint" : { + "type" : "object", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics" } } }, - "history" : { - "type" : "array", - "items" : { - "type" : "object", - "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics", - "properties" : { - "id" : { - "type" : "integer" - }, - "status" : { - "type" : "string", - "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] - }, - "is_savepoint" : { - "type" : "boolean" - }, - "trigger_timestamp" : { - "type" : "integer" - }, - "latest_ack_timestamp" : { - "type" : "integer" - }, - "state_size" : { - "type" : "integer" - }, - "end_to_end_duration" : { - "type" : "integer" - }, - "alignment_buffered" : { - "type" : "integer" - }, - "num_subtasks" : { - "type" : "integer" - }, - "num_acknowledged_subtasks" : { - "type" : "integer" - }, - "tasks" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics" + "summary" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Summary", + "properties" : { + "alignment_buffered" : { + "type" : "object", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" + }, + "end_to_end_duration" : { + "type" : "object", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" + }, + "state_size" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics", + "properties" : { + "avg" : { + "type" : "integer" + }, + "max" : { + "type" : "integer" + }, + "min" : { + "type" : "integer" } } } @@ -1525,35 +1525,35 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo", "properties" : { - "mode" : { - "type" : "any" - }, - "interval" : { - "type" : "integer" - }, - "timeout" : { - "type" : "integer" - }, - "min_pause" : { - "type" : "integer" - }, - "max_concurrent" : { - "type" : "integer" - }, "externalization" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo:ExternalizedCheckpointInfo", "properties" : { - "enabled" : { + "delete_on_cancellation" : { "type" : "boolean" }, - "delete_on_cancellation" : { + "enabled" : { "type" : "boolean" } } }, + "interval" : { + "type" : "integer" + }, + "max_concurrent" : { + "type" : "integer" + }, + "min_pause" : { + "type" : "integer" + }, + "mode" : { + "type" : "any" + }, "state_backend" : { "type" : "string" + }, + "timeout" : { + "type" : "integer" } } } @@ -1607,70 +1607,70 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics", "properties" : { - "id" : { + "alignment_buffered" : { "type" : "integer" }, - "status" : { - "type" : "string", - "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] - }, - "is_savepoint" : { - "type" : "boolean" - }, - "trigger_timestamp" : { + "end_to_end_duration" : { "type" : "integer" }, - "latest_ack_timestamp" : { + "id" : { "type" : "integer" }, - "state_size" : { - "type" : "integer" + "is_savepoint" : { + "type" : "boolean" }, - "end_to_end_duration" : { + "latest_ack_timestamp" : { "type" : "integer" }, - "alignment_buffered" : { + "num_acknowledged_subtasks" : { "type" : "integer" }, "num_subtasks" : { "type" : "integer" }, - "num_acknowledged_subtasks" : { + "state_size" : { "type" : "integer" }, + "status" : { + "type" : "string", + "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] + }, "tasks" : { "type" : "object", "additionalProperties" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics", "properties" : { - "id" : { + "alignment_buffered" : { "type" : "integer" }, - "status" : { - "type" : "string", - "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] - }, - "latest_ack_timestamp" : { + "end_to_end_duration" : { "type" : "integer" }, - "state_size" : { + "id" : { "type" : "integer" }, - "end_to_end_duration" : { + "latest_ack_timestamp" : { "type" : "integer" }, - "alignment_buffered" : { + "num_acknowledged_subtasks" : { "type" : "integer" }, "num_subtasks" : { "type" : "integer" }, - "num_acknowledged_subtasks" : { + "state_size" : { "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] } } } + }, + "trigger_timestamp" : { + "type" : "integer" } } } @@ -1725,98 +1725,102 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails", "properties" : { - "id" : { + "alignment_buffered" : { "type" : "integer" }, - "status" : { - "type" : "string", - "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] - }, - "latest_ack_timestamp" : { + "end_to_end_duration" : { "type" : "integer" }, - "state_size" : { + "id" : { "type" : "integer" }, - "end_to_end_duration" : { + "latest_ack_timestamp" : { "type" : "integer" }, - "alignment_buffered" : { + "num_acknowledged_subtasks" : { "type" : "integer" }, "num_subtasks" : { "type" : "integer" }, - "num_acknowledged_subtasks" : { + "state_size" : { "type" : "integer" }, + "status" : { + "type" : "string", + "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ] + }, + "subtasks" : { + "type" : "array", + "items" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:SubtaskCheckpointStatistics", + "properties" : { + "index" : { + "type" : "integer" + }, + "status" : { + "type" : "string" + } + } + } + }, "summary" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:Summary", "properties" : { - "state_size" : { + "alignment" : { "type" : "object", - "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointAlignment", "properties" : { - "min" : { - "type" : "integer" - }, - "max" : { - "type" : "integer" + "buffered" : { + "type" : "object", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" }, - "avg" : { - "type" : "integer" + "duration" : { + "type" : "object", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" } } }, - "end_to_end_duration" : { - "type" : "object", - "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" - }, "checkpoint_duration" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointDuration", "properties" : { - "sync" : { + "async" : { "type" : "object", "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" }, - "async" : { + "sync" : { "type" : "object", "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" } } }, - "alignment" : { + "end_to_end_duration" : { "type" : "object", - "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointAlignment", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" + }, + "start_delay" : { + "type" : "object", + "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" + }, + "state_size" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics", "properties" : { - "buffered" : { - "type" : "object", - "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" + "avg" : { + "type" : "integer" }, - "duration" : { - "type" : "object", - "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics" + "max" : { + "type" : "integer" + }, + "min" : { + "type" : "integer" } } } } - }, - "subtasks" : { - "type" : "array", - "items" : { - "type" : "object", - "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:SubtaskCheckpointStatistics", - "properties" : { - "index" : { - "type" : "integer" - }, - "status" : { - "type" : "string" - } - } - } } } } @@ -1927,12 +1931,6 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo", "properties" : { - "root-exception" : { - "type" : "string" - }, - "timestamp" : { - "type" : "integer" - }, "all-exceptions" : { "type" : "array", "items" : { @@ -1942,10 +1940,10 @@ "exception" : { "type" : "string" }, - "task" : { + "location" : { "type" : "string" }, - "location" : { + "task" : { "type" : "string" }, "timestamp" : { @@ -1954,6 +1952,12 @@ } } }, + "root-exception" : { + "type" : "string" + }, + "timestamp" : { + "type" : "integer" + }, "truncated" : { "type" : "boolean" } @@ -2008,6 +2012,9 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobExecutionResultResponseBody", "properties" : { + "job-execution-result" : { + "type" : "any" + }, "status" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus", @@ -2019,9 +2026,6 @@ "enum" : [ "IN_PROGRESS", "COMPLETED" ] } } - }, - "job-execution-result" : { - "type" : "any" } } } @@ -2251,6 +2255,9 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult", "properties" : { + "operation" : { + "type" : "any" + }, "status" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus", @@ -2261,9 +2268,6 @@ "enum" : [ "IN_PROGRESS", "COMPLETED" ] } } - }, - "operation" : { - "type" : "any" } } } @@ -2305,11 +2309,11 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointTriggerRequestBody", "properties" : { - "target-directory" : { - "type" : "string" - }, "cancel-job" : { "type" : "boolean" + }, + "target-directory" : { + "type" : "string" } } } @@ -2382,6 +2386,9 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult", "properties" : { + "operation" : { + "type" : "any" + }, "status" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus", @@ -2392,9 +2399,6 @@ "enum" : [ "IN_PROGRESS", "COMPLETED" ] } } - }, - "operation" : { - "type" : "any" } } } @@ -2436,11 +2440,11 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:stop:StopWithSavepointRequestBody", "properties" : { - "targetDirectory" : { - "type" : "string" - }, "drain" : { "type" : "boolean" + }, + "targetDirectory" : { + "type" : "string" } } } @@ -2519,10 +2523,10 @@ "name" : { "type" : "string" }, - "parallelism" : { + "now" : { "type" : "integer" }, - "now" : { + "parallelism" : { "type" : "integer" }, "subtasks" : { @@ -2531,27 +2535,17 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo", "properties" : { - "subtask" : { - "type" : "integer" - }, - "status" : { - "type" : "string", - "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] - }, "attempt" : { "type" : "integer" }, - "host" : { - "type" : "string" - }, - "start-time" : { + "duration" : { "type" : "integer" }, "end-time" : { "type" : "integer" }, - "duration" : { - "type" : "integer" + "host" : { + "type" : "string" }, "metrics" : { "type" : "object", @@ -2563,16 +2557,16 @@ "read-bytes-complete" : { "type" : "boolean" }, - "write-bytes" : { + "read-records" : { "type" : "integer" }, - "write-bytes-complete" : { + "read-records-complete" : { "type" : "boolean" }, - "read-records" : { + "write-bytes" : { "type" : "integer" }, - "read-records-complete" : { + "write-bytes-complete" : { "type" : "boolean" }, "write-records" : { @@ -2583,11 +2577,21 @@ } } }, - "taskmanager-id" : { - "type" : "string" + "start-time" : { + "type" : "integer" }, "start_time" : { "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] + }, + "subtask" : { + "type" : "integer" + }, + "taskmanager-id" : { + "type" : "string" } } } @@ -2717,10 +2721,6 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo", "properties" : { - "status" : { - "type" : "string", - "enum" : [ "deprecated", "ok" ] - }, "backpressure-level" : { "type" : "string", "enum" : [ "ok", "low", "high" ] @@ -2728,21 +2728,25 @@ "end-timestamp" : { "type" : "integer" }, + "status" : { + "type" : "string", + "enum" : [ "deprecated", "ok" ] + }, "subtasks" : { "type" : "array", "items" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo:SubtaskBackPressureInfo", "properties" : { - "subtask" : { - "type" : "integer" - }, "backpressure-level" : { "type" : "string", "enum" : [ "ok", "low", "high" ] }, "ratio" : { "type" : "number" + }, + "subtask" : { + "type" : "integer" } } } @@ -2870,15 +2874,15 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo:SubtaskAccumulatorsInfo", "properties" : { - "subtask" : { - "type" : "integer" - }, "attempt" : { "type" : "integer" }, "host" : { "type" : "string" }, + "subtask" : { + "type" : "integer" + }, "user-accumulators" : { "type" : "array", "items" : { @@ -3014,27 +3018,17 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo", "properties" : { - "subtask" : { - "type" : "integer" - }, - "status" : { - "type" : "string", - "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] - }, "attempt" : { "type" : "integer" }, - "host" : { - "type" : "string" - }, - "start-time" : { + "duration" : { "type" : "integer" }, "end-time" : { "type" : "integer" }, - "duration" : { - "type" : "integer" + "host" : { + "type" : "string" }, "metrics" : { "type" : "object", @@ -3046,16 +3040,16 @@ "read-bytes-complete" : { "type" : "boolean" }, - "write-bytes" : { + "read-records" : { "type" : "integer" }, - "write-bytes-complete" : { + "read-records-complete" : { "type" : "boolean" }, - "read-records" : { + "write-bytes" : { "type" : "integer" }, - "read-records-complete" : { + "write-bytes-complete" : { "type" : "boolean" }, "write-records" : { @@ -3066,11 +3060,21 @@ } } }, - "taskmanager-id" : { - "type" : "string" + "start-time" : { + "type" : "integer" }, "start_time" : { "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] + }, + "subtask" : { + "type" : "integer" + }, + "taskmanager-id" : { + "type" : "string" } } } @@ -3126,27 +3130,17 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo", "properties" : { - "subtask" : { - "type" : "integer" - }, - "status" : { - "type" : "string", - "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] - }, "attempt" : { "type" : "integer" }, - "host" : { - "type" : "string" - }, - "start-time" : { + "duration" : { "type" : "integer" }, "end-time" : { "type" : "integer" }, - "duration" : { - "type" : "integer" + "host" : { + "type" : "string" }, "metrics" : { "type" : "object", @@ -3158,16 +3152,16 @@ "read-bytes-complete" : { "type" : "boolean" }, - "write-bytes" : { + "read-records" : { "type" : "integer" }, - "write-bytes-complete" : { + "read-records-complete" : { "type" : "boolean" }, - "read-records" : { + "write-bytes" : { "type" : "integer" }, - "read-records-complete" : { + "write-bytes-complete" : { "type" : "boolean" }, "write-records" : { @@ -3178,11 +3172,21 @@ } } }, - "taskmanager-id" : { - "type" : "string" + "start-time" : { + "type" : "integer" }, "start_time" : { "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] + }, + "subtask" : { + "type" : "integer" + }, + "taskmanager-id" : { + "type" : "string" } } } @@ -3238,15 +3242,15 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptAccumulatorsInfo", "properties" : { - "subtask" : { - "type" : "integer" - }, "attempt" : { "type" : "integer" }, "id" : { "type" : "string" }, + "subtask" : { + "type" : "integer" + }, "user-accumulators" : { "type" : "array", "items" : { @@ -3392,13 +3396,13 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo:SubtaskTimeInfo", "properties" : { - "subtask" : { + "duration" : { "type" : "integer" }, "host" : { "type" : "string" }, - "duration" : { + "subtask" : { "type" : "integer" }, "timestamps" : { @@ -3477,21 +3481,14 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo:TaskManagersInfo", "properties" : { - "host" : { - "type" : "string" - }, - "status" : { - "type" : "string", - "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] - }, - "start-time" : { + "duration" : { "type" : "integer" }, "end-time" : { "type" : "integer" }, - "duration" : { - "type" : "integer" + "host" : { + "type" : "string" }, "metrics" : { "type" : "object", @@ -3503,16 +3500,16 @@ "read-bytes-complete" : { "type" : "boolean" }, - "write-bytes" : { + "read-records" : { "type" : "integer" }, - "write-bytes-complete" : { + "read-records-complete" : { "type" : "boolean" }, - "read-records" : { + "write-bytes" : { "type" : "integer" }, - "read-records-complete" : { + "write-bytes-complete" : { "type" : "boolean" }, "write-records" : { @@ -3523,6 +3520,13 @@ } } }, + "start-time" : { + "type" : "integer" + }, + "status" : { + "type" : "string", + "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ] + }, "status-counts" : { "type" : "object", "additionalProperties" : { @@ -3625,32 +3629,32 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:legacy:messages:ClusterOverviewWithVersion", "properties" : { - "taskmanagers" : { - "type" : "integer" + "flink-commit" : { + "type" : "string" }, - "slots-total" : { - "type" : "integer" + "flink-version" : { + "type" : "string" }, - "slots-available" : { + "jobs-cancelled" : { "type" : "integer" }, - "jobs-running" : { + "jobs-failed" : { "type" : "integer" }, "jobs-finished" : { "type" : "integer" }, - "jobs-cancelled" : { + "jobs-running" : { "type" : "integer" }, - "jobs-failed" : { + "slots-available" : { "type" : "integer" }, - "flink-version" : { - "type" : "string" + "slots-total" : { + "type" : "integer" }, - "flink-commit" : { - "type" : "string" + "taskmanagers" : { + "type" : "integer" } } } @@ -3755,6 +3759,9 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult", "properties" : { + "operation" : { + "type" : "any" + }, "status" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus", @@ -3765,9 +3772,6 @@ "enum" : [ "IN_PROGRESS", "COMPLETED" ] } } - }, - "operation" : { - "type" : "any" } } } @@ -3816,21 +3820,9 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo", "properties" : { - "id" : { - "type" : "any" - }, - "path" : { - "type" : "string" - }, "dataPort" : { "type" : "integer" }, - "timeSinceLastHeartbeat" : { - "type" : "integer" - }, - "slotsNumber" : { - "type" : "integer" - }, "freeSlots" : { "type" : "integer" }, @@ -3841,16 +3833,28 @@ "cpuCores" : { "type" : "integer" }, - "physicalMemory" : { - "type" : "integer" - }, "freeMemory" : { "type" : "integer" }, "managedMemory" : { "type" : "integer" + }, + "physicalMemory" : { + "type" : "integer" } } + }, + "id" : { + "type" : "any" + }, + "path" : { + "type" : "string" + }, + "slotsNumber" : { + "type" : "integer" + }, + "timeSinceLastHeartbeat" : { + "type" : "integer" } } } @@ -3956,21 +3960,9 @@ "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerDetailsInfo", "properties" : { - "id" : { - "type" : "any" - }, - "path" : { - "type" : "string" - }, "dataPort" : { "type" : "integer" }, - "timeSinceLastHeartbeat" : { - "type" : "integer" - }, - "slotsNumber" : { - "type" : "integer" - }, "freeSlots" : { "type" : "integer" }, @@ -3981,82 +3973,94 @@ "cpuCores" : { "type" : "integer" }, - "physicalMemory" : { - "type" : "integer" - }, "freeMemory" : { "type" : "integer" }, "managedMemory" : { "type" : "integer" + }, + "physicalMemory" : { + "type" : "integer" } } }, + "id" : { + "type" : "any" + }, "metrics" : { "type" : "object", "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo", "properties" : { - "heapUsed" : { + "directCount" : { "type" : "integer" }, - "heapCommitted" : { + "directMax" : { "type" : "integer" }, - "heapMax" : { + "directUsed" : { "type" : "integer" }, - "nonHeapUsed" : { - "type" : "integer" + "garbageCollectors" : { + "type" : "array", + "items" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo", + "properties" : { + "count" : { + "type" : "integer" + }, + "name" : { + "type" : "string" + }, + "time" : { + "type" : "integer" + } + } + } }, - "nonHeapCommitted" : { + "heapCommitted" : { "type" : "integer" }, - "nonHeapMax" : { + "heapMax" : { "type" : "integer" }, - "directCount" : { + "heapUsed" : { "type" : "integer" }, - "directUsed" : { + "mappedCount" : { "type" : "integer" }, - "directMax" : { + "mappedMax" : { "type" : "integer" }, - "mappedCount" : { + "mappedUsed" : { "type" : "integer" }, - "mappedUsed" : { + "memorySegmentsAvailable" : { "type" : "integer" }, - "mappedMax" : { + "memorySegmentsTotal" : { "type" : "integer" }, - "memorySegmentsAvailable" : { + "nonHeapCommitted" : { "type" : "integer" }, - "memorySegmentsTotal" : { + "nonHeapMax" : { "type" : "integer" }, - "garbageCollectors" : { - "type" : "array", - "items" : { - "type" : "object", - "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo", - "properties" : { - "name" : { - "type" : "string" - }, - "count" : { - "type" : "integer" - }, - "time" : { - "type" : "integer" - } - } - } + "nonHeapUsed" : { + "type" : "integer" } } + }, + "path" : { + "type" : "string" + }, + "slotsNumber" : { + "type" : "integer" + }, + "timeSinceLastHeartbeat" : { + "type" : "integer" } } } diff --git a/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java b/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java index dee453b654b7d..a9f31c451258b 100644 --- a/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java +++ b/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java @@ -33,6 +33,7 @@ import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.io.CharacterEscapes; import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.io.SerializedString; import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper; +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.SerializationFeature; import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.module.jsonSchema.JsonSchema; import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator; @@ -90,6 +91,7 @@ public class RestAPIDocGenerator { static { mapper = new ObjectMapper(); mapper.getFactory().setCharacterEscapes(new HTMLCharacterEscapes()); + mapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true); schemaGen = new JsonSchemaGenerator(mapper); }