On Mon, Nov 2, 2020 at 5:35 PM Nuwan Dias <[email protected]> wrote:

> So for existing users of this feature, the only reason this change can
> backfire is when they have an invalid URL on the OpenAPI doc right?
>
Yes, that is the change that can backfire as far as I can think of.


> Because when publishing an API to an external portal, the OpenAPI of that
> API would be expected to contain the proper URL of the API. So in the event
> this change starts displaying an invalid URL on the external store, I think
> the right thing to do is to fix the OpenAPI doc on that API on the external
> store.
>
Yes, +1 to fix the URLs of the OpenAPI before pushing to the external store.

Thanks!

>
>

> On Mon, Nov 2, 2020 at 5:08 PM Malintha Amarasinghe <[email protected]>
> wrote:
>
>>
>>
>> On Mon, Nov 2, 2020 at 4:03 PM Malintha Amarasinghe <[email protected]>
>> wrote:
>>
>>> When an API is published to an external store, we are doing an export
>>> (zip) of the API from the current APIM and import it to the external store
>>> [1]. Before doing so, the exported zip is modified and adding 
>>> *advertiseOnly:
>>> true* is also part of it [2].
>>> When we are showing backend URLs from swagger, we might also have to
>>> modify the swagger before pushing to the external store so that it will
>>> reflect original API's GW to avoid it showing the original endpoints coming
>>> from the swagger. WDYT?
>>>
>>
>> Above is just to make sure our change to show GW urls doesn't negatively
>> affect external store features as there are customers already using it. I
>> am also thinking that showing the GW urls when advertiseOnly is true is the
>> way to go.
>>
>> Thanks!
>>
>>
>>>
>>> [1]
>>> https://github.com/wso2/carbon-apimgt/blob/462e4ec1279931e92f9d78cdcc5abb2a401cd3f5/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/publishers/WSO2APIPublisher.java#L101-L104
>>> [2]
>>> https://github.com/wso2/carbon-apimgt/blob/462e4ec1279931e92f9d78cdcc5abb2a401cd3f5/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/publishers/WSO2APIPublisher.java#L142
>>>
>>> On Mon, Nov 2, 2020 at 3:19 PM Nuwan Dias <[email protected]> wrote:
>>>
>>>> I think it's fine to display the host (servers) URL on the OpenAPI on
>>>> the developer portal in case the advertiseOnly attribute is true. In case
>>>> the host (servers) section on the OpenAPI is null/empty, we can default to
>>>> the old behavior which is to not display anything.
>>>>
>>>> Thanks,
>>>> NuwanD.
>>>>
>>>> On Thu, Oct 29, 2020 at 2:57 PM Akshitha Dalpethado (Intern) <
>>>> [email protected]> wrote:
>>>>
>>>>> Hi guys,
>>>>> I'm working on the project, harvesting APIs from AWS API gateway to
>>>>> the WSO2 developer portal. As you guys know we have created a new apictl
>>>>> command for this(apictl aws init).
>>>>> We have decided to use the *advertiseOnly* property to recognize
>>>>> these APIs when we import them to the developers portal and display the
>>>>> API's host URL as the gateway URL. For instance instead of the gateway URL
>>>>> generated by the developer portal this will be the URL displayed as the
>>>>> gateway URL.
>>>>> ern7ceaofh.execute-api.us-east-1.amazonaws.com
>>>>>
>>>>> But the problem we are having is *advertiseOnly* API gateway URLs,
>>>>> are not displayed in the developer portal. We are looking for a way to 
>>>>> show
>>>>> gateway URLs for *advertiseOnly* APIs without breaking the old
>>>>> external store feature.
>>>>>
>>>>> --
>>>>> *Akshitha Dalpethado* | Intern | WSO2 Inc.
>>>>>
>>>>> (m) :0770284542 | Email : [email protected]
>>>>>
>>>>> [image: http://wso2.com/signature] <http://wso2.com/signature>
>>>>>
>>>>
>>>>
>>>> --
>>>> *Nuwan Dias* | VP and deputy CTO - API Management and Integration |
>>>> WSO2 Inc.
>>>> (m) +94 777 775 729 | (e) [email protected]
>>>>
>>>
>>>
>>> --
>>> Malintha Amarasinghe
>>> *WSO2, Inc. - lean | enterprise | middleware*
>>> http://wso2.com/
>>>
>>> Mobile : +94 712383306
>>>
>>
>>
>> --
>> Malintha Amarasinghe
>> *WSO2, Inc. - lean | enterprise | middleware*
>> http://wso2.com/
>>
>> Mobile : +94 712383306
>>
>
>
> --
> *Nuwan Dias* | VP and deputy CTO - API Management and Integration | WSO2
> Inc.
> (m) +94 777 775 729 | (e) [email protected]
>


-- 
Malintha Amarasinghe
*WSO2, Inc. - lean | enterprise | middleware*
http://wso2.com/

Mobile : +94 712383306
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to