Skip to content

Commit 320284e

Browse files
Generate resourcemanager (#24)
1 parent db419dc commit 320284e

File tree

1 file changed

+36
-34
lines changed

1 file changed

+36
-34
lines changed

services/resourcemanager/README.md

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# stackit-sdk-resourcemanager
2-
3-
Resource Manager API
1+
# STACKIT Java SDK for Resource Manager API
42

53
- API version: 2.0
64

@@ -30,37 +28,56 @@ For more information, please visit [https://support.stackit.cloud/servicedesk](h
3028

3129
This package is part of the STACKIT Java SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-java) of the SDK.
3230

31+
## Installation from Maven Central (recommended)
3332

34-
## Requirements
33+
The release artifacts for this SDK submodule are available on [Maven Central](https://central.sonatype.com/artifact/cloud.stackit.sdk/resourcemanager).
3534

36-
Building the API client library requires:
37-
1. Java SDK (version 11 to 21 should be supported) installed on your system
35+
### Maven users
3836

39-
## Installation
37+
Add this dependency to your project's POM:
4038

41-
To install the API client library to your local Maven repository, simply execute:
39+
```xml
40+
<dependency>
41+
<groupId>cloud.stackit.sdk</groupId>
42+
<artifactId>resourcemanager</artifactId>
43+
<version><SDK_VERSION></version>
44+
<scope>compile</scope>
45+
</dependency>
46+
```
4247

43-
```shell
44-
./gradlew publishToMavenLocal
48+
### Gradle users
49+
50+
Add this dependency to your project's build file:
51+
52+
```groovy
53+
repositories {
54+
mavenCentral()
55+
}
56+
57+
dependencies {
58+
implementation "cloud.stackit.sdk:resourcemanager:<SDK_VERSION>"
59+
}
4560
```
4661

47-
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
62+
## Installation from local build
63+
64+
Building the API client library requires:
65+
1. Java SDK (version 11 to 21 should be supported) installed on your system
66+
67+
To install the API client library to your local Maven repository, simply execute:
4868

4969
```shell
50-
# TODO: follow up story
51-
# ./gradlew publishToMavenCentral
70+
./gradlew services:resourcemanager:publishToMavenLocal
5271
```
5372

54-
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
55-
5673
### Maven users
5774

5875
Add this dependency to your project's POM:
5976

6077
```xml
6178
<dependency>
62-
<groupId>cloud.stackit</groupId>
63-
<artifactId>stackit-sdk-resourcemanager</artifactId>
79+
<groupId>cloud.stackit.sdk</groupId>
80+
<artifactId>resourcemanager</artifactId>
6481
<version><SDK_VERSION></version>
6582
<scope>compile</scope>
6683
</dependency>
@@ -72,33 +89,18 @@ Add this dependency to your project's build file:
7289

7390
```groovy
7491
repositories {
75-
mavenCentral() // Needed if the 'stackit-sdk-resourcemanager' jar has been published to maven central.
76-
mavenLocal() // Needed if the 'stackit-sdk-resourcemanager' jar has been published to the local maven repo.
92+
mavenLocal()
7793
}
7894
7995
dependencies {
80-
implementation "cloud.stackit:stackit-sdk-resourcemanager:<SDK_VERSION>"
96+
implementation "cloud.stackit.sdk:resourcemanager:<SDK_VERSION>"
8197
}
8298
```
8399

84-
### Others
85-
86-
At first generate the JAR by executing:
87-
88-
```shell
89-
mvn clean package
90-
```
91-
92-
Then manually install the following JARs:
93-
94-
- `target/stackit-sdk-resourcemanager-<SDK_VERSION>.jar`
95-
- `target/lib/*.jar`
96-
97100
## Getting Started
98101

99102
See the [resourcemanager examples](https://github.com/stackitcloud/stackit-sdk-java/tree/main/examples/resourcemanager/src/main/java/cloud/stackit/sdk/resourcemanager/examples).
100103

101-
102104
## Recommendation
103105

104106
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

0 commit comments

Comments
 (0)