[ACC-1761] Add entity information to HAL-FORMS entity profile endpoint #297
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The information is based on a config file named 'blueprint/datamodel.json' located under 'src/main/resources'. If the file is missing, no entity information is shown. Entities not present in 'blueprint/datamodel.json' will be skipped and non-existing entities present in 'blueprint/datamodel.json' will be ignored.
|
|
This duplicates a lot of information, changing something will require us to change it in multiple places. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds entity information to HAL-FORMS entity profile endpoint by using a
blueprint/datamodel.jsonconfig file. Everything is read from the file, thePersistentEntitymodel andrest-messages.propertiesare not processed. The new curieblueprint:is used for the entity information profile endpoint only.Currently supported:
blueprint:constraint)blueprint:search-param)blueprint:attributewithin an attribute)blueprint:target-entity)Not supported:
cg:entitylink name and link title)Example from
/profile/invoices(_linksand_templatesnot shown):{ "name" : "customer", "title" : "Client", "description" : "Company or person that acts like a client", "_embedded" : { "blueprint:attribute" : [ { "name" : "id", "type" : "string", "description" : "", "readOnly" : true, "_embedded" : { "blueprint:constraint" : [ ], "blueprint:search-param" : [ ], "blueprint:attribute" : [ ] }, "_links" : { } }, { "name" : "name", "title" : "Customer name", "type" : "string", "description" : "Full name of the customer", "_embedded" : { "blueprint:constraint" : [ ], "blueprint:search-param" : [ ], "blueprint:attribute" : [ ] }, "_links" : { } }, { "name" : "vat", "title" : "VAT number", "type" : "string", "description" : "VAT number of the customer", "required" : true, "_embedded" : { "blueprint:constraint" : [ { "type" : "required" }, { "type" : "unique" } ], "blueprint:search-param" : [ { "name" : "vat", "type" : "case-insensitive-match" } ], "blueprint:attribute" : [ ] }, "_links" : { } }, { "name" : "content", "type" : "object", "description" : "", "_embedded" : { "blueprint:constraint" : [ ], "blueprint:search-param" : [ ], "blueprint:attribute" : [ { "name" : "length", "type" : "long", "description" : "", "readOnly" : true, "_embedded" : { "blueprint:constraint" : [ ], "blueprint:search-param" : [ { "name" : "content.size", "type" : "exact-match" } ], "blueprint:attribute" : [ ] }, "_links" : { } }, { "name" : "mimetype", "type" : "string", "description" : "", "_embedded" : { "blueprint:constraint" : [ ], "blueprint:search-param" : [ { "name" : "content.mimetype", "type" : "exact-match" } ], "blueprint:attribute" : [ ] }, "_links" : { } }, { "name" : "filename", "type" : "string", "description" : "", "_embedded" : { "blueprint:constraint" : [ ], "blueprint:search-param" : [ { "name" : "content.filename", "type" : "exact-match" } ], "blueprint:attribute" : [ ] }, "_links" : { } } ] }, "_links" : { } } ], "blueprint:relation" : [ { "name" : "invoices", "description" : "", "required" : false, "_links" : { "blueprint:target-entity" : { "href" : "http://localhost/profile/invoices" } }, "many_source_per_target" : false, "many_target_per_source" : true } ] } }Example config
/blueprint/datamodel.json:[ { "name": "customer", "title": "Client", "domainType": "com.contentgrid.spring.test.fixture.invoicing.model.Customer", "description": "Company or person that acts like a client", "attributes": [ { "name": "id", "propertyName": "id", "type": "string", "description": "", "readOnly": true, "constraints": [], "search_params": [] }, { "name": "name", "title": "Customer name", "propertyName": "name", "type": "string", "description": "Full name of the customer", "constraints": [], "search_params": [] }, { "name": "vat", "title": "VAT number", "propertyName": "vat", "type": "string", "description": "VAT number of the customer", "constraints": [ { "type": "required" }, { "type": "unique" } ], "search_params": [ { "name": "vat", "type": "case-insensitive-match" } ] }, { "name": "content", "propertyName": "content", "type": "object", "description": "", "constraints": [], "search_params": [], "attributes": [ { "name": "length", "propertyName": "length", "type": "long", "description": "", "readOnly": true, "constraints": [], "search_params": [ { "name": "content.size", "type": "exact-match" } ] }, { "name": "mimetype", "propertyName": "mimetype", "type": "string", "description": "", "constraints": [], "search_params": [ { "name": "content.mimetype", "type": "exact-match" } ] }, { "name": "filename", "propertyName": "filename", "type": "string", "description": "", "constraints": [], "search_params": [ { "name": "content.filename", "type": "exact-match" } ] } ] } ], "relations": [ { "name": "invoices", "propertyName": "invoices", "target_entity": "com.contentgrid.spring.test.fixture.invoicing.model.Invoice", "description": "", "many_source_per_target": false, "many_target_per_source": true } ] }, { "name": "invoice", ... } ]