newly added annotations cause issues for clients consuming the API spec with OpenAPI Generator for Java

[thomas-corte]

Hello,

I'm consuming the spec using OpenAPI Generator to create Java code for accessing the RST API.

Due to the spec changes from #71, I'm now getting compilation errors complaining that a package

org.icann.rst.commons.annotations

doesn't exist. Apparently the annotations create this dependency.

Not sure about other languages, but is there maybe a Java support library that's supposed to be used with this version of the API spec but which isn't published anywhere?

Workarounds for this are to either

• remove the annotations before creating the client code or
• to create own stub versions of the ICANN annotations in the proper package

but both seem awkward for clients seeking to use the API.

[gbicann]

These annotations were added to assist ICANN's software engineers who are building the server-side.

We added some new annotations in the last release but we have had them in the API spec for some time so I guess you are the first person who's been affected by them.

We could probably add a step to the workflow that builds the release that will generate a version without the annotations.

[gbicann]

@thomas-corte the next release will include an "unannotated" version of the API spec file which you can use. In the meantime, the unannotate.pl script can be used to generate an "unannotated" version of the current API spec file.

I will also send you a copy so you don't have to install the Perl stack to generate it :)

[thomas-corte]

Hi Gavin,

thanks for the script and and unannotated version. For the time being I'll stick with the .yaml file (rather than JSON) for better local spec version control. The unaltered .yaml works again in my environment after I added stub versions of the 7 missing Java annotations to my RST client application.