Skip to content

Commit 7803297

Browse files
Improve README with missing sections and fixes
Add API Documentation section explaining bundled docs in JARs, Building section with mvn commands, common module to the Modules table, License section, and fix Java version to match pom.xml.
1 parent a7acbf5 commit 7803297

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Auto-generated Java REST clients for ThingsBoard, built from OpenAPI specificati
99
| `ce` | `thingsboard-ce-client` | Community Edition REST client |
1010
| `pe` | `thingsboard-pe-client` | Professional Edition REST client |
1111
| `paas` | `thingsboard-paas-client` | Cloud (PaaS) REST client |
12+
| `common` | `thingsboard-client-common` | Handwritten shared code (not published separately) |
1213

1314
All modules share the same `org.thingsboard.client` group ID and use the `org.thingsboard.client.api` / `org.thingsboard.client.model` packages.
1415

@@ -61,6 +62,23 @@ ThingsboardClient client = ThingsboardClient.builder()
6162
client.login("tenant@thingsboard.org", "tenant");
6263
```
6364

65+
## API Documentation
66+
67+
Each published JAR includes Markdown API documentation bundled under `api-docs/` in the classpath. This covers every controller endpoint (`*ControllerApi.md`) and every model class. To extract the docs from a dependency:
68+
69+
```bash
70+
jar xf thingsboard-ce-client-4.4.0-SNAPSHOT.jar api-docs/
71+
```
72+
73+
The same docs are also available in each edition's `docs/` directory in this repository.
74+
75+
## Building
76+
77+
```bash
78+
mvn compile # Build all modules
79+
mvn compile -pl ce # Build CE only
80+
```
81+
6482
## Project Structure
6583

6684
```
@@ -77,7 +95,7 @@ thingsboard-java-client/
7795
│ ├── pom.xml
7896
│ ├── spec/openapi.json # OpenAPI spec (committed)
7997
│ ├── src/main/java/ # Generated + common sources (committed)
80-
│ ├── docs/ # Generated + common docs (committed)
98+
│ ├── docs/ # Generated API docs + common docs (committed)
8199
│ └── target/generated/ # Raw generator output (gitignored)
82100
├── pe/
83101
│ └── (same structure as ce)
@@ -147,3 +165,7 @@ Options:
147165
- `<edition>/docs/` (with `common/docs/` overlaid on top of generated docs)
148166

149167
Output log: `generate-client.log` (overwritten on each run)
168+
169+
## License
170+
171+
This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)