Merge pull request #15125 from thingsboard/feature/openapi-ci

Automatic OpenAPI spec generation

application/pom.xml

@@ -507,6 +507,82 @@
             </plugin>
         </plugins>
     </build>
+    <profiles>
+        <profile>
+            <id>openapi-spec</id>
+            <properties>
+                <pkg.disabled>true</pkg.disabled>
+                <pkg.package.phase>none</pkg.package.phase>
+                <pkg.process-resources.phase>none</pkg.process-resources.phase>
+            </properties>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.springframework.boot</groupId>
+                        <artifactId>spring-boot-maven-plugin</artifactId>
+                        <configuration>
+                            <mainClass>org.thingsboard.server.ThingsboardServerApplication</mainClass>
+                            <jmxPort>9001</jmxPort>
+                        </configuration>
+                        <executions>
+                            <execution>
+                                <id>build-info</id>
+                                <goals><goal>build-info</goal></goals>
+                                <configuration>
+                                    <skip>false</skip>
+                                </configuration>
+                            </execution>
+                            <execution>
+                                <id>openapi-start</id>
+                                <goals><goal>start</goal></goals>
+                                <configuration>
+                                    <skip>false</skip>
+                                    <useTestClasspath>true</useTestClasspath>
+                                    <jvmArguments>-Xmx1024m</jvmArguments>
+                                    <arguments>
+                                        <argument>--spring.config.name=thingsboard</argument>
+                                        <argument>--spring.profiles.active=openapi</argument>
+                                    </arguments>
+                                    <maxAttempts>180</maxAttempts>
+                                    <wait>2000</wait>
+                                </configuration>
+                            </execution>
+                            <execution>
+                                <id>openapi-stop</id>
+                                <goals><goal>stop</goal></goals>
+                                <configuration>
+                                    <skip>false</skip>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                    <plugin>
+                        <groupId>org.springdoc</groupId>
+                        <artifactId>springdoc-openapi-maven-plugin</artifactId>
+                        <version>1.4</version>
+                        <executions>
+                            <execution>
+                                <id>generate-openapi-spec</id>
+                                <goals><goal>generate</goal></goals>
+                            </execution>
+                        </executions>
+                        <configuration>
+                            <apiDocsUrl>http://localhost:8080/v3/api-docs/thingsboard</apiDocsUrl>
+                            <outputFileName>openapi.json</outputFileName>
+                            <outputDir>${project.build.directory}</outputDir>
+                        </configuration>
+                    </plugin>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-surefire-plugin</artifactId>
+                        <configuration>
+                            <skip>true</skip>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
     <repositories>
         <repository>
             <id>jenkins</id>

application/src/main/resources/thingsboard-openapi.properties

@@ -0,0 +1,51 @@
+#
+# Copyright © 2016-2026 The Thingsboard Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Lightweight startup for OpenAPI spec generation.
+# Activated only via: --spring.profiles.active=openapi
+
+spring.main.banner-mode=off
+
+# Testcontainers PostgreSQL
+database.ts.type=sql
+database.ts_latest.type=sql
+spring.datasource.url=jdbc:tc:postgresql:16.6:///thingsboard?TC_DAEMON=true&TC_TMPFS=/testtmpfs:rw&?TC_INITFUNCTION=org.thingsboard.server.dao.PostgreSqlInitializer::initDb
+spring.datasource.driverClassName=org.testcontainers.jdbc.ContainerDatabaseDriver
+spring.datasource.username=postgres
+spring.datasource.password=postgres
+spring.datasource.hikari.maximumPoolSize=5
+spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
+spring.jpa.properties.hibernate.order_by.default_null_ordering=last
+spring.jpa.show-sql=false
+spring.jpa.hibernate.ddl-auto=none
+
+# Disable transports
+transport.http.enabled=false
+transport.mqtt.enabled=false
+transport.coap.enabled=false
+transport.lwm2m.enabled=false
+transport.snmp.enabled=false
+coap.server.enabled=false
+
+# Disable edges, integrations, EDQS
+edges.enabled=false
+integrations.rpc.enabled=false
+service.integrations.supported=NONE
+transport.gateway.dashboard.sync.enabled=false
+queue.edqs.sync.enabled=false
+queue.edqs.api.supported=false
+usage.stats.report.enabled=false
+service.type=monolith

dao/src/test/resources/sql/system-data.sql

@@ -66,3 +66,5 @@ VALUES ( '6eaaefa6-4612-11e7-a919-92ebcb67fe33', 1592576748000 ,'13814000-1dd2-1
         '{"type": "BURST", "batchSize": 1000}',
         '{"type": "SKIP_ALL_FAILURES", "retries": 3, "failurePercentage": 0.0, "pauseBetweenRetries": 3, "maxPauseBetweenRetries": 3}'
 );
+
+INSERT INTO tb_schema_settings (schema_version, product) VALUES (999999000000, 'CE');