Code Monkey home page Code Monkey logo

Comments (3)

bertrand-lorentz avatar bertrand-lorentz commented on September 25, 2024

There were no change in the notice-types/ folder for SDK 1.8.1 or 1.9.1, so the files were left as they were.
We had added the various "sdkVersion" properties in the early days, but since then we've realized that they are redundant and not really useful: it's the version of the SDK as a whole that matters, not what's indicated in each individual file. And mixing files from different versions should be avoided anyways, as they could be inconsistent.

The content of the "metadataDatabase" property is only for us to relate the data in the file to a particular state of our database. So it is not meaningful to consumers of the SDK.

If we had realized this before version 1.0.0, we would probably have removed those properties. But now we have to keep them, as removing them would be technically not backwards compatible.

So when using the SDK, I would recommend to ignore the "sdkVersion" and "metadataDatabase" properties, and only use the SDK version number indicated either in the pom.xml or in the toplevel file "VERSION" (its content is updated automatically when a JAR package is created).

If the above is not an option, could you give more information on why you need to use the version number indicated in the "notice-types/*.json" files ?

from eforms-sdk.

rgannu avatar rgannu commented on September 25, 2024

We are not using the field value explicitly. For filling in the OPT-002-notice we use only the major and minor version as eforms-sdk-1.8.
But, it is confusing when someone see the values in the json files, codelists etc.,

You can mark the ticket as resolved.

from eforms-sdk.

bertrand-lorentz avatar bertrand-lorentz commented on September 25, 2024

Thanks for you feedback. We'll try to clarify the description of those properties in the documentation.

from eforms-sdk.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.