Skip to main content
Solved

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


Forum|alt.badge.img+9
  • Sidekick (Partner)
  • 85 replies

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”

 

Best answer by shakyes

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

View original
Did this topic help you find an answer to your question?

4 replies

Forum|alt.badge.img+1
  • Do Gooder (Employee)
  • 3 replies
  • Answer
  • August 16, 2023

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


Forum|alt.badge.img+9
  • Author
  • Sidekick (Partner)
  • 85 replies
  • August 16, 2023

Thanks @shakyes ,

I will add this to Idea Wall.

Best Regards
GaSoGB


Tharin Mahale
Do Gooder (Employee)
Forum|alt.badge.img
  • Do Gooder (Employee)
  • 2 replies
  • August 16, 2023

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

 


Forum|alt.badge.img+9
  • Author
  • Sidekick (Partner)
  • 85 replies
  • August 16, 2023

@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


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings