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
  3. THREESCALE-8993

CMS API - Fix JSON responses

    XMLWordPrintable

Details

    • 5
    • False
    • None
    • False
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • 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

      XML responses from the CMS API endpoint are default now and contain the agreed data, but JSON responses are incomplete or make not much sense. The JSON responses should include the same data as the XML ones.

      List of affected endpoints

      GET /admin/api/cms/sections/:section_id/files.json
GET /admin/api/cms/sections.json
GET /admin/api/cms/sections/:id.json
GET /admin/api/cms/files.json
GET /admin/api/cms/files/:id.json
GET /admin/api/cms/templates.json
GET /admin/api/cms/templates/:id.json

      Notes

      Porta uses trailblazer/roar-rails to implement Representers that are used on the JSON responses.
      Roar, by default, removes keys with null values from the responses, so we need to make sure we add exceptions for all nullable keys in order to respond with null.

      Attachments

        Issue Links

          clones

          Sub-task - The sub-task of the issue THREESCALE-8992 CMS API - Implement the contract agreed by the system team

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

          Sub-task - The sub-task of the issue THREESCALE-9571 CMS API: Prevent writing some fields

          • 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-9572 CMS API: Return 4XX when deleting builtin resources

          • 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-9576 add parameter "full" to endpoint GET templates.json

          • 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

          Task - Represents a small unit of work that is not end-user facing. THREESCALE-2137 Unify output format of API calls in "3scale API Documentation"

          • Minor - To be worked after urgent, high, and medium priorities are resolved. This term is chosen when the severity of the issue is low, or the complexity or effort to correct it may be higher, relatively speaking. For low priority issues, known workarounds exist or are not needed due to the trivial effort needed to address the issue.
          • Closed

          Enhancement - An enhancement to or refactoring of existing functionality that is not configurable by an end user (typically a change made by an internal team that affects users) THREESCALE-5715 Bring JSON API to level of XML API and possibly obsolete XML

          • 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
          mentioned on

          GitLab Merge request - Updated US source to: 4f29502 Merge pull request #3268 from 3scale/restore_ogone_form_tag

          GitLab Merge request - Updated US source to: 33b70d3 CMS: Implement strong params (#3228)

          GitLab Merge request - Updated US source to: a01332a Merge pull request #3223 from 3scale/cleanup_ogone

          GitLab Merge request - Updated US source to: f320ff8 CMS API: Implement API Contract for JSON responses (#3235)

          Activity

            People

              Unassigned Unassigned
              cbartlet Catherine Bartlett
              Lluis Cavalle Lluis Cavalle
              Martin Kudlej Martin Kudlej
              Thales Miguel Thales Miguel (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              9 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 3 days
                  3d
                  Logged:
                  Time Spent - Not Specified
                  Not Specified