Uploaded image for project: 'Cost Management'
  1. Cost Management
  2. COST-4018

Improve content of Cost Management OpenAPI Documentation

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Won't Do
    • Icon: Normal Normal
    • None
    • None
    • None
    • 5
    • False
    • None
    • False

      Cost Management OpenAPI spec content is lean and could be improved now that we have more customer usage. We can also improve the maintainability of the OpenAPI spec by subdividing it into smaller pieces.

       

      Link: https://github.com/project-koku/koku/blob/main/docs/specs/openapi.json 

      Goals:

      1. Describe API at a high level near the top. Provide a basic tutorial about how to do filtering/grouping. 
      2. Describe the limitations of the API. For example, supported date ranges and limits on grouping
      3. Improve each API description so that it provides a user-friendly description of the API group and individual APIs
      4. Responses need descriptions

          1.
          		 Divide the OpenAPI Spec into smaller chunks Sub-task Closed Normal Unassigned
          2.
          		 Describe API at a high level near the top. Provide a basic tutorial about how to do filtering/grouping Sub-task Closed Normal Unassigned
          3.
          		 Describe the limitations of the API. For example, supported date ranges and limits on grouping Sub-task Closed Normal Unassigned
          4.
          		 Ensure QE automation has a path if the OpenAPI Spec is broken into pieces Sub-task Closed Normal Unassigned
          5.
          		 Modify API header text Sub-task Closed Major Unassigned
          6.
          		 Document "exact" match on get openshift report filter Sub-task Closed Undefined Unassigned

              Unassigned Unassigned
              kholdawa@redhat.com Kevan Holdaway
              Votes:
              0 Vote for this issue
              Watchers:
              21 Start watching this issue

                Created:
                Updated:
                Resolved: