API Context can be duplicated among APIs, optional and default to /

[renuka-fernando]

The gateway is not validating the API context. Users can create multiple APIs with the same context and even update the API context once the API is created. This allows users to have their own URL path for APIs with giving them the flexibility to define any context.

The gateway is delegating the responsibility of making unique routes to the user. If there are any conflicting routes, the gateway may not guarantee which route matches first.

BTW, in the future, we may be able to validate route uniqueness.

cc: @nuwand

[nuwand]

Agreed +1

[renuka-fernando]

The invocation URL doesn't even contain the version. The user has to include the version in the context itself if the version is required.

version: api-platform.wso2.com/v1
kind: http/rest
metadata:
  name: Weather-API
  version: v1.0
spec:
  context: /weather/$version
  operations:
    - method: GET
      path: /alerts/active

Invocation URL would be something like: https://gw.wso2.com/weather/v1.0/alerts/active

The gateway won't support intelligent routing based on API version (semantic version). User can create another API with version: v1 and update it with the latest v1.x API.

[RakhithaRR]

Will this be the case for someone using the portals as well? If multiple API developers are involved, one might not be aware of the routes that are being used in an API developed by another. Might be worth considering showing a warning at least in such cases.