Consider whether attribute mapping scheme can be shared publicly

plittlewood-rpt commented 3 years ago

The properties and applicants APIs use a standardised set of attributes based on customer-wide research that was carried out to make it easier for developers to interact with this area of the system. As a result there are a small number of attributes that didn't get included in the mappings. There is currently no way for a developer to know which attributes are not mapped in a particular customer's system, and what they might therefore not be getting sight of. We should discuss whether or not it's feasible to publish mapping information somewhere to aid this facility.

Specification

New page in Gitbook documentation to sensibly display the mappings for all mapped attributes (we can take this from the enumerations in the departments service)

github-actions[bot] commented 2 years ago

This issue has been updated and moved to our ‘Mid Term’ column (typically completed within 5 - 8 months). We will assess the effort required and may outline a technical specification. When we're ready to schedule the issue, it will be moved to the ‘Near Term’ column. For more information on our processes, please click here

github-actions[bot] commented 2 years ago

This issue has been updated and moved to our ‘Near Term’ column (typically completed within 1 - 4 months). We have assessed the effort required and outlined a technical specification - please take the time to review this detail. When we're ready to schedule the issue, it will be assigned to the relevant board where you can continue to track its progress to completion. For more information on our processes, please click here

reapit / foundations

Consider whether attribute mapping scheme can be shared publicly #4946