Show API attributes with a special prefixes in Developer portal

wso2 / product-apim

Welcome to the WSO2 API Manager source code! For info on working with the WSO2 API Manager repository and contributing code, click the link below.

http://wso2.github.io/

Apache License 2.0

846 stars 786 forks source link

Show API attributes with a special prefixes in Developer portal #8389

Closed tmkasun closed 4 years ago

tmkasun commented 4 years ago

Describe your problem(s)

API Publisher wants to communicate some information to the App developer which couldn't do by the existing API propertied.

Describe your solution

Define a new prefix...like display that will work as a flag to show those properties (with that prefix) to appear in the API overview page of the Devportal

ex: display_region=US

How will you implement it

Optional Fields

Related Issues:

Suggested Labels:

Suggested Assignees:

tmkasun commented 4 years ago

chanaka3d commented 4 years ago

The attribute to display need to add with __display suffix as follows.

From devportal API overview page, it will be displayed as follows.

gspadotto commented 2 years ago

How do I declare additional properties that should be visible on the dev portal using apictl import?

I have tried adding:

additionalProperties:
   mypropertyone__display: valueone
   mypropertytwo__display: valuetwo

to api_template.yaml, but I do not see them in the Publisher and - of course - they are not shown in the DevPortal.

My goal is to publish an API with additional properties shown in the DevPortal within a CI/CD pipeline (thus using apictl)

APIM 3.2.0 - Update Level 137 apictl Version: 3.1.4 Build Date: 2020-07-31 04:23:40 UTC