Add/descriptionexample

[dscervantes]

Adding Descriptions and example for the properties

RHCLOUD-26190

[dscervantes]

[josejulio]

@dscervantes could you show us an example with a response type other than a string?

[dscervantes]

Hm, maybe I am confused about the ask? all of the ones that are in example tag in content.json are "strings" or "integers", since its the developers adding example strings.

[josejulio]

Hm, maybe I am confused about the ask? all of the ones that are in example tag in content.json are "strings" or "integers", since its the developers adding example strings.

mmmh probably - i also didn't saw the example in full detail 🤔

[josejulio]

To clarify, i think that showing an example per-attribute feels off, as you don't have the big picture or something that you could quickly copy and paste.

I would expect something like this (excuse my rustic terrible drawings)

This is similar to what we have now on each request response- It's on the advisor's API

@tahmidefaz @dscervantes what do you think?

[dscervantes]

OH! That makes total sense! So not each attribute but an example for each object and their attributes ? Let me change the ticket to reflect this ! Let me know if that is what we want as a final result!

[tahmidefaz]

To clarify, i think that showing an example per-attribute feels off, as you don't have the big picture or something that you could quickly copy and paste.

I would expect something like this (excuse my rustic terrible drawings)

This is similar to what we have now on each request response- It's on the advisor's API

@tahmidefaz @dscervantes what do you think?

Yep, that makes sense to me. Let's do it 👍