Current Status
Build
Tag
Release
Code coverage
License

Consumer Data Right Standards Model

A Java Consumer Data Right Standards Model, generated from the swagger, to help implementing the Consumer Data Right Standards: https://consumerdatastandardsaustralia.github.io/standards. This project is compiled with JDK 11.

Usage

<dependency>
    <groupId>com.forgerock.cdr.standards</groupId>
    <artifactId>cdr-standards-model</artifactId>
    <version>${cdr-standards-model.version}</version>
</dependency>

Class generation

Many of the classes are generated from Swagger documentation. When a new version of Standards API is released, the following steps are performed:

Install swagger codegen cli

On MacOS

1. Install swagger codegen cli using brew

brew install swagger-codegen

1. Run

swagger-codegen generate \
-i {your_json_file or URL} \
-DuseBeanValidation=true -Dmodel --model-package com.forgerock.consumer.data.right.model.{version vx_y_z} \
--group-id com.forgerock.cdr.standards --artifact-id cdr-standards-model -l spring --library spring-boot -o generated

Other systems

1. Download swagger codegen cli from

https://swagger.io/tools/swagger-codegen/download

1. Run

java -jar swagger-codegen-cli-x.x.x.jar generate \
-i {your_json_file or URL} \
-DuseBeanValidation=true -Dmodel --model-package com.forgerock.consumer.data.right.model.{version vx_y_z} \
--group-id com.forgerock.cdr.standards --artifact-id cdr-standards-model -l spring --library spring-boot -o generated

1. Check the generated files and copy them into appropriate source directory. Do not overwrite existing files.
2. Repeat generation for each new swagger json file
3. If using Intelij, run format and optimise imports on newly generated files.
4. Increment the major or minor version in pom.xml
5. Run build to ensure everything compiles and copyrights are generated for new source files.
6. Commit and raise PR.