Question

RESTful APIs - App10 - Max length of a field does not get published to OpenAPI v3 or API Doc.

  • 26 September 2022
  • 0 replies
  • 97 views

Userlevel 2
Badge +8

We have implemented REST webservices for a customer and we want to give detailed information on the interface to the third party that will call it.

What we have not managed to include in it so far is max field lengths.

Even if I put ’maxLength’ property in my .projection file for ’CatalogNo’:


What I see in API Explorer/Document/API Doc:

 

Similarly in OPEN API V3:

 

So the ’required’ attribute gets transferred to these two „documentations” of the interface but, ’maxLength’ is not.

Internallly its working because the OData interface throws error if maxLength is exceeded when sending the REST request:

 "message""The literal 'WM005614444444444444444444444444' does not match the facets' constraints.",

Do you know a solution for how to publish to the caller what the max lengths of the fields are?

 


0 replies

Be the first to reply!

Reply