subject:"Re\: \[Architecture\] \[G\-Reg\] \[RRT\] Integrating Swagger Editor with Governance Registry"

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-11 Thread Menaka Jayawardena

[+ Sagara]

On Wed, Apr 11, 2018 at 3:29 PM, Chandana Napagoda 
wrote:

> Hi Prasanna,
>
> Modifying swagger content means you might have to alter associated Rest
> Service as well. In a Rest Service, there can be user-defined metadata and
> autogenerated metadata. How are you going to identify user added metadata?
>
> Also changing swagger content mean you might move/create the RestService
> in a different registry location(Ex: changing title or version). So you
> need to think about how to handle such use cases and what information need
> to be copied to the new artifact. I believe these pieces of information
> should be there in use case acceptance criteria to avoid future confusion.
>
> Regards,
> Chandana
>
> On 10 April 2018 at 16:04, Prasanna Dangalla  wrote:
>
>> Hi Chandana,
>>
>> On Tue, Apr 10, 2018 at 11:55 AM, Chandana Napagoda 
>> wrote:
>>
>>> Hi Menaka,
>>>
>>> When adding a swagger file, it will automatically create a rest service
>>> with metadata available in the swagger file. So when adding a swagger
>>> content through this swagger editor, are we creating rest service metadata
>>> as well?
>>>
>> AFAIU what Menaka is suggesting is to have a backwrod compatability to
>> update the rest service when we edit the swagger from the swagger editor.
>> We need to rethink whether we are editing the same registry artifact or
>> whether we create a new version of the exiting artifact and let the changes
>> reflect on it.
>>
>> Thanks
>> Prasanna
>>
>>>
>>> Regards,
>>> Chandana
>>>
>>>
>>> On 10 April 2018 at 14:28, Menaka Jayawardena  wrote:
>>>
 Hi Shazni,

 Thank you very much for the feedback.

 On Tue, Apr 10, 2018 at 10:13 AM, Shazni Nazeer 
 wrote:

> Agreed with Shiro.
>
> Regarding #2,  IMO editing a swagger should limit to whatever the
> version being edited. Say the edited swagger has to be a newer version,
> then I suppose in G-Reg publisher there's a copy artifact feature, after
> which the developer can modify the newer version.
>
> However regarding #1 I think in publisher there's an option to upload
> the swagger. When a developer created, it would be beneficial to create a
> new swagger by start editing if this could be added.
>
> On Wed, Apr 4, 2018 at 4:09 AM, Menaka Jayawardena 
> wrote:
>
>> Yes... The points 1 and 3 are the same.
>> Sorry for the mistake.
>>
>>
>>
>> On Wed, Apr 4, 2018 at 2:22 PM, Shiro Kulatilake 
>> wrote:
>>
>>> Hi Menaka,
>>>
>>> Comments inline.
>>>
>>> On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena 
>>> wrote:
>>>
 Hi,

 Currently, in G-Reg publisher, users cannot edit the uploaded
 swagger files. Neither it can be downloaded. So, in order to edit an
 uploaded file, they need to either,

>>> This is when creating REST APIs.
>>>

1.  Edit the local copy, delete the resource in the G-Reg and
re-upload it.
2.  Copy the content of the file, make the changes, delete the
existing G-Reg resource and re-upload it.

 In user's perspective, this is a very cumbersome process to perform
 in-order to get a simple task done.

 As a solution for this, I'm working on integrating the swagger
 editor in G-Reg publisher, where users can edit the swagger files in 
 the
 G-Reg publisher it self.

 The functionality would be similar to the swagger editor in API-M
 Publisher and need some clarification on the following aspects as well.

 1. Do we provide the capability of create a swagger file with the
 editor?
 2. Saving the edited file with a different name.
 3. Do we need to incorporate the editor in the new file creation
 process. i.e, when the user is creating a new swagger file, do we 
 supposed
 to give them to create it with editor as well?

>>>
>>> Whats the difference between 1 and 3 ? Creating a new swagger file
>>> will amount to a new file creation right ?
>>> If we do 2 then we will have to incorporate versioning capabilities
>>> here as well.
>>>
>>> I think in phase 1 we should just do the basic functionality you
>>> have mentioned in the document - just the same that is there in API
>>> Manager.
>>>
>>> Thank you,
>>> Shiro
>>>
>>>

 I have attached the user stories for the basic functionality.

 https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_Bm
 GL1AhD7iw_T3-f6flsI/edit?usp=sharing

 Any ideas, suggestions are highly appreciated.

 Thanks and Regards,

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-11 Thread Chandana Napagoda

Hi Prasanna,

Modifying swagger content means you might have to alter associated Rest
Service as well. In a Rest Service, there can be user-defined metadata and
autogenerated metadata. How are you going to identify user added metadata?

Also changing swagger content mean you might move/create the RestService in
a different registry location(Ex: changing title or version). So you need
to think about how to handle such use cases and what information need to be
copied to the new artifact. I believe these pieces of information should be
there in use case acceptance criteria to avoid future confusion.

Regards,
Chandana

On 10 April 2018 at 16:04, Prasanna Dangalla  wrote:

> Hi Chandana,
>
> On Tue, Apr 10, 2018 at 11:55 AM, Chandana Napagoda 
> wrote:
>
>> Hi Menaka,
>>
>> When adding a swagger file, it will automatically create a rest service
>> with metadata available in the swagger file. So when adding a swagger
>> content through this swagger editor, are we creating rest service metadata
>> as well?
>>
> AFAIU what Menaka is suggesting is to have a backwrod compatability to
> update the rest service when we edit the swagger from the swagger editor.
> We need to rethink whether we are editing the same registry artifact or
> whether we create a new version of the exiting artifact and let the changes
> reflect on it.
>
> Thanks
> Prasanna
>
>>
>> Regards,
>> Chandana
>>
>>
>> On 10 April 2018 at 14:28, Menaka Jayawardena  wrote:
>>
>>> Hi Shazni,
>>>
>>> Thank you very much for the feedback.
>>>
>>> On Tue, Apr 10, 2018 at 10:13 AM, Shazni Nazeer  wrote:
>>>
 Agreed with Shiro.

 Regarding #2,  IMO editing a swagger should limit to whatever the
 version being edited. Say the edited swagger has to be a newer version,
 then I suppose in G-Reg publisher there's a copy artifact feature, after
 which the developer can modify the newer version.

 However regarding #1 I think in publisher there's an option to upload
 the swagger. When a developer created, it would be beneficial to create a
 new swagger by start editing if this could be added.

 On Wed, Apr 4, 2018 at 4:09 AM, Menaka Jayawardena 
 wrote:

> Yes... The points 1 and 3 are the same.
> Sorry for the mistake.
>
>
>
> On Wed, Apr 4, 2018 at 2:22 PM, Shiro Kulatilake 
> wrote:
>
>> Hi Menaka,
>>
>> Comments inline.
>>
>> On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena 
>> wrote:
>>
>>> Hi,
>>>
>>> Currently, in G-Reg publisher, users cannot edit the uploaded
>>> swagger files. Neither it can be downloaded. So, in order to edit an
>>> uploaded file, they need to either,
>>>
>> This is when creating REST APIs.
>>
>>>
>>>1.  Edit the local copy, delete the resource in the G-Reg and
>>>re-upload it.
>>>2.  Copy the content of the file, make the changes, delete the
>>>existing G-Reg resource and re-upload it.
>>>
>>> In user's perspective, this is a very cumbersome process to perform
>>> in-order to get a simple task done.
>>>
>>> As a solution for this, I'm working on integrating the swagger
>>> editor in G-Reg publisher, where users can edit the swagger files in the
>>> G-Reg publisher it self.
>>>
>>> The functionality would be similar to the swagger editor in API-M
>>> Publisher and need some clarification on the following aspects as well.
>>>
>>> 1. Do we provide the capability of create a swagger file with the
>>> editor?
>>> 2. Saving the edited file with a different name.
>>> 3. Do we need to incorporate the editor in the new file creation
>>> process. i.e, when the user is creating a new swagger file, do we 
>>> supposed
>>> to give them to create it with editor as well?
>>>
>>
>> Whats the difference between 1 and 3 ? Creating a new swagger file
>> will amount to a new file creation right ?
>> If we do 2 then we will have to incorporate versioning capabilities
>> here as well.
>>
>> I think in phase 1 we should just do the basic functionality you have
>> mentioned in the document - just the same that is there in API Manager.
>>
>> Thank you,
>> Shiro
>>
>>
>>>
>>> I have attached the user stories for the basic functionality.
>>>
>>> https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_Bm
>>> GL1AhD7iw_T3-f6flsI/edit?usp=sharing
>>>
>>> Any ideas, suggestions are highly appreciated.
>>>
>>> Thanks and Regards,
>>> Menaka
>>>
>>> --
>>> *Menaka Jayawardena*
>>> Software Engineer
>>> WSO2 Inc.
>>>
>>> Phone: +94 71 350 5470
>>> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
>>> Blog   : https://menakamadushanka.wordpress.com/

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-10 Thread Prasanna Dangalla

Hi Chandana,

On Tue, Apr 10, 2018 at 11:55 AM, Chandana Napagoda 
wrote:

> Hi Menaka,
>
> When adding a swagger file, it will automatically create a rest service
> with metadata available in the swagger file. So when adding a swagger
> content through this swagger editor, are we creating rest service metadata
> as well?
>
AFAIU what Menaka is suggesting is to have a backwrod compatability to
update the rest service when we edit the swagger from the swagger editor.
We need to rethink whether we are editing the same registry artifact or
whether we create a new version of the exiting artifact and let the changes
reflect on it.

Thanks
Prasanna

>
> Regards,
> Chandana
>
>
> On 10 April 2018 at 14:28, Menaka Jayawardena  wrote:
>
>> Hi Shazni,
>>
>> Thank you very much for the feedback.
>>
>> On Tue, Apr 10, 2018 at 10:13 AM, Shazni Nazeer  wrote:
>>
>>> Agreed with Shiro.
>>>
>>> Regarding #2,  IMO editing a swagger should limit to whatever the
>>> version being edited. Say the edited swagger has to be a newer version,
>>> then I suppose in G-Reg publisher there's a copy artifact feature, after
>>> which the developer can modify the newer version.
>>>
>>> However regarding #1 I think in publisher there's an option to upload
>>> the swagger. When a developer created, it would be beneficial to create a
>>> new swagger by start editing if this could be added.
>>>
>>> On Wed, Apr 4, 2018 at 4:09 AM, Menaka Jayawardena 
>>> wrote:
>>>
 Yes... The points 1 and 3 are the same.
 Sorry for the mistake.



 On Wed, Apr 4, 2018 at 2:22 PM, Shiro Kulatilake 
 wrote:

> Hi Menaka,
>
> Comments inline.
>
> On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena 
> wrote:
>
>> Hi,
>>
>> Currently, in G-Reg publisher, users cannot edit the uploaded swagger
>> files. Neither it can be downloaded. So, in order to edit an uploaded 
>> file,
>> they need to either,
>>
> This is when creating REST APIs.
>
>>
>>1.  Edit the local copy, delete the resource in the G-Reg and
>>re-upload it.
>>2.  Copy the content of the file, make the changes, delete the
>>existing G-Reg resource and re-upload it.
>>
>> In user's perspective, this is a very cumbersome process to perform
>> in-order to get a simple task done.
>>
>> As a solution for this, I'm working on integrating the swagger editor
>> in G-Reg publisher, where users can edit the swagger files in the G-Reg
>> publisher it self.
>>
>> The functionality would be similar to the swagger editor in API-M
>> Publisher and need some clarification on the following aspects as well.
>>
>> 1. Do we provide the capability of create a swagger file with the
>> editor?
>> 2. Saving the edited file with a different name.
>> 3. Do we need to incorporate the editor in the new file creation
>> process. i.e, when the user is creating a new swagger file, do we 
>> supposed
>> to give them to create it with editor as well?
>>
>
> Whats the difference between 1 and 3 ? Creating a new swagger file
> will amount to a new file creation right ?
> If we do 2 then we will have to incorporate versioning capabilities
> here as well.
>
> I think in phase 1 we should just do the basic functionality you have
> mentioned in the document - just the same that is there in API Manager.
>
> Thank you,
> Shiro
>
>
>>
>> I have attached the user stories for the basic functionality.
>>
>> https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_Bm
>> GL1AhD7iw_T3-f6flsI/edit?usp=sharing
>>
>> Any ideas, suggestions are highly appreciated.
>>
>> Thanks and Regards,
>> Menaka
>>
>> --
>> *Menaka Jayawardena*
>> Software Engineer
>> WSO2 Inc.
>>
>> Phone: +94 71 350 5470
>> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
>> Blog   : https://menakamadushanka.wordpress.com/
>>
>>
>
>
> --
>
>
> *Shiroshica Kulatilake | Director, Solutions Architecture,  WSO2
> Inc.+94 776523867 *
>



 --
 *Menaka Jayawardena*
 Software Engineer
 WSO2 Inc.

 Phone: +94 71 350 5470
 LinkedIn : https://lk.linkedin.com/in/menakajayawardena
 Blog   : https://menakamadushanka.wordpress.com/


>>>
>>>
>>> --
>>> Shazni Nazeer
>>>
>>> Mob : +94 37331
>>> LinkedIn : http://lk.linkedin.com/in/shazninazeer
>>>
>>> Blogs :
>>>
>>> https://medium.com/@mshazninazeer
>>> http://shazninazeer.blogspot.com
>>>
>>> 
>>>
>>
>>
>>
>> --
>> *Menaka Jayawardena*
>> Software Engineer
>> WSO2 Inc.
>>
>> Phone: +94 71 350 5470
>> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
>> Blog

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-10 Thread Chandana Napagoda

 Hi Menaka,

When adding a swagger file, it will automatically create a rest service
with metadata available in the swagger file. So when adding a swagger
content through this swagger editor, are we creating rest service metadata
as well?

Regards,
Chandana


On 10 April 2018 at 14:28, Menaka Jayawardena  wrote:

> Hi Shazni,
>
> Thank you very much for the feedback.
>
> On Tue, Apr 10, 2018 at 10:13 AM, Shazni Nazeer  wrote:
>
>> Agreed with Shiro.
>>
>> Regarding #2,  IMO editing a swagger should limit to whatever the version
>> being edited. Say the edited swagger has to be a newer version, then I
>> suppose in G-Reg publisher there's a copy artifact feature, after which the
>> developer can modify the newer version.
>>
>> However regarding #1 I think in publisher there's an option to upload the
>> swagger. When a developer created, it would be beneficial to create a new
>> swagger by start editing if this could be added.
>>
>> On Wed, Apr 4, 2018 at 4:09 AM, Menaka Jayawardena 
>> wrote:
>>
>>> Yes... The points 1 and 3 are the same.
>>> Sorry for the mistake.
>>>
>>>
>>>
>>> On Wed, Apr 4, 2018 at 2:22 PM, Shiro Kulatilake  wrote:
>>>
 Hi Menaka,

 Comments inline.

 On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena 
 wrote:

> Hi,
>
> Currently, in G-Reg publisher, users cannot edit the uploaded swagger
> files. Neither it can be downloaded. So, in order to edit an uploaded 
> file,
> they need to either,
>
 This is when creating REST APIs.

>
>1.  Edit the local copy, delete the resource in the G-Reg and
>re-upload it.
>2.  Copy the content of the file, make the changes, delete the
>existing G-Reg resource and re-upload it.
>
> In user's perspective, this is a very cumbersome process to perform
> in-order to get a simple task done.
>
> As a solution for this, I'm working on integrating the swagger editor
> in G-Reg publisher, where users can edit the swagger files in the G-Reg
> publisher it self.
>
> The functionality would be similar to the swagger editor in API-M
> Publisher and need some clarification on the following aspects as well.
>
> 1. Do we provide the capability of create a swagger file with the
> editor?
> 2. Saving the edited file with a different name.
> 3. Do we need to incorporate the editor in the new file creation
> process. i.e, when the user is creating a new swagger file, do we supposed
> to give them to create it with editor as well?
>

 Whats the difference between 1 and 3 ? Creating a new swagger file will
 amount to a new file creation right ?
 If we do 2 then we will have to incorporate versioning capabilities
 here as well.

 I think in phase 1 we should just do the basic functionality you have
 mentioned in the document - just the same that is there in API Manager.

 Thank you,
 Shiro


>
> I have attached the user stories for the basic functionality.
>
> https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_Bm
> GL1AhD7iw_T3-f6flsI/edit?usp=sharing
>
> Any ideas, suggestions are highly appreciated.
>
> Thanks and Regards,
> Menaka
>
> --
> *Menaka Jayawardena*
> Software Engineer
> WSO2 Inc.
>
> Phone: +94 71 350 5470
> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
> Blog   : https://menakamadushanka.wordpress.com/
>
>


 --


 *Shiroshica Kulatilake | Director, Solutions Architecture,  WSO2
 Inc.+94 776523867 *

>>>
>>>
>>>
>>> --
>>> *Menaka Jayawardena*
>>> Software Engineer
>>> WSO2 Inc.
>>>
>>> Phone: +94 71 350 5470
>>> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
>>> Blog   : https://menakamadushanka.wordpress.com/
>>>
>>>
>>
>>
>> --
>> Shazni Nazeer
>>
>> Mob : +94 37331
>> LinkedIn : http://lk.linkedin.com/in/shazninazeer
>>
>> Blogs :
>>
>> https://medium.com/@mshazninazeer
>> http://shazninazeer.blogspot.com
>>
>> 
>>
>
>
>
> --
> *Menaka Jayawardena*
> Software Engineer
> WSO2 Inc.
>
> Phone: +94 71 350 5470
> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
> Blog   : https://menakamadushanka.wordpress.com/
>
>
> ___
> Architecture mailing list
> Architecture@wso2.org
> https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
>
>


-- 

Blog: http://blog.napagoda.com
Linkedin: https://www.linkedin.com/in/chandananapagoda/
___
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-09 Thread Menaka Jayawardena

Hi Shazni,

Thank you very much for the feedback.

On Tue, Apr 10, 2018 at 10:13 AM, Shazni Nazeer  wrote:

> Agreed with Shiro.
>
> Regarding #2,  IMO editing a swagger should limit to whatever the version
> being edited. Say the edited swagger has to be a newer version, then I
> suppose in G-Reg publisher there's a copy artifact feature, after which the
> developer can modify the newer version.
>
> However regarding #1 I think in publisher there's an option to upload the
> swagger. When a developer created, it would be beneficial to create a new
> swagger by start editing if this could be added.
>
> On Wed, Apr 4, 2018 at 4:09 AM, Menaka Jayawardena 
> wrote:
>
>> Yes... The points 1 and 3 are the same.
>> Sorry for the mistake.
>>
>>
>>
>> On Wed, Apr 4, 2018 at 2:22 PM, Shiro Kulatilake  wrote:
>>
>>> Hi Menaka,
>>>
>>> Comments inline.
>>>
>>> On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena 
>>> wrote:
>>>
 Hi,

 Currently, in G-Reg publisher, users cannot edit the uploaded swagger
 files. Neither it can be downloaded. So, in order to edit an uploaded file,
 they need to either,

>>> This is when creating REST APIs.
>>>

1.  Edit the local copy, delete the resource in the G-Reg and
re-upload it.
2.  Copy the content of the file, make the changes, delete the
existing G-Reg resource and re-upload it.

 In user's perspective, this is a very cumbersome process to perform
 in-order to get a simple task done.

 As a solution for this, I'm working on integrating the swagger editor
 in G-Reg publisher, where users can edit the swagger files in the G-Reg
 publisher it self.

 The functionality would be similar to the swagger editor in API-M
 Publisher and need some clarification on the following aspects as well.

 1. Do we provide the capability of create a swagger file with the
 editor?
 2. Saving the edited file with a different name.
 3. Do we need to incorporate the editor in the new file creation
 process. i.e, when the user is creating a new swagger file, do we supposed
 to give them to create it with editor as well?

>>>
>>> Whats the difference between 1 and 3 ? Creating a new swagger file will
>>> amount to a new file creation right ?
>>> If we do 2 then we will have to incorporate versioning capabilities here
>>> as well.
>>>
>>> I think in phase 1 we should just do the basic functionality you have
>>> mentioned in the document - just the same that is there in API Manager.
>>>
>>> Thank you,
>>> Shiro
>>>
>>>

 I have attached the user stories for the basic functionality.

 https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_Bm
 GL1AhD7iw_T3-f6flsI/edit?usp=sharing

 Any ideas, suggestions are highly appreciated.

 Thanks and Regards,
 Menaka

 --
 *Menaka Jayawardena*
 Software Engineer
 WSO2 Inc.

 Phone: +94 71 350 5470
 LinkedIn : https://lk.linkedin.com/in/menakajayawardena
 Blog   : https://menakamadushanka.wordpress.com/

>>>
>>>
>>> --
>>>
>>>
>>> *Shiroshica Kulatilake | Director, Solutions Architecture,  WSO2 Inc.+94
>>> 776523867 *
>>>
>>
>>
>>
>> --
>> *Menaka Jayawardena*
>> Software Engineer
>> WSO2 Inc.
>>
>> Phone: +94 71 350 5470
>> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
>> Blog   : https://menakamadushanka.wordpress.com/
>>
>>
>
>
> --
> Shazni Nazeer
>
> Mob : +94 37331
> LinkedIn : http://lk.linkedin.com/in/shazninazeer
>
> Blogs :
>
> https://medium.com/@mshazninazeer
> http://shazninazeer.blogspot.com
>
> 
>

-- 
*Menaka Jayawardena*
Software Engineer
WSO2 Inc.

Phone: +94 71 350 5470
LinkedIn : https://lk.linkedin.com/in/menakajayawardena
Blog   : https://menakamadushanka.wordpress.com/
___
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-09 Thread Shazni Nazeer

Agreed with Shiro.

Regarding #2,  IMO editing a swagger should limit to whatever the version
being edited. Say the edited swagger has to be a newer version, then I
suppose in G-Reg publisher there's a copy artifact feature, after which the
developer can modify the newer version.

However regarding #1 I think in publisher there's an option to upload the
swagger. When a developer created, it would be beneficial to create a new
swagger by start editing if this could be added.

On Wed, Apr 4, 2018 at 4:09 AM, Menaka Jayawardena  wrote:

> Yes... The points 1 and 3 are the same.
> Sorry for the mistake.
>
>
>
> On Wed, Apr 4, 2018 at 2:22 PM, Shiro Kulatilake  wrote:
>
>> Hi Menaka,
>>
>> Comments inline.
>>
>> On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena 
>> wrote:
>>
>>> Hi,
>>>
>>> Currently, in G-Reg publisher, users cannot edit the uploaded swagger
>>> files. Neither it can be downloaded. So, in order to edit an uploaded file,
>>> they need to either,
>>>
>> This is when creating REST APIs.
>>
>>>
>>>1.  Edit the local copy, delete the resource in the G-Reg and
>>>re-upload it.
>>>2.  Copy the content of the file, make the changes, delete the
>>>existing G-Reg resource and re-upload it.
>>>
>>> In user's perspective, this is a very cumbersome process to perform
>>> in-order to get a simple task done.
>>>
>>> As a solution for this, I'm working on integrating the swagger editor in
>>> G-Reg publisher, where users can edit the swagger files in the G-Reg
>>> publisher it self.
>>>
>>> The functionality would be similar to the swagger editor in API-M
>>> Publisher and need some clarification on the following aspects as well.
>>>
>>> 1. Do we provide the capability of create a swagger file with the
>>> editor?
>>> 2. Saving the edited file with a different name.
>>> 3. Do we need to incorporate the editor in the new file creation
>>> process. i.e, when the user is creating a new swagger file, do we supposed
>>> to give them to create it with editor as well?
>>>
>>
>> Whats the difference between 1 and 3 ? Creating a new swagger file will
>> amount to a new file creation right ?
>> If we do 2 then we will have to incorporate versioning capabilities here
>> as well.
>>
>> I think in phase 1 we should just do the basic functionality you have
>> mentioned in the document - just the same that is there in API Manager.
>>
>> Thank you,
>> Shiro
>>
>>
>>>
>>> I have attached the user stories for the basic functionality.
>>>
>>> https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_Bm
>>> GL1AhD7iw_T3-f6flsI/edit?usp=sharing
>>>
>>> Any ideas, suggestions are highly appreciated.
>>>
>>> Thanks and Regards,
>>> Menaka
>>>
>>> --
>>> *Menaka Jayawardena*
>>> Software Engineer
>>> WSO2 Inc.
>>>
>>> Phone: +94 71 350 5470
>>> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
>>> Blog   : https://menakamadushanka.wordpress.com/
>>>
>>>
>>
>>
>> --
>>
>>
>> *Shiroshica Kulatilake | Director, Solutions Architecture,  WSO2 Inc.+94
>> 776523867 *
>>
>
>
>
> --
> *Menaka Jayawardena*
> Software Engineer
> WSO2 Inc.
>
> Phone: +94 71 350 5470
> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
> Blog   : https://menakamadushanka.wordpress.com/
>
>


-- 
Shazni Nazeer

Mob : +94 37331
LinkedIn : http://lk.linkedin.com/in/shazninazeer

Blogs :

https://medium.com/@mshazninazeer
http://shazninazeer.blogspot.com


___
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-04 Thread Menaka Jayawardena

Yes... The points 1 and 3 are the same.
Sorry for the mistake.



On Wed, Apr 4, 2018 at 2:22 PM, Shiro Kulatilake  wrote:

> Hi Menaka,
>
> Comments inline.
>
> On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena 
> wrote:
>
>> Hi,
>>
>> Currently, in G-Reg publisher, users cannot edit the uploaded swagger
>> files. Neither it can be downloaded. So, in order to edit an uploaded file,
>> they need to either,
>>
> This is when creating REST APIs.
>
>>
>>1.  Edit the local copy, delete the resource in the G-Reg and
>>re-upload it.
>>2.  Copy the content of the file, make the changes, delete the
>>existing G-Reg resource and re-upload it.
>>
>> In user's perspective, this is a very cumbersome process to perform
>> in-order to get a simple task done.
>>
>> As a solution for this, I'm working on integrating the swagger editor in
>> G-Reg publisher, where users can edit the swagger files in the G-Reg
>> publisher it self.
>>
>> The functionality would be similar to the swagger editor in API-M
>> Publisher and need some clarification on the following aspects as well.
>>
>> 1. Do we provide the capability of create a swagger file with the editor?
>> 2. Saving the edited file with a different name.
>> 3. Do we need to incorporate the editor in the new file creation process.
>> i.e, when the user is creating a new swagger file, do we supposed to give
>> them to create it with editor as well?
>>
>
> Whats the difference between 1 and 3 ? Creating a new swagger file will
> amount to a new file creation right ?
> If we do 2 then we will have to incorporate versioning capabilities here
> as well.
>
> I think in phase 1 we should just do the basic functionality you have
> mentioned in the document - just the same that is there in API Manager.
>
> Thank you,
> Shiro
>
>
>>
>> I have attached the user stories for the basic functionality.
>>
>> https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_
>> BmGL1AhD7iw_T3-f6flsI/edit?usp=sharing
>>
>> Any ideas, suggestions are highly appreciated.
>>
>> Thanks and Regards,
>> Menaka
>>
>> --
>> *Menaka Jayawardena*
>> Software Engineer
>> WSO2 Inc.
>>
>> Phone: +94 71 350 5470
>> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
>> Blog   : https://menakamadushanka.wordpress.com/
>>
>>
>
>
> --
>
>
> *Shiroshica Kulatilake | Director, Solutions Architecture,  WSO2 Inc.+94
> 776523867 *
>



-- 
*Menaka Jayawardena*
Software Engineer
WSO2 Inc.

Phone: +94 71 350 5470
LinkedIn : https://lk.linkedin.com/in/menakajayawardena
Blog   : https://menakamadushanka.wordpress.com/
___
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

2018-04-04 Thread Shiro Kulatilake

Hi Menaka,

Comments inline.

On Wed, Apr 4, 2018 at 2:02 PM, Menaka Jayawardena  wrote:

> Hi,
>
> Currently, in G-Reg publisher, users cannot edit the uploaded swagger
> files. Neither it can be downloaded. So, in order to edit an uploaded file,
> they need to either,
>
This is when creating REST APIs.

>
>1.  Edit the local copy, delete the resource in the G-Reg and
>re-upload it.
>2.  Copy the content of the file, make the changes, delete the
>existing G-Reg resource and re-upload it.
>
> In user's perspective, this is a very cumbersome process to perform
> in-order to get a simple task done.
>
> As a solution for this, I'm working on integrating the swagger editor in
> G-Reg publisher, where users can edit the swagger files in the G-Reg
> publisher it self.
>
> The functionality would be similar to the swagger editor in API-M
> Publisher and need some clarification on the following aspects as well.
>
> 1. Do we provide the capability of create a swagger file with the editor?
> 2. Saving the edited file with a different name.
> 3. Do we need to incorporate the editor in the new file creation process.
> i.e, when the user is creating a new swagger file, do we supposed to give
> them to create it with editor as well?
>

Whats the difference between 1 and 3 ? Creating a new swagger file will
amount to a new file creation right ?
If we do 2 then we will have to incorporate versioning capabilities here as
well.

I think in phase 1 we should just do the basic functionality you have
mentioned in the document - just the same that is there in API Manager.

Thank you,
Shiro


>
> I have attached the user stories for the basic functionality.
>
> https://docs.google.com/document/d/1JHmsaWBaUFa_CXBVkDrwL_BmGL1AhD7iw_T3-
> f6flsI/edit?usp=sharing
>
> Any ideas, suggestions are highly appreciated.
>
> Thanks and Regards,
> Menaka
>
> --
> *Menaka Jayawardena*
> Software Engineer
> WSO2 Inc.
>
> Phone: +94 71 350 5470
> LinkedIn : https://lk.linkedin.com/in/menakajayawardena
> Blog   : https://menakamadushanka.wordpress.com/
>
>


-- 


*Shiroshica Kulatilake | Director, Solutions Architecture,  WSO2 Inc.+94
776523867 *
___
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

Re: [Architecture] [G-Reg] [RRT] Integrating Swagger Editor with Governance Registry

8 matches

Site Navigation

Mail list logo

Footer information