You are viewing a plain text version of this content. The canonical link for it is here.
Posted to custos@airavata.apache.org by "Bisht, Aarushi" <ab...@iu.edu> on 2019/11/18 22:13:35 UTC
Swagger documentation for Tenant APIs
Hi All,
For the past couple of days I have been experimenting with swagger specification and swagger hub. I have generated API specification for Tenant Profile service. These are public APIs which will be used by Custos clients to register their tenants and obtain tenant credentials.
I have attached the documentation to the mail. It also contains sample SDK samples in different languages. It can be viewed by opening the index.html file in the browser. Please let me know if someone has a suggestion of exposing any other public API or modify existing ones or modification of the API models.
Thanks & Regards,
Aarushi Bisht
Re: [External] Swagger documentation for Tenant APIs
Posted by "Christie, Marcus Aaron" <ma...@iu.edu>.
Hi Aarushi,
> On Dec 3, 2019, at 1:37 PM, Bisht, Aarushi <ab...@iu.edu> wrote:
>
> The admin portal will be used by the admin to view, approve/decline a tenant registration request and add comments to the request.
>
> It would be really beneficial to define what other purposes the portal will be used for. Also, any inputs on the design of the portal would be helpful too.
Besides for tenant registration, we've also discussed the following UI needs:
- a login page, with some ability to skin it
- user views for managing stored credentials and share cloud resources with other users
- views to allow users to view/edit their profile
- for admins, auditing and monitoring views
Re: [External] Re: Swagger documentation for Tenant APIs
Posted by "Bisht, Aarushi" <ab...@iu.edu>.
Hi All,
Since the APIs for tenant service are finalized and I am able to mock them in Swagger Hub, I am planning to start the development of the admin portal.
The admin portal will be used by the admin to view, approve/decline a tenant registration request and add comments to the request.
It would be really beneficial to define what other purposes the portal will be used for. Also, any inputs on the design of the portal would be helpful too.
Regards,
Aarushi Bisht
________________________________________
From: Bisht, Aarushi
Sent: Wednesday, November 20, 2019 10:41 AM
To: custos@airavata.apache.org
Subject: Re: [External] Re: Swagger documentation for Tenant APIs
Hi,
Thank you Suresh for the feedback. Please find the updated specification attached to the mail. I have made the following changes:
1. Removed tenantId as a compulsory field in createTenant. This field will be auto-generated by Custos server and returned as part of the response of the create request. The tenantId will be unique and can be used by the client later to query about the tenant.
2. Added redirectURIs, tenantURI, logoURI, scope, contacts to the model.
Isuru, I will start mocking the APIs using Swagger hub and will let you know once I am done.
Thanks & Regards,
Aarushi Bisht
________________________________________
From: Suresh Marru <sm...@apache.org>
Sent: Monday, November 18, 2019 11:35 PM
To: custos@airavata.apache.org
Subject: [External] Re: Swagger documentation for Tenant APIs
This message was sent from a non-IU address. Please exercise caution when clicking links or opening attachments from external sources.
-------
+1 for mock API’s. This we all of us can agree upon the API’s first before we dive into implementations.
Suresh
> On Nov 18, 2019, at 8:01 PM, Isuru Ranawaka <ir...@gmail.com> wrote:
>
> Hi Aarushi,
>
> Thanks for APIs. Could you try auto mocking feature of swagger hub [1]. If
> we can mock the APIs then we can start UI and backend development parallely.
>
> [1]https://app.swaggerhub.com/help/integrations/api-auto-mocking <https://app.swaggerhub.com/help/integrations/api-auto-mocking>
>
> On Mon, Nov 18, 2019 at 6:39 PM Suresh Marru <smarru@apache.org <ma...@apache.org>> wrote:
>
>> Hi Aarushi,
>>
>> This is nice. Few questions/comments:
>>
>> * For createTentant API looks like client has to provide a tenantId,
>> instead can the server generate and return a unique tenantId?
>>
>> * within getCredentials API call, instead of oauthCliendId and
>> oauthClientSecret, can you please make them iamClientId and iamClientSecret?
>>
>> To confirm with OAuth 2.0 Dynamic Client Registration Protocol, can you
>> also add additional client metadata like client name, client uri, logo uri,
>> scope, contacts? Refer: https://tools.ietf.org/html/rfc7591 <
>> https://tools.ietf.org/html/rfc7591 <https://tools.ietf.org/html/rfc7591>>
>>
>> Cheers,
>> Suresh
>>
>>> On Nov 18, 2019, at 3:13 PM, Bisht, Aarushi <ab...@iu.edu> wrote:
>>>
>>> Hi All,
>>>
>>> For the past couple of days I have been experimenting with swagger
>> specification and swagger hub. I have generated API specification for
>> Tenant Profile service. These are public APIs which will be used by Custos
>> clients to register their tenants and obtain tenant credentials.
>>>
>>> I have attached the documentation to the mail. It also contains sample
>> SDK samples in different languages. It can be viewed by opening the
>> index.html file in the browser. Please let me know if someone has a
>> suggestion of exposing any other public API or modify existing ones or
>> modification of the API models.
>>>
>>>
>>> Thanks & Regards,
>>> Aarushi Bisht
>>>
>>>
>>> <html2-documentation-generated.zip>
>>
>>
>
> --
> Senior Engineer
> WSO2 Lanka (pvt) Ltd
> Blog:- http://isurur.blogspot.com/ <http://isurur.blogspot.com/>
> Phone:- +94714629880
Re: [External] Re: Swagger documentation for Tenant APIs
Posted by "Bisht, Aarushi" <ab...@iu.edu>.
Hi,
Thank you Suresh for the feedback. Please find the updated specification attached to the mail. I have made the following changes:
1. Removed tenantId as a compulsory field in createTenant. This field will be auto-generated by Custos server and returned as part of the response of the create request. The tenantId will be unique and can be used by the client later to query about the tenant.
2. Added redirectURIs, tenantURI, logoURI, scope, contacts to the model.
Isuru, I will start mocking the APIs using Swagger hub and will let you know once I am done.
Thanks & Regards,
Aarushi Bisht
________________________________________
From: Suresh Marru <sm...@apache.org>
Sent: Monday, November 18, 2019 11:35 PM
To: custos@airavata.apache.org
Subject: [External] Re: Swagger documentation for Tenant APIs
This message was sent from a non-IU address. Please exercise caution when clicking links or opening attachments from external sources.
-------
+1 for mock API’s. This we all of us can agree upon the API’s first before we dive into implementations.
Suresh
> On Nov 18, 2019, at 8:01 PM, Isuru Ranawaka <ir...@gmail.com> wrote:
>
> Hi Aarushi,
>
> Thanks for APIs. Could you try auto mocking feature of swagger hub [1]. If
> we can mock the APIs then we can start UI and backend development parallely.
>
> [1]https://app.swaggerhub.com/help/integrations/api-auto-mocking <https://app.swaggerhub.com/help/integrations/api-auto-mocking>
>
> On Mon, Nov 18, 2019 at 6:39 PM Suresh Marru <smarru@apache.org <ma...@apache.org>> wrote:
>
>> Hi Aarushi,
>>
>> This is nice. Few questions/comments:
>>
>> * For createTentant API looks like client has to provide a tenantId,
>> instead can the server generate and return a unique tenantId?
>>
>> * within getCredentials API call, instead of oauthCliendId and
>> oauthClientSecret, can you please make them iamClientId and iamClientSecret?
>>
>> To confirm with OAuth 2.0 Dynamic Client Registration Protocol, can you
>> also add additional client metadata like client name, client uri, logo uri,
>> scope, contacts? Refer: https://tools.ietf.org/html/rfc7591 <
>> https://tools.ietf.org/html/rfc7591 <https://tools.ietf.org/html/rfc7591>>
>>
>> Cheers,
>> Suresh
>>
>>> On Nov 18, 2019, at 3:13 PM, Bisht, Aarushi <ab...@iu.edu> wrote:
>>>
>>> Hi All,
>>>
>>> For the past couple of days I have been experimenting with swagger
>> specification and swagger hub. I have generated API specification for
>> Tenant Profile service. These are public APIs which will be used by Custos
>> clients to register their tenants and obtain tenant credentials.
>>>
>>> I have attached the documentation to the mail. It also contains sample
>> SDK samples in different languages. It can be viewed by opening the
>> index.html file in the browser. Please let me know if someone has a
>> suggestion of exposing any other public API or modify existing ones or
>> modification of the API models.
>>>
>>>
>>> Thanks & Regards,
>>> Aarushi Bisht
>>>
>>>
>>> <html2-documentation-generated.zip>
>>
>>
>
> --
> Senior Engineer
> WSO2 Lanka (pvt) Ltd
> Blog:- http://isurur.blogspot.com/ <http://isurur.blogspot.com/>
> Phone:- +94714629880
Re: Swagger documentation for Tenant APIs
Posted by Suresh Marru <sm...@apache.org>.
+1 for mock API’s. This we all of us can agree upon the API’s first before we dive into implementations.
Suresh
> On Nov 18, 2019, at 8:01 PM, Isuru Ranawaka <ir...@gmail.com> wrote:
>
> Hi Aarushi,
>
> Thanks for APIs. Could you try auto mocking feature of swagger hub [1]. If
> we can mock the APIs then we can start UI and backend development parallely.
>
> [1]https://app.swaggerhub.com/help/integrations/api-auto-mocking <https://app.swaggerhub.com/help/integrations/api-auto-mocking>
>
> On Mon, Nov 18, 2019 at 6:39 PM Suresh Marru <smarru@apache.org <ma...@apache.org>> wrote:
>
>> Hi Aarushi,
>>
>> This is nice. Few questions/comments:
>>
>> * For createTentant API looks like client has to provide a tenantId,
>> instead can the server generate and return a unique tenantId?
>>
>> * within getCredentials API call, instead of oauthCliendId and
>> oauthClientSecret, can you please make them iamClientId and iamClientSecret?
>>
>> To confirm with OAuth 2.0 Dynamic Client Registration Protocol, can you
>> also add additional client metadata like client name, client uri, logo uri,
>> scope, contacts? Refer: https://tools.ietf.org/html/rfc7591 <
>> https://tools.ietf.org/html/rfc7591 <https://tools.ietf.org/html/rfc7591>>
>>
>> Cheers,
>> Suresh
>>
>>> On Nov 18, 2019, at 3:13 PM, Bisht, Aarushi <ab...@iu.edu> wrote:
>>>
>>> Hi All,
>>>
>>> For the past couple of days I have been experimenting with swagger
>> specification and swagger hub. I have generated API specification for
>> Tenant Profile service. These are public APIs which will be used by Custos
>> clients to register their tenants and obtain tenant credentials.
>>>
>>> I have attached the documentation to the mail. It also contains sample
>> SDK samples in different languages. It can be viewed by opening the
>> index.html file in the browser. Please let me know if someone has a
>> suggestion of exposing any other public API or modify existing ones or
>> modification of the API models.
>>>
>>>
>>> Thanks & Regards,
>>> Aarushi Bisht
>>>
>>>
>>> <html2-documentation-generated.zip>
>>
>>
>
> --
> Senior Engineer
> WSO2 Lanka (pvt) Ltd
> Blog:- http://isurur.blogspot.com/ <http://isurur.blogspot.com/>
> Phone:- +94714629880
Re: Swagger documentation for Tenant APIs
Posted by Isuru Ranawaka <ir...@gmail.com>.
Hi Aarushi,
Thanks for APIs. Could you try auto mocking feature of swagger hub [1]. If
we can mock the APIs then we can start UI and backend development parallely.
[1]https://app.swaggerhub.com/help/integrations/api-auto-mocking
On Mon, Nov 18, 2019 at 6:39 PM Suresh Marru <sm...@apache.org> wrote:
> Hi Aarushi,
>
> This is nice. Few questions/comments:
>
> * For createTentant API looks like client has to provide a tenantId,
> instead can the server generate and return a unique tenantId?
>
> * within getCredentials API call, instead of oauthCliendId and
> oauthClientSecret, can you please make them iamClientId and iamClientSecret?
>
> To confirm with OAuth 2.0 Dynamic Client Registration Protocol, can you
> also add additional client metadata like client name, client uri, logo uri,
> scope, contacts? Refer: https://tools.ietf.org/html/rfc7591 <
> https://tools.ietf.org/html/rfc7591>
>
> Cheers,
> Suresh
>
> > On Nov 18, 2019, at 3:13 PM, Bisht, Aarushi <ab...@iu.edu> wrote:
> >
> > Hi All,
> >
> > For the past couple of days I have been experimenting with swagger
> specification and swagger hub. I have generated API specification for
> Tenant Profile service. These are public APIs which will be used by Custos
> clients to register their tenants and obtain tenant credentials.
> >
> > I have attached the documentation to the mail. It also contains sample
> SDK samples in different languages. It can be viewed by opening the
> index.html file in the browser. Please let me know if someone has a
> suggestion of exposing any other public API or modify existing ones or
> modification of the API models.
> >
> >
> > Thanks & Regards,
> > Aarushi Bisht
> >
> >
> > <html2-documentation-generated.zip>
>
>
--
Senior Engineer
WSO2 Lanka (pvt) Ltd
Blog:- http://isurur.blogspot.com/
Phone:- +94714629880
Re: Swagger documentation for Tenant APIs
Posted by Suresh Marru <sm...@apache.org>.
Hi Aarushi,
This is nice. Few questions/comments:
* For createTentant API looks like client has to provide a tenantId, instead can the server generate and return a unique tenantId?
* within getCredentials API call, instead of oauthCliendId and oauthClientSecret, can you please make them iamClientId and iamClientSecret?
To confirm with OAuth 2.0 Dynamic Client Registration Protocol, can you also add additional client metadata like client name, client uri, logo uri, scope, contacts? Refer: https://tools.ietf.org/html/rfc7591 <https://tools.ietf.org/html/rfc7591>
Cheers,
Suresh
> On Nov 18, 2019, at 3:13 PM, Bisht, Aarushi <ab...@iu.edu> wrote:
>
> Hi All,
>
> For the past couple of days I have been experimenting with swagger specification and swagger hub. I have generated API specification for Tenant Profile service. These are public APIs which will be used by Custos clients to register their tenants and obtain tenant credentials.
>
> I have attached the documentation to the mail. It also contains sample SDK samples in different languages. It can be viewed by opening the index.html file in the browser. Please let me know if someone has a suggestion of exposing any other public API or modify existing ones or modification of the API models.
>
>
> Thanks & Regards,
> Aarushi Bisht
>
>
> <html2-documentation-generated.zip>