Page 1 of 1

Swagger API Inconsistency

Posted: Mon May 04, 2020 7:10 am
by astephon88
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.

Re: Swagger API Inconsistency

Posted: Sat Jul 04, 2020 7:19 am
by astephon88
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".

Re: Swagger API Inconsistency

Posted: Fri Jul 23, 2021 4:35 am
by SavageBullBrewery
What url did you use to get the swagger? The one in the docs doesn't seem to load anything.

Re: Swagger API Inconsistency

Posted: Sat Jul 24, 2021 5:22 am
by bbrally