Lack of Swagger slows down testing through the API

[jbe...@soldevelo.com]

Several days ago, Swagger was disabled. For this reason, testing through the API takes several times more time than it used to because I don't have access to any documentation where all endpoints within the application would be listed and described (I mean notably the parameters - which of them are required and what are their accepted values). Can Swagger be re-enabled again until the new tool related to the API that is to be introduced is implemented?

[Mateusz Kwiatkowski]

Hi Joanna,

we have our API documentation build on Jenkins, like in this example. I think it is even better to read than Swagger, only problem is that you cannot send request from this page, but using Postman will  be OK for now. The problem with Swagger is that it requires Git installed on our docker images which we don't want, it could be done until next solution like Rest Console will be intropduced.

On Thu, Feb 15, 2018 at 2:54 PM, <jbe...@soldevelo.com> wrote:

Several days ago, Swagger was disabled. For this reason, testing through the API takes several times more time than it used to because I don't have access to any documentation where all endpoints within the application would be listed and described (I mean notably the parameters - which of them are required and what are their accepted values). Can Swagger be re-enabled again until the new tool related to the API that is to be introduced is implemented?

SolDevelo Sp. z o.o. [LLC] / www.soldevelo.com
Al. Zwycięstwa 96/98, 81-451, Gdynia, Poland
Phone: +48 58 782 45 40 / Fax: +48 58 782 45 41

--
You received this message because you are subscribed to the Google Groups "OpenLMIS Dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to openlmis-dev+unsubscribe@googlegroups.com.
To post to this group, send email to openlm...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/96f05811-bb65-4d80-8bba-36f7209850f2%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

SolDevelo Sp. z o.o. [LLC] / www.soldevelo.com
Al. Zwycięstwa 96/98, 81-451, Gdynia, Poland
Phone: +48 58 782 45 40 / Fax: +48 58 782 45 41

[Josh Zamor]

Hi Johanna,

Building off what Mateusz pointed out about our static api docs, we are using OLMIS-3708 to track resurrecting our live docs (albeit with a different tool).  Just the other day we moved the ticket out of this sprint (47) to the last sprint before release (sprint 49 - our regression testing sprint) so that we continue to focus on functionality in this sprint and next.  I am of the opinion though that if we're slowing down QA or otherwise effecting the quality of QA that we're doing that we should bump the priority of resurrecting our live docs higher. 

Will using postman and our static docs work without any quality/time loss in QA until someone can work on it in 49, or do you have a different recommendation?

Best,
Josh

[jbe...@soldevelo.com]

Hi,

thank you, Mateusz, for providing the link to the documentation. I browsed through it and it seems that it contains all the necessary data to perform tests.

As for the new tool, Josh, of course, testing with the documentation and Postman is still slower than on Swagger where you don't have to add parameters manually but I think that the difference is not so big that it is necessary to introduce the new tool faster. But of course the sooner, the better - if there is enough time to do it sooner than in sprint 49, it would be great.

On Friday, February 16, 2018 at 12:55:38 AM UTC+1, Josh Zamor wrote:

Hi Johanna,

Building off what Mateusz pointed out about our static api docs, we are using OLMIS-3708 to track resurrecting our live docs (albeit with a different tool).  Just the other day we moved the ticket out of this sprint (47) to the last sprint before release (sprint 49 - our regression testing sprint) so that we continue to focus on functionality in this sprint and next.  I am of the opinion though that if we're slowing down QA or otherwise effecting the quality of QA that we're doing that we should bump the priority of resurrecting our live docs higher. 

Will using postman and our static docs work without any quality/time loss in QA until someone can work on it in 49, or do you have a different recommendation?

Best,
Josh

On Thursday, February 15, 2018 at 6:01:38 AM UTC-8, mkwiatkowski wrote:

Hi Joanna,

we have our API documentation build on Jenkins, like in this example. I think it is even better to read than Swagger, only problem is that you cannot send request from this page, but using Postman will  be OK for now. The problem with Swagger is that it requires Git installed on our docker images which we don't want, it could be done until next solution like Rest Console will be intropduced.

On Thu, Feb 15, 2018 at 2:54 PM, <jbe...@soldevelo.com> wrote:

Several days ago, Swagger was disabled. For this reason, testing through the API takes several times more time than it used to because I don't have access to any documentation where all endpoints within the application would be listed and described (I mean notably the parameters - which of them are required and what are their accepted values). Can Swagger be re-enabled again until the new tool related to the API that is to be introduced is implemented?

SolDevelo Sp. z o.o. [LLC] / www.soldevelo.com
Al. Zwycięstwa 96/98, 81-451, Gdynia, Poland
Phone: +48 58 782 45 40 / Fax: +48 58 782 45 41

--
You received this message because you are subscribed to the Google Groups "OpenLMIS Dev" group.

To unsubscribe from this group and stop receiving emails from it, send an email to openlmis-dev...@googlegroups.com.

To post to this group, send email to openlm...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/96f05811-bb65-4d80-8bba-36f7209850f2%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Paweł Gesek]

Is there any way we can hack bringing Swagger back in less than few hours effort? (and without requiring a release of the dev image) If this is something that actually slows dev/qa work down I would vote for putting more priority on solving this sooner rather than later.  

Regards,

Paweł

To unsubscribe from this group and stop receiving emails from it, send an email to openlmis-dev+unsubscribe@googlegroups.com.

To post to this group, send email to openlm...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/e15ac384-f5c4-4f31-86ed-0aa0c71f7554%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

Paweł Gesek
Technical Project Manager
pge...@soldevelo.com / +48 690 020 875

[Nick Reid]

Is it just that the Swagger app isn't working, or is the JSON config that swagger reads all screwy

The thing that always bugged me with the live documentation is dealing with access keys — and a solution to that would be to integrate the OpenLMIS-UI and Swagger together....

^^ and that could be done in 2-3 hours at most....

Nick Reid | nick...@villagereach.org
Software Developer, Information Systems Group

VillageReach Starting at the Last Mile
2900 Eastlake Ave. E, Suite 230, Seattle, WA 98102, USA
CELL: +1.510.410.0020
SKYPE: nickdotreid
www.villagereach.org

---

From: openlm...@googlegroups.com <openlm...@googlegroups.com> on behalf of Paweł Gesek <pge...@soldevelo.com>
Sent: Friday, February 16, 2018 6:54:12 AM
To: OpenLMIS Dev
Subject: Re: [openlmis-dev] Lack of Swagger slows down testing through the API

 

To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/CADt-Nu25QQXpZOgK6PKK%2BxczBUhMHveDw3fcCN_Q17ncCza3JA%40mail.gmail.com.

[Paweł Gesek]

From my understanding the issue is that the builds fail since we don't have git installed in the dev images.

Regards,

Paweł

On Fri, Feb 16, 2018 at 8:59 PM, Nick Reid <nick...@villagereach.org> wrote:

Is it just that the Swagger app isn't working, or is the JSON config that swagger reads all screwy

The thing that always bugged me with the live documentation is dealing with access keys — and a solution to that would be to integrate the OpenLMIS-UI and Swagger together....

^^ and that could be done in 2-3 hours at most....

Nick Reid | nick.reid@villagereach.org

To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/CADt-Nu25QQXpZOgK6PKK%2BxczBUhMHveDw3fcCN_Q17ncCza3JA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--

You received this message because you are subscribed to the Google Groups "OpenLMIS Dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to openlmis-dev+unsubscribe@googlegroups.com.
To post to this group, send email to openlm...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/CY4PR02MB21993C098F487A7C2129853494CB0%40CY4PR02MB2199.namprd02.prod.outlook.com.

For more options, visit https://groups.google.com/d/optout.

--

Paweł Gesek
Technical Project Manager
pge...@soldevelo.com / +48 690 020 875