Feature: Switch to Typespec contract description model

.gitignore

@@ -51,3 +51,4 @@ node_modules/
 .gradle
 @rerun.txt
 test-results
+frontend/test-report.xml

api/src/main/java/io/kafbat/ui/mapper/ClusterMapper.java

@@ -118,6 +118,13 @@ default ConfigSynonymDTO toConfigSynonym(ConfigEntry.ConfigSynonym config) {
 
   ReplicaDTO toReplica(InternalReplica replica);
 
+  @Mapping(target = "connectorsCount", ignore = true)
+  @Mapping(target = "failedConnectorsCount", ignore = true)
+  @Mapping(target = "tasksCount", ignore = true)
+  @Mapping(target = "failedTasksCount", ignore = true)
+  @Mapping(target = "version", ignore = true)
+  @Mapping(target = "commit", ignore = true)
+  @Mapping(target = "clusterId", ignore = true)
   ConnectDTO toKafkaConnect(ClustersProperties.ConnectCluster connect);
 
   List<ClusterDTO.FeaturesEnum> toFeaturesEnum(List<ClusterFeature> features);

api/src/main/java/io/kafbat/ui/mapper/DynamicConfigMapper.java

@@ -7,7 +7,7 @@
 import io.kafbat.ui.model.ApplicationConfigPropertiesAuthOauth2ResourceServerOpaquetokenDTO;
 import io.kafbat.ui.model.ApplicationConfigPropertiesDTO;
 import io.kafbat.ui.model.ApplicationConfigPropertiesKafkaClustersInnerDTO;
-import io.kafbat.ui.model.ApplicationConfigPropertiesRbacRolesInnerPermissionsInnerDTO;
+import io.kafbat.ui.model.RbacPermissionDTO;
 import io.kafbat.ui.model.rbac.Permission;
 import io.kafbat.ui.util.DynamicConfigOperations;
 import java.util.Optional;
@@ -32,7 +32,7 @@ default String map(Resource resource) {
   @Mapping(source = "metrics.store", target = "metrics.store", ignore = true)
   ApplicationConfigPropertiesKafkaClustersInnerDTO map(ClustersProperties.Cluster cluster);
 
-  default Permission map(ApplicationConfigPropertiesRbacRolesInnerPermissionsInnerDTO perm) {
+  default Permission map(RbacPermissionDTO perm) {
     Permission permission = new Permission();
     permission.setResource(perm.getResource().getValue());
     permission.setActions(perm.getActions().stream().map(ActionDTO::getValue).toList());

api/src/test/java/io/kafbat/ui/service/mcp/McpSpecificationGeneratorTest.java

@@ -87,7 +87,7 @@ void testConvertController() {
                 "clusterName", Map.of("type", "string"),
                 "topicName", Map.of("type", "string"),
                 "topicUpdate", SCHEMA_GENERATOR.generateSchema(TopicUpdateDTO.class)
-            ), List.of("clusterName", "topicName"), false, null, null)
+            ), List.of("clusterName", "topicName", "topicUpdate"), false, null, null)
         )
     );
     assertThat(tools).allMatch(tool ->

build.gradle

@@ -35,6 +35,7 @@ ext {
     release = resolveBooleanProperty("release")
     includeFrontend = resolveBooleanProperty("include-frontend", release)
     buildDockerImages = resolveBooleanProperty("build-docker-images", release)
+    useTypeSpec = resolveBooleanProperty("typespec", true)
     runE2e = resolveBooleanProperty("run-e2e")
 }
 

contract-typespec/api/acls.tsp

@@ -0,0 +1,143 @@
+import "@typespec/openapi";
+
+namespace Api;
+
+using TypeSpec.Http;
+using OpenAPI;
+
+@route("/api/clusters/{clusterName}/acls")
+@tag("Acls")
+interface AclApi {
+  @summary("listKafkaAcls")
+  @get
+  @operationId("listAcls")
+  listAcls(
+    @path clusterName: string,
+    @query resourceType?: KafkaAclResourceType,
+    @query resourceName?: string,
+    @query namePatternType?: KafkaAclNamePatternType,
+    @query search?: string
+  ): KafkaAcl[];
+
+  @route("/csv")
+  @summary("getAclAsCsv")
+  @get
+  @operationId("getAclAsCsv")
+  getAclAsCsv(@path clusterName: string): string;
+
+  @route("/csv")
+  @summary("syncAclsCsv")
+  @post
+  @operationId("syncAclsCsv")
+  syncAclsCsv(@path clusterName: string, @body content: string): void | ApiBadRequestResponse;
+
+  @post
+  @operationId("createAcl")
+  @summary("createAcl")
+  createAcl(@path clusterName: string, @body acl: KafkaAcl): void | ApiBadRequestResponse;
+
+  @summary("deleteAcl")
+  @delete
+  @operationId("deleteAcl")
+  @summary("deleteAcl")
+  deleteAcl(
+    @path clusterName: string,
+    @body acl: KafkaAcl,
+  ): void | ApiNotFoundResponse;
+
+  @route("/consumer")
+  @post
+  @operationId("createConsumerAcl")
+  @summary("createConsumerAcl")
+  createConsumerAcl(
+    @path clusterName: string,
+    @body payload: CreateConsumerAcl,
+  ): void | ApiBadRequestResponse;
+
+  @route("/producer")
+  @summary("createProducerAcl")
+  @operationId("createProducerAcl")
+  @post
+  createProducerAcl(
+    @path clusterName: string,
+    @body payload: CreateProducerAcl,
+  ): void | ApiBadRequestResponse;
+
+  @route("/streamapp")
+  @summary("createStreamAppAcl")
+  @post
+  @operationId("createStreamAppAcl")
+  createStreamAppAcl(
+    @path clusterName: string,
+    @body payload: CreateStreamAppAcl,
+  ): void | ApiBadRequestResponse;
+}
+
+model KafkaAcl {
+  resourceType: KafkaAclResourceType;
+  resourceName: string; // "*" if acl can be applied to any resource of given type
+  namePatternType: KafkaAclNamePatternType;
+  principal: string;
+  host: string;
+  operation:  KafkaAclOpeations;
+  permission: "ALLOW" | "DENY";
+}
+
+alias KafkaAclOpeations =
+  "UNKNOWN"
+  | "ALL"
+  | "READ"
+  | "WRITE"
+  | "CREATE"
+  | "DELETE"
+  | "ALTER"
+  | "DESCRIBE"
+  | "CLUSTER_ACTION"
+  | "DESCRIBE_CONFIGS"
+  | "ALTER_CONFIGS"
+  | "IDEMPOTENT_WRITE"
+  | "CREATE_TOKENS"
+  | "DESCRIBE_TOKENS";
+
+enum KafkaAclResourceType {
+  UNKNOWN,
+  TOPIC,
+  GROUP,
+  CLUSTER,
+  TRANSACTIONAL_ID,
+  DELEGATION_TOKEN,
+  USER,
+}
+
+enum KafkaAclNamePatternType {
+  MATCH,
+  LITERAL,
+  PREFIXED,
+}
+
+model CreateConsumerAcl {
+  principal?: string;
+  host?: string;
+  topics?: string[];
+  topicsPrefix?: string;
+  consumerGroups?: string[];
+  consumerGroupsPrefix?: string;
+}
+
+model CreateProducerAcl {
+  principal?: string;
+  host?: string;
+  topics?: string[];
+  topicsPrefix?: string;
+  transactionalId?: string;
+  transactionsIdPrefix?: string;
+  idempotent?: boolean = false;
+}
+
+model CreateStreamAppAcl {
+  principal?: string;
+  host?: string;
+  inputTopics?: string[];
+  outputTopics?: string[];
+  applicationId?: string;
+}

contract-typespec/api/auth.tsp

@@ -0,0 +1,46 @@
+import "@typespec/openapi";
+
+namespace Api;
+
+using TypeSpec.Http;
+using OpenAPI;
+
+@tag("Authorization")
+interface AuthorizationApi {
+  @route("/api/authorization")
+  @summary("Get user authorization related info")
+  @operationId("getUserAuthInfo")
+  @get
+  getUserAuthInfo(): AuthenticationInfo;
+}
+
+@route("/login")
+@summary("Authenticate")
+@operationId("authenticate")
+@post
+@tag("Unmapped")
+op authenticate(@header contentType: "application/x-www-form-urlencoded", @body form: LoginForm): void | Http.Response<401>;
+
+
+model LoginForm {
+  username?: string;
+  password?: string;
+}
+
+model AuthenticationInfo {
+  rbacEnabled: boolean; // true if role based access control is enabled and granular permission access is required
+  userInfo?: UserInfo;
+}
+
+model UserInfo {
+  username: string;
+  permissions: UserPermission[];
+}
+
+
+model UserPermission {
+  clusters: string[];
+  resource: ResourceType;
+  value?: string;
+  actions: Action[];
+}

contract-typespec/api/brokers.tsp

@@ -0,0 +1,128 @@
+import "@typespec/openapi";
+
+namespace Api;
+
+using TypeSpec.Http;
+using OpenAPI;
+
+@route("/api/clusters/{clusterName}/brokers")
+@tag("Brokers")
+interface BrokersApi {
+  @get
+  @operationId("getBrokers")
+  @summary("getBrokers")
+  getBrokers(@path clusterName: string): Broker[];
+
+  @get
+  @route("/{id}/configs")
+  @operationId("getBrokerConfig")
+  @summary("getBrokerConfig")
+  getBrokerConfig(@path clusterName: string, @path id: int32): BrokerConfig[];
+
+  @put
+  @route("/{id}/configs/{name}")
+  @operationId("updateBrokerConfigByName")
+  @summary("updateBrokerConfigByName")
+  updateBrokerConfigByName(
+    @path clusterName: string,
+    @path id: int32,
+    @path name: string,
+    @body config: BrokerConfigItem,
+  ): void | ApiBadRequestResponse;
+
+  @get
+  @route("/{id}/metrics")
+  @operationId("getBrokersMetrics")
+  @summary("getBrokersMetrics")
+  getBrokersMetrics(@path clusterName: string, @path id: int32): BrokerMetrics;
+
+  @get
+  @route("/logdirs")
+  @operationId("getAllBrokersLogdirs")
+  @summary("getAllBrokersLogdirs")
+  getAllBrokersLogdirs(
+    @path clusterName: string,
+    @query broker?: int32[],
+  ): BrokersLogdirs[];
+
+  @patch(#{implicitOptionality: true})
+  @route("/{id}/logdirs")
+  @operationId("updateBrokerTopicPartitionLogDir")
+  @summary("updateBrokerTopicPartitionLogDir")
+  updateBrokerTopicPartitionLogDir(
+    @path clusterName: string,
+    @path id: int32,
+    @body update: BrokerLogdirUpdate,
+  ): void | ApiBadRequestResponse;
+}
+
+model Broker {
+  id: int32;
+  host?: string;
+  port?: int32;
+  bytesInPerSec?: float64;
+  bytesOutPerSec?: float64;
+  partitionsLeader?: int32;
+  partitions?: int32;
+  inSyncPartitions?: int32;
+  partitionsSkew?: float64;
+  leadersSkew?: float64;
+}
+
+model BrokerLogdirUpdate {
+  topic?: string;
+  partition?: int32;
+  logDir?: string;
+}
+
+model BrokerConfig {
+  name: string;
+  value: string;
+  source: ConfigSource;
+  isSensitive: boolean;
+  isReadOnly: boolean;
+  synonyms?: ConfigSynonym[];
+}
+
+model BrokerConfigItem {
+  value?: string;
+}
+
+model BrokerLogdirs {
+    name?: string;
+    error?: string;
+    topics?: TopicLogdirs[];
+}
+
+model TopicLogdirs {
+    name?: string;
+    partitions?: TopicPartitionLogdir[];
+}
+
+model BrokerMetrics {
+  segmentSize?: int64;
+  segmentCount?: int32;
+  metrics?: Metric[];
+}
+
+model BrokersLogdirs {
+  name?: string;
+  error?: string;
+  topics?: BrokerTopicLogdirs[];
+}
+
+model BrokerTopicLogdirs {
+  name?: string;
+  partitions?: BrokerTopicPartitionLogdir[];
+}
+
+model BrokerTopicPartitionLogdir {
+  ...TopicPartitionLogdir;
+  broker?: int32;
+}
+
+model TopicPartitionLogdir {
+  partition?: int32;
+  size?: int64;
+  offsetLag?: int64;
+}