USACE / cwms-data-api

Corps Water Management System RESTful Data Service
MIT License
14 stars 14 forks source link

Set examples in the placeholder and in the swagger description of each endpoint #911

Open krowvin opened 1 month ago

krowvin commented 1 month ago

In the Swagger UI the input box has the same placeholder as the label name.

I wanted to bring the question up if we could use an actual value for the placeholder

For example

Timeseries would have

Name: [ KEYS.Elev.Inst.1Hour.0.Ccp-Rev ] 
Office: [ SWT ] 
Begin: [ 2022-10-11T00:00:00-05:00 ] 

It might also be worthwhile to make sure there is an example block beneath each of the text?

I know we have example payload but those tend to show string (I think we talked about this once before)

MikeNeilson commented 1 month ago

I've been investigating this behavior. I think it's doable but have difficulty getting it to work every time I've tried.

krowvin commented 1 month ago

this behavior.

Placeholders or the schema/responses field bodies below the input boxes?

MikeNeilson commented 1 month ago

Both.