Skip to content

Commit 0ae015c

Browse files
committed
review feedback
1 parent 2b4b99b commit 0ae015c

File tree

2 files changed

+8
-17
lines changed

2 files changed

+8
-17
lines changed

scripts/generate-sdk/.openapi-generator-ignore-java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ git_push.sh
44
api/openapi.yaml
55
tox.ini
66
**/.github/**
7-
**/AndroidManifest.xml
7+
**/AndroidManifest.xml
8+
pom.xml

templates/java/README.mustache

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,21 @@ This package is part of the STACKIT Java SDK. For additional information, please
1616
## Requirements
1717

1818
Building the API client library requires:
19-
2019
1. Java 1.8+
21-
{{#jersey2}}
22-
2. Maven (3.8.3+)/Gradle (7.2+)
23-
{{/jersey2}}
24-
{{^jersey2}}
25-
2. Maven/Gradle
26-
{{/jersey2}}
2720

2821
## Installation
2922

3023
To install the API client library to your local Maven repository, simply execute:
3124

3225
```shell
33-
mvn clean install
26+
./gradlew publishToMavenLocal
3427
```
3528

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

3831
```shell
39-
mvn clean deploy
32+
# TODO: follow up story
33+
# ./gradlew publishToMavenCentral
4034
```
4135

4236
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
@@ -49,7 +43,7 @@ Add this dependency to your project's POM:
4943
<dependency>
5044
<groupId>{{{groupId}}}</groupId>
5145
<artifactId>{{{artifactId}}}</artifactId>
52-
<version>{{{artifactVersion}}}</version>
46+
<version><SDK_VERSION></version>
5347
<scope>compile</scope>
5448
</dependency>
5549
```
@@ -65,7 +59,7 @@ Add this dependency to your project's build file:
6559
}
6660

6761
dependencies {
68-
implementation "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
62+
implementation "{{{groupId}}}:{{{artifactId}}}:<SDK_VERSION>"
6963
}
7064
```
7165

@@ -79,7 +73,7 @@ mvn clean package
7973

8074
Then manually install the following JARs:
8175

82-
- `target/{{{artifactId}}}-{{{artifactVersion}}}.jar`
76+
- `target/{{{artifactId}}}-<SDK_VERSION>.jar`
8377
- `target/lib/*.jar`
8478

8579
{{#jersey2}}
@@ -194,10 +188,6 @@ Class | Method | HTTP request | Description
194188
{{#models}}{{#model}} - [{{classname}}]({{modelDocPath}}{{classname}}.md)
195189
{{/model}}{{/models}}
196190

197-
<a id="documentation-for-authorization"></a>
198-
199191
## Recommendation
200192

201193
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
202-
203-
## Author

0 commit comments

Comments
 (0)