Solved

IFS Cloud23R1 - Developer Studio Projection/API Doc Viewer sample values for TEXT

  • 16 August 2023
  • 4 replies
  • 63 views
G
Rank
Userlevel 3
Badge +9

Hi All,

Is there any way to define a sample values specially for TEXT fields in the projection attributes so that it can be viewed from API Doc Viewer?
Currently you can only see ‘It is a Text’ but customers prefer a sample value instead.

e.g.
Post Code: “SW1A 0AA”

 

icon

Best answer by shakyes 16 August 2023, 10:30

View original

4 replies

S
Rank
Badge +1

Hi @GaSoGB ,

 

Unfortunately there is no way to customize that value as of now. The value you see is a constant embedded as an example in the OpenAPI specification. 

 

Regards,

Shakye

G
Rank
Userlevel 3
Badge +9

Thanks @shakyes ,

I will add this to Idea Wall.

Best Regards
GaSoGB

Tharin Mahale
Rank
Badge

Hi @GaSoGB ,

 

It is possible to write the apidoc for entity attributes when overriding them in the projection file as shown below.


This will be reflected in the API Doc Viewer as shown below.

Best regards,
Tharin

 

G
Rank
Userlevel 3
Badge +9

@Tharin Mahale 

Thanks , but it is not my requirement.
I want to define a sample value in the payload for TEXT attributes.

Best regards
Gayan

Reply


Terms & ConditionsCookie settings