adding architecture

On Mon, Aug 12, 2019 at 5:34 PM Sanjeewa Malalgoda <[email protected]>
wrote:

> Yes, Nuwan is correct here. State is filter criteria and using query
> parameters is recommended. Also when we fetching this sort of resources its
> always good to have a way to limit and paginate number of results return.
> @Everyone i can see many team mates need to update API and add/modify
> resources. In that case schedule meeting and discuss about all resource is
> good IMO.
>
> Thanks,
> sanjeewa.
>
> On Mon, Aug 12, 2019 at 5:26 PM Nuwan Dias <[email protected]> wrote:
>
>> We have to discuss this publicly guys.
>>
>> Shouldn't this be /tenants?state=active?
>>
>> On Mon, Aug 12, 2019 at 5:19 PM Dushan Silva <[email protected]> wrote:
>>
>>> Hi all,
>>> We are planning to add a REST API endpoint to APIM 3.0 Store REST API to
>>> get all the tenant active tenant domains. Shown below is the swagger
>>> related to the new rest api.
>>>
>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>> *####################################################### The tenant
>>>> resource
>>>> APIs######################################################'/tenants/active-tenants':
>>>> #--------------------------------------------------------  # Retrieve all
>>>> active tenants  #--------------------------------------------------------
>>>> get:    security:      - OAuth2Security:          - []    summary: |
>>>> Get all active tenants names    description: |      This operation is to
>>>> retrieve all active tenants    tags:      - active tenants    responses:
>>>>   200:        description: |          OK.          Tenant names returned.
>>>>       headers:          Content-Type:            description: |
>>>>   The content type of the body.            type: string        schema:
>>>>     type: '#/definitions/TenantList'      404:        description: |
>>>>   Not Found.          Requested application does not exist.        schema:
>>>>         $ref: '#/definitions/Error'      406:        description: |
>>>>   Not Acceptable.          The requested media type is not supported
>>>> schema:          $ref: '#/definitions/Error'*
>>>
>>>
>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>>> *#-----------------------------------------------------# The Tenant
>>>> List resource#-----------------------------------------------------
>>>> TenantList :    title: Tenant list    properties:      count:        type:
>>>> integer        description: |          Number of tenants returned.
>>>> example: 1      list:        type: array        items:          type:
>>>> string*
>>>
>>>
>>> I have decided to use the resource as */tenants/active-tenants. *
>>>
>>> */**tenants *was used at the start of the path as if we are planning on
>>> adding any other tenant specific rest apis we can keep using this path.
>>>
>>> Any input for this is highly appreciated.
>>>
>>> Thanks
>>>
>>> Best Regards
>>> Dushan Silva
>>> Software Engineer
>>>
>>> *WSO2, Inc. *
>>>
>>> lean . enterprise . middleware
>>> Mob: +94 774 979042
>>>
>>
>>
>> --
>> *Nuwan Dias* | Director | WSO2 Inc.
>> (m) +94 777 775 729 | (e) [email protected]
>> [image: Signature.jpg]
>>
>
>
> --
> *Sanjeewa Malalgoda*
> Software Architect | Associate Director, Engineering - WSO2 Inc.
> (m) +94 712933253 | (e) [email protected] | (b) Blogger
> <http://sanjeewamalalgoda.blogspot.com>, Medium
> <https://medium.com/@sanjeewa190>
>
> GET INTEGRATION AGILE <https://wso2.com/signature>
> Integration Agility for Digitally Driven Business
>


-- 
Best Regards
Dushan Silva
Software Engineer

*WSO2, Inc. *

lean . enterprise . middleware
Mob: +94 774 979042
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to