spike: Look at documenting API validation rules around string/numeric field limits

[danielalmeidaconnellsgroup]

Hi Team

We have experienced an error in production where House Number has a limit of Max 8 characters on the API.

Is there anything detailed as to limits on these fields please so we can ensure we have validation rules to prevent these errors

Specification

• Investigate whether or not it's possible to export the minLength/maxLength etc swagger schema properties from our fluent validation rules. If not, look at the best way of altering our validators to have the limit rules defined in a single place (ie on the model) but still called from the fluent validator. Overall goal is to have the min/max length for strings (similar for numbers also worthwhile here) documented in our swagger spec
• If this is feasible, log implementation ticket. POC in a single service as appropriate

[danielalmeidaconnellsgroup]

@plittlewood-rpt - raised github issue.

[plittlewood-rpt]

Hi @danielalmeidaconnellsgroup the validation rules aren't actually published anywhere at present. We'll discuss and see if there's a sensible way to present this information.

[github-actions[bot]]

This issue has been updated and moved to our ‘Near Term’ column (typically completed within 0 - 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

[github-actions[bot]]

Whilst the nature of this request has been accepted, we are unable to commit to a specified sprint and therefore have assigned this issue to the ‘Long Term’ column (typically completed 9+ months). We will regularly review any issues and where development capacity is available, or work is aligned with our Roadmap, the issue will be updated. For more information on our processes, please click here