Date   

edgex-taf file structure for review

Cloud Tsai
 

Hi all,

As the discussion, we will make all kinds of the new tests in edgex-taf repository, including functional test, integration test, performance test, and so on.
The attachment is the proposal of new file structure.  Please help take a look and let us know your thoughts.
Thanks.

--
Best Regards,
Cloud Tsai


EdgeX QA/Test WG: Validation/Testing - Tue, 01/07/2020 #cal-notice

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <noreply@...>
 

EdgeX QA/Test WG: Validation/Testing

When:
Tuesday, 7 January 2020 11:00pm to
Wednesday, 8 January 2020 12:00am
(GMT+00:00) Europe/London

Where:
https://zoom.us/j/635232828

Organizer:
EdgeX-TSC-QA-Test@...

Description:
EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Upcoming Event: EdgeX QA/Test WG: Validation/Testing - Tue, 01/07/2020 11:00pm to Wed, 01/08/2020 12:00am, Please RSVP #cal-reminder

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <EdgeX-TSC-QA-Test@...>
 

Reminder: EdgeX QA/Test WG: Validation/Testing

When: Tuesday, 7 January 2020, 11:00pm to Wednesday, 8 January 2020, 12:00am (GMT+00:00) Europe/London

Where:https://zoom.us/j/635232828

An RSVP is requested. Click here to RSVP

Organizer: EdgeX-TSC-QA-Test@...

Description: EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


EdgeX QA/Test WG: Validation/Testing - Tue, 12/31/2019 #cal-notice

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <noreply@...>
 

EdgeX QA/Test WG: Validation/Testing

When:
Tuesday, 31 December 2019 11:00pm to
Wednesday, 1 January 2020 12:00am
(GMT+00:00) Europe/London

Where:
https://zoom.us/j/635232828

Organizer:
EdgeX-TSC-QA-Test@...

Description:
EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Upcoming Event: EdgeX QA/Test WG: Validation/Testing - Tue, 12/31/2019 11:00pm to Wed, 01/01/2020 12:00am, Please RSVP #cal-reminder

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <EdgeX-TSC-QA-Test@...>
 

Reminder: EdgeX QA/Test WG: Validation/Testing

When: Tuesday, 31 December 2019, 11:00pm to Wednesday, 1 January 2020, 12:00am (GMT+00:00) Europe/London

Where:https://zoom.us/j/635232828

An RSVP is requested. Click here to RSVP

Organizer: EdgeX-TSC-QA-Test@...

Description: EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


EdgeX QA/Test WG: Validation/Testing - Tue, 12/24/2019 #cal-notice

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <noreply@...>
 

EdgeX QA/Test WG: Validation/Testing

When:
Tuesday, 24 December 2019 11:00pm to
Wednesday, 25 December 2019 12:00am
(GMT+00:00) Europe/London

Where:
https://zoom.us/j/635232828

Organizer:
EdgeX-TSC-QA-Test@...

Description:
EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Upcoming Event: EdgeX QA/Test WG: Validation/Testing - Tue, 12/24/2019 11:00pm to Wed, 12/25/2019 12:00am, Please RSVP #cal-reminder

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <EdgeX-TSC-QA-Test@...>
 

Reminder: EdgeX QA/Test WG: Validation/Testing

When: Tuesday, 24 December 2019, 11:00pm to Wednesday, 25 December 2019, 12:00am (GMT+00:00) Europe/London

Where:https://zoom.us/j/635232828

An RSVP is requested. Click here to RSVP

Organizer: EdgeX-TSC-QA-Test@...

Description: EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


EdgeX QA/Test WG: Validation/Testing - Tue, 12/17/2019 #cal-notice

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <noreply@...>
 

EdgeX QA/Test WG: Validation/Testing

When:
Tuesday, 17 December 2019 11:00pm to
Wednesday, 18 December 2019 12:00am
(GMT+00:00) Europe/London

Where:
https://zoom.us/j/635232828

Organizer:
EdgeX-TSC-QA-Test@...

Description:
EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Upcoming Event: EdgeX QA/Test WG: Validation/Testing - Tue, 12/17/2019 11:00pm to Wed, 12/18/2019 12:00am, Please RSVP #cal-reminder

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <EdgeX-TSC-QA-Test@...>
 

Reminder: EdgeX QA/Test WG: Validation/Testing

When: Tuesday, 17 December 2019, 11:00pm to Wednesday, 18 December 2019, 12:00am (GMT+00:00) Europe/London

Where:https://zoom.us/j/635232828

An RSVP is requested. Click here to RSVP

Organizer: EdgeX-TSC-QA-Test@...

Description: EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


EdgeX QA/Test WG: Validation/Testing - Tue, 12/10/2019 #cal-notice

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <noreply@...>
 

EdgeX QA/Test WG: Validation/Testing

When:
Tuesday, 10 December 2019 11:00pm to
Wednesday, 11 December 2019 12:00am
(GMT+00:00) Europe/London

Where:
https://zoom.us/j/635232828

Organizer:
EdgeX-TSC-QA-Test@...

Description:
EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Upcoming Event: EdgeX QA/Test WG: Validation/Testing - Tue, 12/10/2019 11:00pm to Wed, 12/11/2019 12:00am, Please RSVP #cal-reminder

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <EdgeX-TSC-QA-Test@...>
 

Reminder: EdgeX QA/Test WG: Validation/Testing

When: Tuesday, 10 December 2019, 11:00pm to Wednesday, 11 December 2019, 12:00am (GMT+00:00) Europe/London

Where:https://zoom.us/j/635232828

An RSVP is requested. Click here to RSVP

Organizer: EdgeX-TSC-QA-Test@...

Description: EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


EdgeX QA/Test WG: Validation/Testing - Tue, 12/03/2019 #cal-notice

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <noreply@...>
 

EdgeX QA/Test WG: Validation/Testing

When:
Tuesday, 3 December 2019 11:00pm to
Wednesday, 4 December 2019 12:00am
(GMT+00:00) Europe/London

Where:
https://zoom.us/j/635232828

Organizer:
EdgeX-TSC-QA-Test@...

Description:
EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Upcoming Event: EdgeX QA/Test WG: Validation/Testing - Tue, 12/03/2019 11:00pm to Wed, 12/04/2019 12:00am, Please RSVP #cal-reminder

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <EdgeX-TSC-QA-Test@...>
 

Reminder: EdgeX QA/Test WG: Validation/Testing

When: Tuesday, 3 December 2019, 11:00pm to Wednesday, 4 December 2019, 12:00am (GMT+00:00) Europe/London

Where:https://zoom.us/j/635232828

An RSVP is requested. Click here to RSVP

Organizer: EdgeX-TSC-QA-Test@...

Description: EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Updated Time For Test QA Meeting Today

Robin Chatterjee
 

Folks,

 

I would like to clarify that today's meeting is not at the usual 17:00 [(UTC+00:00) Europe/London] but at 23:00 hours [(UTC+00:00). I am referring to the local time in Edinburgh (which is the same as London) [GMT]. The new timing has been chosen by unanimous decision (during last week's meeting) so that the time is feasible for people of all time-zones. I will be posting a message on slack to remind everyone about the timing.


Dial in Details are As Follows:

-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW


Best regards,


Robin CHATTERJEE
Technical Lead (IOTech Systems Limited) 
EdgeX QA/Test WG Chair ( https://www.edgexfoundry.org )
Email     : robin@...
Mobile   : +44 (0)7476525353


image.png



Two Day Workshop @ Dell

Trevor.Conn@...
 

Hi all – This is to update the relevant work groups (Device, Certification, QA-Test) that there will be no members from Dell attending the work-group meetings on Monday, Dec. 2nd and Tuesday, Dec 3rd due to all day onsite meetings.

 

Trevor Conn

Director of Software Engineering (DMTS)

Core Working Group Chair of EdgeX Foundry

Dell Technologies | IoT DellTech

Trevor_Conn@...

Round Rock, TX USA

 


Re: [Edgex-tsc-device-services] Swagger API document development process

Gregg, James R
 

Thank you Cloud. Sounds like a good plan and appreciate the heads up. 


On Nov 27, 2019, at 5:56 PM, Cloud Tsai <cloud@...> wrote:


Hi James,

Yes, we will open an issue, and this mail is just a heads up.
Once we confirm the approach, I will write down more information for explanation, but DevOps meeting is too late to me (1:00 AM).
We will open the issue and even the PR, and we just need your team to review.  Basically, once we switch RAML to Swagger, we need to modify the API document generation job.  I assume it happens automatically now.

On Thu, 28 Nov 2019 at 08:48, Gregg, James R <james.r.gregg@...> wrote:
Cloud, 
Would you like to write up the help needed and submit an issue to ci-management rep?   That way DevOps can assess the work involved.  I’m not clear what help is needed  from DevOps per this email.  We may want to ask you or a rep to come into the next DevOps WG meeting. 
Our scope for Geneva is set for the Jenkins Pipeline transformation, but if we have bandwidth and this is a priority that enables the project we can try to pull in this additional scope. 

Thanks. 

James Gregg

Thank you. 


On Nov 27, 2019, at 3:49 PM, Cloud Tsai <cloud@...> wrote:


Hi all,

As promised last week, we have found out some alternative ways to generate API documents from the swagger files on GitHub.
If you didn't join the QA Working Group meeting this week, you can listen to the recording in 11:17 ~ 18:28.  My colleague, Andrew Foster, explained the ways we found out.
https://zoom.us/recording/share/sXM4tUWvQUKLoO2DTlr3Z_NNDJoocXgBmRXlaOyKrUawIumekTziMw

Due to the limitation, we can't sync swagger file from GitHub to SwaggerHub or vice versa.  SwaggerHub misses the signoff feature to commit changes, so it will never pass our DCO.

There is a command line tool called swagger-codegen, and it can generate html from swagger (core-command sample attached) as what we did using raml2html currently.  We can leverage it to generate HTML file on Jenkins and push to our document website.  Here is our current API page with RAML:

However, we just found another better way.   There is an online API on SwaggerHub, and we verify it works fine.  Please see the attached slide we summarized, and the API sample is on page 3.  After PR merged, we can push the swagger file to SwaggerHub automatically via Jenkins jobs instead of generate HTML and put the SwaggerHub document link on our document web site, like this:
We need DevOps team's support on this part.

As a result, the process will be:
  1. Use any of your favorite swagger editor, such as https://editor.swagger.io/ to create or modify the API definition.  Note that we should all use the latest version openapi: 3.0.1, not swagger 2.0.
  2. Commit the file onto GitHub.
  3. GitHub PR merge trigger the Jenkins job.
  4. The Jenkins job determines whether the API documents are modified, if yes, post to SwaggerHub API according to the version.
Please let me know if you have any question or advice.  Thanks.

--
Best Regards,
Cloud Tsai
<Swagger update.pdf>
<core-command.zip>


--
Best Regards,
Cloud Tsai


Re: [Edgex-tsc-device-services] Swagger API document development process

Cloud Tsai
 

Hi James,

Yes, we will open an issue, and this mail is just a heads up.
Once we confirm the approach, I will write down more information for explanation, but DevOps meeting is too late to me (1:00 AM).
We will open the issue and even the PR, and we just need your team to review.  Basically, once we switch RAML to Swagger, we need to modify the API document generation job.  I assume it happens automatically now.

On Thu, 28 Nov 2019 at 08:48, Gregg, James R <james.r.gregg@...> wrote:
Cloud, 
Would you like to write up the help needed and submit an issue to ci-management rep?   That way DevOps can assess the work involved.  I’m not clear what help is needed  from DevOps per this email.  We may want to ask you or a rep to come into the next DevOps WG meeting. 
Our scope for Geneva is set for the Jenkins Pipeline transformation, but if we have bandwidth and this is a priority that enables the project we can try to pull in this additional scope. 

Thanks. 

James Gregg

Thank you. 


On Nov 27, 2019, at 3:49 PM, Cloud Tsai <cloud@...> wrote:


Hi all,

As promised last week, we have found out some alternative ways to generate API documents from the swagger files on GitHub.
If you didn't join the QA Working Group meeting this week, you can listen to the recording in 11:17 ~ 18:28.  My colleague, Andrew Foster, explained the ways we found out.
https://zoom.us/recording/share/sXM4tUWvQUKLoO2DTlr3Z_NNDJoocXgBmRXlaOyKrUawIumekTziMw

Due to the limitation, we can't sync swagger file from GitHub to SwaggerHub or vice versa.  SwaggerHub misses the signoff feature to commit changes, so it will never pass our DCO.

There is a command line tool called swagger-codegen, and it can generate html from swagger (core-command sample attached) as what we did using raml2html currently.  We can leverage it to generate HTML file on Jenkins and push to our document website.  Here is our current API page with RAML:

However, we just found another better way.   There is an online API on SwaggerHub, and we verify it works fine.  Please see the attached slide we summarized, and the API sample is on page 3.  After PR merged, we can push the swagger file to SwaggerHub automatically via Jenkins jobs instead of generate HTML and put the SwaggerHub document link on our document web site, like this:
We need DevOps team's support on this part.

As a result, the process will be:
  1. Use any of your favorite swagger editor, such as https://editor.swagger.io/ to create or modify the API definition.  Note that we should all use the latest version openapi: 3.0.1, not swagger 2.0.
  2. Commit the file onto GitHub.
  3. GitHub PR merge trigger the Jenkins job.
  4. The Jenkins job determines whether the API documents are modified, if yes, post to SwaggerHub API according to the version.
Please let me know if you have any question or advice.  Thanks.

--
Best Regards,
Cloud Tsai
<Swagger update.pdf>
<core-command.zip>


--
Best Regards,
Cloud Tsai


Re: [Edgex-tsc-device-services] Swagger API document development process

Gregg, James R
 

Cloud, 
Would you like to write up the help needed and submit an issue to ci-management rep?   That way DevOps can assess the work involved.  I’m not clear what help is needed  from DevOps per this email.  We may want to ask you or a rep to come into the next DevOps WG meeting. 
Our scope for Geneva is set for the Jenkins Pipeline transformation, but if we have bandwidth and this is a priority that enables the project we can try to pull in this additional scope. 

Thanks. 

James Gregg

Thank you. 


On Nov 27, 2019, at 3:49 PM, Cloud Tsai <cloud@...> wrote:


Hi all,

As promised last week, we have found out some alternative ways to generate API documents from the swagger files on GitHub.
If you didn't join the QA Working Group meeting this week, you can listen to the recording in 11:17 ~ 18:28.  My colleague, Andrew Foster, explained the ways we found out.
https://zoom.us/recording/share/sXM4tUWvQUKLoO2DTlr3Z_NNDJoocXgBmRXlaOyKrUawIumekTziMw

Due to the limitation, we can't sync swagger file from GitHub to SwaggerHub or vice versa.  SwaggerHub misses the signoff feature to commit changes, so it will never pass our DCO.

There is a command line tool called swagger-codegen, and it can generate html from swagger (core-command sample attached) as what we did using raml2html currently.  We can leverage it to generate HTML file on Jenkins and push to our document website.  Here is our current API page with RAML:

However, we just found another better way.   There is an online API on SwaggerHub, and we verify it works fine.  Please see the attached slide we summarized, and the API sample is on page 3.  After PR merged, we can push the swagger file to SwaggerHub automatically via Jenkins jobs instead of generate HTML and put the SwaggerHub document link on our document web site, like this:
We need DevOps team's support on this part.

As a result, the process will be:
  1. Use any of your favorite swagger editor, such as https://editor.swagger.io/ to create or modify the API definition.  Note that we should all use the latest version openapi: 3.0.1, not swagger 2.0.
  2. Commit the file onto GitHub.
  3. GitHub PR merge trigger the Jenkins job.
  4. The Jenkins job determines whether the API documents are modified, if yes, post to SwaggerHub API according to the version.
Please let me know if you have any question or advice.  Thanks.

--
Best Regards,
Cloud Tsai
<Swagger update.pdf>
<core-command.zip>


Swagger API document development process

Cloud Tsai
 

Hi all,

As promised last week, we have found out some alternative ways to generate API documents from the swagger files on GitHub.
If you didn't join the QA Working Group meeting this week, you can listen to the recording in 11:17 ~ 18:28.  My colleague, Andrew Foster, explained the ways we found out.
https://zoom.us/recording/share/sXM4tUWvQUKLoO2DTlr3Z_NNDJoocXgBmRXlaOyKrUawIumekTziMw

Due to the limitation, we can't sync swagger file from GitHub to SwaggerHub or vice versa.  SwaggerHub misses the signoff feature to commit changes, so it will never pass our DCO.

There is a command line tool called swagger-codegen, and it can generate html from swagger (core-command sample attached) as what we did using raml2html currently.  We can leverage it to generate HTML file on Jenkins and push to our document website.  Here is our current API page with RAML:

However, we just found another better way.   There is an online API on SwaggerHub, and we verify it works fine.  Please see the attached slide we summarized, and the API sample is on page 3.  After PR merged, we can push the swagger file to SwaggerHub automatically via Jenkins jobs instead of generate HTML and put the SwaggerHub document link on our document web site, like this:
We need DevOps team's support on this part.

As a result, the process will be:
  1. Use any of your favorite swagger editor, such as https://editor.swagger.io/ to create or modify the API definition.  Note that we should all use the latest version openapi: 3.0.1, not swagger 2.0.
  2. Commit the file onto GitHub.
  3. GitHub PR merge trigger the Jenkins job.
  4. The Jenkins job determines whether the API documents are modified, if yes, post to SwaggerHub API according to the version.
Please let me know if you have any question or advice.  Thanks.

--
Best Regards,
Cloud Tsai


EdgeX QA/Test WG: Validation/Testing - Tue, 11/26/2019 #cal-notice

EdgeX-TSC-QA-Test@lists.edgexfoundry.org Calendar <noreply@...>
 

EdgeX QA/Test WG: Validation/Testing

When:
Tuesday, 26 November 2019
11:00am to 12:00pm
(GMT-06:00) America/Chicago

Where:
https://zoom.us/j/635232828

Organizer:
EdgeX-TSC-QA-Test@...

Description:
EdgeX QA/Test WG: Validation/Testing meeting. Meeting content posted to QA/Test Wiki.
Meeting Lead: Robin Chatterjee, EdgeX QA/Test WG Chair, robin@...
-----Join Zoom Meeting
https://zoom.us/j/635232828

One tap mobile
+16699006833,,635232828# US (San Jose)
+16465588656,,635232828# US (New York)

Dial by your location
        +1 669 900 6833 US (San Jose)
        +1 646 558 8656 US (New York)
        +1 855 880 1246 US Toll-free
        +1 877 369 0926 US Toll-free
Meeting ID: 635 232 828
Find your local number: https://zoom.us/u/abzs1KyOkW