Experimental API 3 - Versioned Model

[Zejnilovic]

Background

3rd part of the API rewrite.
Approach this as a PoC.
API is enough. Do not touch UI.
Think about where Envelope makes sense

Feature

All of this should be put under profile "api-experimental" in spring or a feature switch

• /{model}
  • GET return list of {model} and maybe latest versions
    • Optional param searchQuery
  • POST create or update {model}
• /{model}/import imports a single entity. Updates or creates
• /{model}/{name}
  • GET Returns list of versions available
  • POST update - full object
  • DELETE disable
• /{model}/{name}/audit-trail gets audit trail
• /{model}/{name}/{version}
  • Or keyword latest
  • GET returns the specific {model}
  • Extra? - POST?PUT to update with partial body?
  • DELETE disables - on {name} might be enough
• /{model}/{name}/{version}/validate gets a validation report
• /{model}/{name}/{version}/properties
  • Get the properties
  • /{propertyName} for specific property then GET and POST
• /{model}/{name}/{version}/used-in
  • Get the list of places this is used in
    - Would something similar be useful on {name}?
• /{model}/{name}/{version}/export
• /datasets/{name}/{version}/rules
  • GET get the rules defined
  • POST create rule ?? Allow position/order to be specified ??
  • /{number or order}
    • GET get the specific rule
    • POST to update the rule
    • DELETE to delete the rule
    • Q: /reorder POST
• /mapping-tables/{name}/{version}/defaults
  • GET all defaults
  • POST create a default
  • /{column name} to get the specific default
    • DELETE to delete the rule
• /schema/{name}/{version}/json
• /schema/{name}/{version}/original-file
• /schema/{name}((/{version}))/upload - this needs a PoC. Do we want 3 endpoints or one?

[dk1844]

Release notes
/api-v3/{datasets|schemas|mapping-tables|property-defintions}/ Rest API V3 added.
Schema is now updatable via entity payload as well (outside of attachment upload).
Includes checks on entities and is to be used externally.
The API is now truly RESTful (endpoint naming, structure, methods, Location header on creating responses).
Also, Swagger API doc reacts to Spring dev profile (JVM arg -Dspring.profiles.active=dev) to show legacy V2 API doc.
Also, /api-v3/{datasets|schemas|mapping-tables|property-definitions/datasets}/{name}/used-in and /api-v3/{datasets|schemas|mapping-tables|property-definitions/datasets}/{name}/{version}/used-in REST API V3 added, the former is used for disable requests to check the dependencies. Entities are now disabled and enabled entirely (all versions).
UsedIn normalization introduced.