Skip to content

Commit 0daa296

Browse files
authored
Resolve VCSWP-19664 (#37)
* Add fix to ApiClient class bug and make changes to README * Add latest changelog entry * Make edits to docs and test file to establish API Client usage standards * Resolve PR comment for changelog file
1 parent e05c80c commit 0daa296

File tree

9 files changed

+492
-800
lines changed

9 files changed

+492
-800
lines changed

.openapi-generator/FILES

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,4 +286,3 @@ src/main/java/com/github/freeclimbapi/auth/ApiKeyAuth.java
286286
src/main/java/com/github/freeclimbapi/auth/Authentication.java
287287
src/main/java/com/github/freeclimbapi/auth/HttpBasicAuth.java
288288
src/main/java/com/github/freeclimbapi/auth/HttpBearerAuth.java
289-
src/test/java/com/github/freeclimbapi/DefaultApiTest.java

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
99

1010
None
1111

12+
<a name="5.3.1"></a>
13+
14+
## [5.3.1] 2023-05-25
15+
16+
### Changed
17+
18+
- Update dependencies related to the ApiClient class
19+
- Establish standard for connecting to the FreeClimb API Client
20+
1221
<a name="5.3.0"></a>
1322

1423
## [5.3.0] 2023-04-27

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Add this dependency to your project's POM:
4040
<dependency>
4141
<groupId>com.github.freeclimbapi</groupId>
4242
<artifactId>freeclimb-java-client</artifactId>
43-
<version>5.3.0</version>
43+
<version>5.3.1</version>
4444
<scope>compile</scope>
4545
</dependency>
4646
```
@@ -56,7 +56,7 @@ Add this dependency to your project's build file:
5656
}
5757
5858
dependencies {
59-
implementation "com.github.freeclimbapi:freeclimb-java-client:5.3.0"
59+
implementation "com.github.freeclimbapi:freeclimb-java-client:5.3.1"
6060
}
6161
```
6262

@@ -70,7 +70,7 @@ mvn clean package
7070

7171
Then manually install the following JARs:
7272

73-
* `target/freeclimb-java-client-5.3.0.jar`
73+
* `target/freeclimb-java-client-5.3.1.jar`
7474
* `target/lib/*.jar`
7575

7676
## Getting Started
@@ -89,13 +89,12 @@ import com.github.freeclimbapi.DefaultApi;
8989

9090
public class Example {
9191
public static void main(String[] args) {
92+
93+
// Configure API client
9294
ApiClient defaultClient = Configuration.getDefaultApiClient();
9395
defaultClient.setBasePath("https://www.freeclimb.com/apiserver");
94-
95-
// Configure HTTP basic authorization: fc
96-
HttpBasicAuth fc = (HttpBasicAuth) defaultClient.getAuthentication("fc");
97-
fc.setAccountId("YOUR_ACCOUNT_ID");
98-
fc.setApiKey("YOUR_API_KEY");
96+
defaultClient.setAccountId("YOUR_ACCOUNT_ID");
97+
defaultClient.setApiKey("YOUR_API_KEY");
9998

10099
DefaultApi apiInstance = new DefaultApi(defaultClient);
101100

@@ -368,4 +367,3 @@ It's recommended to create an instance of `ApiClient` per thread in a multithrea
368367
## Author
369368
370369
371-

build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apply plugin: 'java'
44
apply plugin: 'com.diffplug.spotless'
55

66
group = 'com.github.freeclimbapi'
7-
version = '5.3.0'
7+
version = '5.3.1'
88

99
buildscript {
1010
repositories {
@@ -108,8 +108,8 @@ ext {
108108
dependencies {
109109
implementation 'io.swagger:swagger-annotations:1.5.24'
110110
implementation "com.google.code.findbugs:jsr305:3.0.2"
111-
implementation 'com.squareup.okhttp3:okhttp:4.9.1'
112-
implementation 'com.squareup.okhttp3:logging-interceptor:4.9.1'
111+
implementation 'com.squareup.okhttp3:okhttp:4.9.3'
112+
implementation 'com.squareup.okhttp3:logging-interceptor:4.9.3'
113113
implementation 'com.google.code.gson:gson:2.8.6'
114114
implementation 'io.gsonfire:gson-fire:1.8.4'
115115
implementation 'org.openapitools:jackson-databind-nullable:0.2.1'

build.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "com.github.freeclimbapi",
44
name := "freeclimb-java-client",
5-
version := "5.3.0",
5+
version := "5.3.1",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

0 commit comments

Comments
 (0)