JarCasting
JarCasting JarCasting

API Model

This artefact describes the Consumer Data Standards using Java classes and annotations in a way suitable for automatic generation of Open API Specification, documentation, Server Stub, Client Libraries and Reference Test.

License

License

MIT
Categories

Categories

Data
GroupId

GroupId

au.org.consumerdatastandards
ArtifactId

ArtifactId

api-model
Last Version

Last Version

1.1.1
Release Date

Release Date
Type

Type

jar
Description

Description

API Model
This artefact describes the Consumer Data Standards using Java classes and annotations in a way suitable for automatic generation of Open API Specification, documentation, Server Stub, Client Libraries and Reference Test.

Download api-model

Filename Size
api-model-1.1.1.pom
api-model-1.1.1.jar 490 KB
api-model-1.1.1-sources.jar 344 KB
api-model-1.1.1-javadoc.jar 1 MB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/au.org.consumerdatastandards/api-model/ -->
<dependency>
    <groupId>au.org.consumerdatastandards</groupId>
    <artifactId>api-model</artifactId>
    <version>1.1.1</version>
</dependency>
// https://jarcasting.com/artifacts/au.org.consumerdatastandards/api-model/
implementation 'au.org.consumerdatastandards:api-model:1.1.1'
// https://jarcasting.com/artifacts/au.org.consumerdatastandards/api-model/
implementation ("au.org.consumerdatastandards:api-model:1.1.1")
'au.org.consumerdatastandards:api-model:jar:1.1.1'
<dependency org="au.org.consumerdatastandards" name="api-model" rev="1.1.1">
  <artifact name="api-model" type="jar" />
</dependency>
@Grapes(
@Grab(group='au.org.consumerdatastandards', module='api-model', version='1.1.1')
)
libraryDependencies += "au.org.consumerdatastandards" % "api-model" % "1.1.1"
[au.org.consumerdatastandards/api-model "1.1.1"]

Dependencies

compile (2)

Group / Artifact Type Version
org.reflections : reflections jar 0.9.11
org.apache.commons : commons-lang3 jar 3.8.1

test (3)

Group / Artifact Type Version
org.junit.jupiter : junit-jupiter-api jar 5.5.0
org.junit.jupiter : junit-jupiter-engine jar 5.5.0
org.junit.jupiter : junit-jupiter-params jar 5.5.0

Project Modules

There are no modules declared in this project.

java-artefacts

Build Status license version issues

Disclaimer

This collection of Australian Consumer Data Right (CDR) software artefacts includes code written in Java.

The artefacts in this repo are offered without warranty or liability, in accordance with the MIT licence.

The Data Standards Body (DSB) develops these artefacts in the course of its work, in order to perform quality assurance on the Australian Consumer Data Right Standards (Data Standards).

The DSB makes this repo, and its artefacts, public on a non-commercial basis in the interest of supporting the participants in the CDR eco-system.

The resources of the DSB are primarily directed towards assisting the Data Standards Chair for developing the Data Standards.

Consequently, the development work provided on the artefacts in this repo is on a best-effort basis, and the DSB acknowledges the use of these tools alone is not sufficient for, nor should they be relied upon with respect to accreditation, conformance, or compliance purposes.

Software requirements

To run the artefacts, you need to install

  • Java 8
  • Maven 3

How to Build

Navigate to the project folder and execute

mvn install --projects !integration-test

or, if you want to skip the Docker image build step:

mvn install -Ddockerfile.skip=true --projects !integration-test

The --projects !integration-test parameter skips running of the integration tests. You can ommit this parameter if you've built the current version of the project once before and the data-holder is running, so the tests can be run agains it.

Unit tests

The Maven install command runs unit tests as a part of the build. You can re-run the tests any time with:

mvn test

Included Modules

  • client - Java library, reference Implementation of CDS client (Accredited Data Recipient - ADR). Used by client-cli and integration-test
  • client-cli - Command Line Interface tool to access Data Holder endpoints.
  • integration-test - Integration tests to run against Data Holder endpoints.
  • data-holder - Reference Implementation of CDS server (Data Holder).

Rules of engagement

Contributions to this open source project are made by raising issues and contributing code through pull requests.

We ask that all contributors to the Australian Consumer Data Standards repositories comply with the GitHub Community Forum Code of Conduct.

au.org.consumerdatastandards

Consumer Data Standards Australia

Versions

Version
1.1.1
1.0.0
1.0.0-RC7
1.0.0-RC6
1.0.0-RC5
1.0.0-RC4
1.0.0-RC3
1.0.0-RC2
1.0.0-RC1
0.9.6
0.9.5
0.9.4
0.9.3