How can we improve Azure API Management?

Documentation Per Group/Product/Policy

Provide a way to specify the API documentation if a specific product is being used or based on the policy that applies to the API.

If behavior changes based on a product, policy, or group this would let users affected by those changes to see the documentation associated to them instead of saying if you are XYZ then this will be required/returned.

1 vote
Vote
Sign in
(thinking…)
Sign in with: Microsoft
Signed in as (Sign out)
You have left! (?) (thinking…)
Adam Weigert shared this idea  ·   ·  Flag idea as inappropriate…  ·  Admin →

1 comment

Sign in
(thinking…)
Sign in with: Microsoft
Signed in as (Sign out)
Submitting...
  • Adam Weigert commented  ·   ·  Flag as inappropriate

    If custom sections could be added based on a critiera (group membership or product of subscription) then the following could be helpful to the developer.

    The primary use case I have would be around stating the rate limit thresholds for either a particular product or group of users, e.g. Production has X rate limit, Staging has Y rate limit, or group A has X rate limit, group B has Y rate limit.

    This capability would keep more documentation about the API and its uses in the APIM portal and accessible to the developer instead as tribal knowledge and prevent it from being global knowledge.

    As a secondary note, I'm not sure this capability exists today, but the ability to use Properties within the docs would be nice as the rate limit is most likely a Property and could be imported into the docs so that when the Property value is updated then the docs would also be updated. Maybe not with replacement but with custom markdown support for pulling the property value

Feedback and Knowledge Base