How to show example values in documentation generated for rest API

I can't figure out how to show sample values in the documentation generated for my REST API.

  1. I have exposed a simple REST API using Outsystems Studio (v11.14.8).
  2. I enabled documentation (REST->myapi->Advanced->Documentation = Yes).
  3. I have created a structure that is returned in the Body of the API call: (application/json)

When I look at the documentation, it looks like this (snippet of the response):

"created" is type Date Time and is showing a sample value.  Everything else is a string (or struct of strings) and I can't figure out how to show a sample value in this view (Example Value) of the documentation.

If I select Model view it shows more detail, including the description as part of the structure definition, which is great, but I really want to generate / show sample values in this Example Value view.

mvp_badge
MVP

Hi Christopher,

I don't think it is possible to show sample values in the generated documentation.

Best what you can do is post an idea for this on www.outsystems.com/ideas.

Maybe people will like your idea, and maybe it gets implemented by OutSystems one day.

Regards,

Daniel

Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.