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

Supported API for 3scale CMS - Part 1

    XMLWordPrintable

Details

    • API CCS Sprint 37 (3Scale), API CCS Sprint 38 (3Scale), API CCS Sprint 39 (3Scale), API CCS Sprint 40 (3Scale), API CCS Sprint 42 (3Scale), API CCS Sprint 43 (3Scale), API CCS Sprint 44 (3Scale) 2

    Description

      The codebase of the API Manager includes an API for managing the content of the Developer Portal (CMS API). Currently this API is only for internal usage and it is not part of the supported APIs that are available in the solution. This piece is needed for full API lifecycle automation capabilities.

      The objective to review the current implementation and perform the necessary work to support the CMS API so it can be used by customers in their production environments.

      High level summary of the tasks involved

      • Test current implementation and identify weak points or bugs.
      • Implement specific improvements or fixes (only if necessary) 
      • Enable online documentation for this CMS API in the Admin Portal UI ("3scale API Docs" section in the Admin Portal. Improve the documentation of CMS API.json)
      • Allow the creation of Access Tokens with authority to consume the CMS API (new scope in AccountSettings->Personal->Tokens/AddAccessToken)
      • Update related documentation in the customer portal. (mansaldo@redhat.com, do you have an issue to link here? mansaldo: we haven't started working on this as of EoDecember 22, due to conflicting priorities)

      Out of scope (future enhancements may be requested in separate issues)

      • Extending the existing API implementation with new endpoints/features (if needed, docs will include a disclaimer mentioning any particularity or topic not fully covered to take into account in the current implementation).
      • Providing new Toolbox CLI commands or other tools to facilitate CMS provisioning tasks. See THREESCALE-8634
      • Global versioning for 3scale APIs. See THREESCALE-444
      • General API cleanup (json versus XML) for all 3scale APIs. see THREESCALE-5691, THREESCALE-5715, THREESCALE-2137

      Attachments

        Issue Links

          blocks

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. THREESCALE-7244 API for the developer portal CMS

          • 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

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. THREESCALE-8634 Toolbox command/s for Developer Portal CMS

          • 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
          is blocked by

          Task - Represents a small unit of work that is not end-user facing. THREESCALE-8990 Prepare CMS API for tech preview

          • Blocker - To be worked above all other priorities. This term is chosen when the severity of the issue is very high, has no workaround, or the effort for the change is comparatively low. Issues that may be very publicly visible and could generate significant media attention may also drive a higher priority.
          • Closed
          is cloned by

          Task - Represents a small unit of work that is not end-user facing. THREESCALE-9173 Supported API for 3scale CMS - Part 2 - Cleanup

          • 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.
          • To Develop
          is related to

          Sub-task - The sub-task of the issue THREESCALE-8991 Fix CMS API bugs

          • 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

          Sub-task - The sub-task of the issue THREESCALE-9431 CMS API - Change JSON response format

          • 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
          relates to

          Task - Represents a small unit of work that is not end-user facing. THREESCALE-9173 Supported API for 3scale CMS - Part 2 - Cleanup

          • 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.
          • To Develop

          Activity

            People

              Unassigned Unassigned
              amasferr Andreu Masferrer
              Lluis Cavalle Lluis Cavalle
              Martin Kudlej Martin Kudlej
              Joan Lledo Joan Lledo
              Votes:
              10 Vote for this issue
              Watchers:
              18 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - 3 days Original Estimate - 3 days
                  3d
                  Remaining:
                  Remaining Estimate - 1 week, 1 day
                  1w 1d
                  Logged:
                  Time Spent - Not Specified
                  Not Specified