Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.18 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.18 KB
Raw

Exhort API Specification

Red Hat Trusted Profile Analyzer API Specification

OpenAPI v3 and v4

Find the OpenAPI definitions for V3 and V4 under the /api folder

Generated data model

The Java and Javascript data models are generated at build time using the openapi-generator-maven-plugin

Run mvn package to generate it.

Use the Java generated data model

The packages are published to the GitHub maven repository. Make sure to add it to your settings or to your project configuration.

<dependency>
  <groupId>com.redhat.ecosystemappeng</groupId>
  <artifactId>exhort-api</artifactId>
  <version>1.0.6-SNAPSHOT</version>
</dependency>

Use the Javascript data model

Configuring NPM to look in GHPR for the RHEcosystemAppEng namespace is done by adding @RHEcosystemAppEng:registry=https://npm.pkg.github.com to .npmrc in the project root or user home.

echo "@RHEcosystemAppEng:registry=https://npm.pkg.github.com" >> .npmrc

Then, add it to your project as follows:

npm install @RHEcosystemAppEng/exhort-javascript-api@1.0.6-SNAPSHOT