Uploaded image for project: 'apiman (API Management)'
  1. apiman (API Management)
  2. APIMAN-137

Policy description included in service or plan description

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Done
    • Icon: Major Major
    • 1.0.x, 1.0.0.Alpha, 1.0.0.Beta
    • None
    • None
    • None

      Currently there is support for services having their own policies, and a consumer selecting a service and associated 'plan', where the plan also may have a set of policies.

      However by itself, the service and policy name does not provide any clue as to what that level of service will provide (e.g. rate limiting level or metering cost).

      It would be useful if the policy could provide an optional (localised) description of what it represents, in such a way that the description could be aggregated with other policy descriptions and included either in the plan description, or if viewing a service, then the descriptions from the policies in the plan and additional policies on the service itself should be included with the service.

      As the description could be quite long if there are many policies, it may be necessary to offer a UI construct that can display partial description and expand to show the rest.

      Using this approach means that the descriptive text on the plan or service does not need to be manually updated whenever the policies associated with the service or plan are changed.

      It may also be possible to get the descriptive information for a policy auto generated from the policy definition - e.g. if a metering policy then some of the text could be boilerplate for all metering policies, but include parameterization for the actual cost amount.

            ewittman@redhat.com Eric Wittmann
            gary@brownuk.com Gary Brown
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: