Swagger API Inconsistency

Describe your system and processes, and post your config file.
Post Reply
astephon88
Posts: 8
Joined: Tue Sep 02, 2014 3:32 pm
Bot?: No

Swagger API Inconsistency

Post by astephon88 » Mon May 04, 2020 7:10 am

Is the swagger API documentation still actively updated? I ran into some issues with some settings for timers such as their initial value when using the auto generated libraries from Swagger codegen. I realized it's because the Timer model used by the State API is actually different than the Timer model used by the Timer API, but both are documented using the Timer API definition. For the State API, the Timer members are 'used', 'display', 'count_up', 'init', and 'preserve'. In the Timer API, the members are 'name', 'value', 'on', 'enabled', and 'count_up'. I believe I can make the necessary changes to the spec to keep my development going, but figured I would point out the discrepancy so that it could potentially be fixed for the wider public.

astephon88
Posts: 8
Joined: Tue Sep 02, 2014 3:32 pm
Bot?: No

Re: Swagger API Inconsistency

Post by astephon88 » Sat Jul 04, 2020 7:19 am

Also, the "output" member in the "ramp" structure is also incorrect in the documentation. Based on what is returned by the bcs when polling a state, it should be a list of ints named "outputs".

Post Reply

Who is online

Users browsing this forum: No registered users and 2 guests