Skip to content

Commit 2ebf14d

Browse files
committed
review feedback
1 parent fdcd1c5 commit 2ebf14d

File tree

2 files changed

+37
-389
lines changed

2 files changed

+37
-389
lines changed

services/resourcemanager/README.md

Lines changed: 37 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# stackit-resourcemanager
1+
# stackit-sdk-resourcemanager
22

33
Resource Manager API
4+
45
- API version: 2.0
5-
- Generator version: 7.14.0
66

77
API v2 to manage resource containers - organizations, folders, projects incl. labels
88

@@ -26,29 +26,29 @@ STACKIT projects are needed to use cloud-resources. Projects serve as wrapper fo
2626
STACKIT labels are key-value pairs including a resource container reference. Labels can be defined and attached freely to resource containers by which resources can be organized and queried.
2727
- Policy-based, immutable labels may exists
2828

29-
For more information, please visit [https://support.stackit.cloud/servicedesk](https://support.stackit.cloud/servicedesk)
29+
For more information, please visit [https://support.stackit.cloud/servicedesk](https://support.stackit.cloud/servicedesk)
3030

31-
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
31+
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.
3232

3333

3434
## Requirements
3535

3636
Building the API client library requires:
3737
1. Java 1.8+
38-
2. Maven (3.8.3+)/Gradle (7.2+)
3938

4039
## Installation
4140

4241
To install the API client library to your local Maven repository, simply execute:
4342

4443
```shell
45-
mvn clean install
44+
./gradlew publishToMavenLocal
4645
```
4746

4847
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
4948

5049
```shell
51-
mvn clean deploy
50+
# TODO: follow up story
51+
# ./gradlew publishToMavenCentral
5252
```
5353

5454
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
@@ -60,8 +60,8 @@ Add this dependency to your project's POM:
6060
```xml
6161
<dependency>
6262
<groupId>cloud.stackit</groupId>
63-
<artifactId>stackit-resourcemanager</artifactId>
64-
<version>2.0</version>
63+
<artifactId>stackit-sdk-resourcemanager</artifactId>
64+
<version><SDK_VERSION></version>
6565
<scope>compile</scope>
6666
</dependency>
6767
```
@@ -72,12 +72,12 @@ Add this dependency to your project's build file:
7272

7373
```groovy
7474
repositories {
75-
mavenCentral() // Needed if the 'stackit-resourcemanager' jar has been published to maven central.
76-
mavenLocal() // Needed if the 'stackit-resourcemanager' jar has been published to the local maven repo.
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.
7777
}
7878
7979
dependencies {
80-
implementation "cloud.stackit:stackit-resourcemanager:2.0"
80+
implementation "cloud.stackit:stackit-sdk-resourcemanager:<SDK_VERSION>"
8181
}
8282
```
8383

@@ -91,40 +91,39 @@ mvn clean package
9191

9292
Then manually install the following JARs:
9393

94-
* `target/stackit-resourcemanager-2.0.jar`
95-
* `target/lib/*.jar`
94+
- `target/stackit-sdk-resourcemanager-<SDK_VERSION>.jar`
95+
- `target/lib/*.jar`
9696

9797
## Getting Started
9898

9999
Please follow the [installation](#installation) instruction and execute the following Java code:
100100

101101
```java
102102

103-
// Import classes:
104-
import cloud.stackit.resourcemanager.ApiClient;
105-
import cloud.stackit.resourcemanager.ApiException;
106-
import cloud.stackit.resourcemanager.Configuration;
107-
import cloud.stackit.resourcemanager.model.*;
108-
import cloud.stackit.resourcemanager.api.DefaultApi;
109-
110-
public class Example {
111-
public static void main(String[] args) {
112-
ApiClient defaultClient = Configuration.getDefaultApiClient();
113-
defaultClient.setBasePath("https://resource-manager.api.stackit.cloud");
114-
115-
DefaultApi apiInstance = new DefaultApi(defaultClient);
116-
CreateFolderPayload createFolderPayload = new CreateFolderPayload(); // CreateFolderPayload |
117-
try {
118-
FolderResponse result = apiInstance.createFolder(createFolderPayload);
119-
System.out.println(result);
120-
} catch (ApiException e) {
121-
System.err.println("Exception when calling DefaultApi#createFolder");
122-
System.err.println("Status code: " + e.getCode());
123-
System.err.println("Reason: " + e.getResponseBody());
124-
System.err.println("Response headers: " + e.getResponseHeaders());
125-
e.printStackTrace();
103+
import cloud.stackit.sdk.resourcemanager.*;
104+
import cloud.stackit.sdk.resourcemanager.auth.*;
105+
import cloud.stackit.sdk.resourcemanager.model.*;
106+
import cloud.stackit.sdk.resourcemanager.api.DefaultApi;
107+
108+
public class DefaultApiExample {
109+
110+
public static void main(String[] args) {
111+
ApiClient defaultClient = Configuration.getDefaultApiClient();
112+
defaultClient.setBasePath("https://resource-manager.api.stackit.cloud");
113+
114+
DefaultApi apiInstance = new DefaultApi(defaultClient);
115+
CreateFolderPayload createFolderPayload = new CreateFolderPayload(); // CreateFolderPayload |
116+
try {
117+
FolderResponse result = apiInstance.createFolder(createFolderPayload);
118+
System.out.println(result);
119+
} catch (ApiException e) {
120+
System.err.println("Exception when calling DefaultApi#createFolder");
121+
System.err.println("Status code: " + e.getCode());
122+
System.err.println("Reason: " + e.getResponseBody());
123+
System.err.println("Response headers: " + e.getResponseHeaders());
124+
e.printStackTrace();
125+
}
126126
}
127-
}
128127
}
129128

130129
```
@@ -177,17 +176,6 @@ Class | Method | HTTP request | Description
177176
- [Project](docs/Project.md)
178177

179178

180-
<a id="documentation-for-authorization"></a>
181-
## Documentation for Authorization
182-
183-
Endpoints do not require authorization.
184-
185-
186179
## Recommendation
187180

188181
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
189-
190-
## Author
191-
192-
193-

0 commit comments

Comments
 (0)