You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

To be Reviewed By: Geode Developers

Authors:Jinmei Liao

Status: Draft | Discussion | Active | Dropped | Superseded

Problem

Management REST API needs to implement GET resource request, with resource being a region, index, gateway receiver etc, if the resource (e.g. region) belongs to multiple groups, it might be configured differently on each group. So the problem is:

  1. should we include "group" in the GET resource request?
  2. if not on the first question, should we return a list of configurations for that resource?
  3. If yes on the 2nd question, how should we represent it in the response? GET request is supposed to return just one entity per REST specs.

Anti-Goals

Not changing how the configuration is saved on the backend.

Solution

Here are the answers for the 3 questions we raised before:

  1. should we include "group" in the GET resource request?   
    NO
  2. if not on the first question, should we return a list of configurations for that resource? 
    YES
  3. If yes on the 2nd question, how should we represent it in the response? GET request is supposed to return just one entity per REST specs
    We will wrap configuration per group in an EntityInfo object and return the EntityInfo as a response to the request. See detailed swagger documentation here:
    https://cwiki.apache.org/confluence/display/GEODE/1.13.0+Management+REST+API+-+v1#id-1.13.0ManagementRESTAPI-v1-GET/management/v1/regions/{id}

Changes and Additions to Public Interfaces

EntityInfo: https://github.com/apache/geode/blob/develop/geode-management/src/main/java/org/apache/geode/management/api/EntityInfo.java

Performance Impact

None

Backwards Compatibility and Upgrade Path

N/A

  • No labels