Uploaded image for project: 'Red Hat 3scale API Management'
  1. Red Hat 3scale API Management
  2. THREESCALE-528

the service definition for api_docs is incorrect

    XMLWordPrintable

Details

    • Bug
    • Resolution: Not a Bug
    • Major
    • 2.2 ER1
    • 2.1 GA, SaaS
    • System
    • Engineering
    • Hide

      the definition states for example that for Service create you need to include the access_token as a query but the system only accept that in the body.
      There might be other cases in the rest of endpoints and docs:

      • service management
      • account management
      • analytics
      • billing
        It would be good to do perform an automatic generation of documentation to avoid this
      Show
      the definition states for example that for Service create you need to include the access_token as a query but the system only accept that in the body. There might be other cases in the rest of endpoints and docs: service management account management analytics billing It would be good to do perform an automatic generation of documentation to avoid this

    Description

      One example of this is account management api: https://psd2-env-admin.3scale.net/api_docs/services/account_management_api.json

      In particular the example I received from the customer is the Service Create (not sure if there are other cases):
      the definition states that all input should be a query parameter, but if passed in the query the server won't see that (Required parameter missing: service)
      Everything should be passed as body, as it can be seen when you use the interactive docs on API DOCS page.

      Attachments

        Issue Links

          relates to

          Bug - A problem that impairs or prevents the functions of the product. THREESCALE-2086 Service settings missing in service endpoint

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Activity

            People

              Unassigned Unassigned
              lucamaf Luca Mattia Ferrari
              Michal Macejko Michal Macejko (Inactive)
              Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: