README.md #1

helix-web-services-client

Requirements

Building the API client library requires Maven to be installed.

Installation & Usage

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

mvn install

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

mvn deploy

Refer to the official documentation for more information.

After the client libarary is installed/deployed, you can use it in your Maven project by adding the following to your pom.xml:

<dependency>
    <groupId>com.perforce</groupId>
    <artifactId>helix-web-services-client</artifactId>
    <version>2016.1.0</version>
    <scope>compile</scope>
</dependency>

Recommendation

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

Author

support@perforce.com

# helix-web-services-client

## Requirements

Building the API client library requires [Maven](https://maven.apache.org/) to be installed.

## Installation & Usage

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

```shell
mvn install
```

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

```shell
mvn deploy
```

Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.

After the client libarary is installed/deployed, you can use it in your Maven project by adding the following to your *pom.xml*:

```xml
<dependency>
    <groupId>com.perforce</groupId>
    <artifactId>helix-web-services-client</artifactId>
    <version>2016.1.0</version>
    <scope>compile</scope>
</dependency>

```

## Recommendation

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

## Author

support@perforce.com
# Change User Description Committed
#1 19553 swellard Move and rename clients
//guest/perforce_software/helix-web-services/main/source/clients/2016.1.0/java/README.md
#2 18798 tjuricek Report supported platform versions in the default request, if we accept application/json.

Added a method to the Java client SDK to check if it's a supported version.
#1 18795 tjuricek Use point-release versioning for the client SDKs and installers.
//guest/perforce_software/helix-web-services/main/source/clients/2016.1/java/README.md
#1 18679 tjuricek Revising HWS paths to work primarily at product version 2016.1.

The swagger definitions will primarily work at a major platform release number. We will generate new clients for each major release, and ensure backwards compatibility as time goes on by keeping the older clients around in the tree.

Note: These are JUST URLs, and do not include other revisions we plan on making shortly.
//guest/perforce_software/helix-web-services/main/source/clients/java/README.md
#1 18488 tjuricek Swagger Java client (initial version).

This contains a basic configuration for the java client, which mostly decides package location, etc.

Notably, the license must be ASL under the SmartBear copyright.