Mailing-List: contact ambari-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: ambari-dev@incubator.apache.org
Date: Tue, 12 Feb 2013 17:23:13 +0000 (UTC)
From: "John Speidel (JIRA)" <jira@apache.org>
To: ambari-dev@incubator.apache.org
Message-ID: <JIRA.12631983.1360687959475.278637.1360689793339@arcas>
In-Reply-To: <JIRA.12631983.1360687959475@arcas>
References: <JIRA.12631983.1360687959475@arcas>
Subject: [jira] [Updated] (AMBARI-1380) Publish a management API which is
 consistent with the version 1 monitoring API
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


     [ https://issues.apache.org/jira/browse/AMBARI-1380?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

John Speidel updated AMBARI-1380:
---------------------------------

    Description: 
There are currently several Ambari REST services which provide various forms of management functionality.  These services/API's were not built in a manner which is consistent with the overall Ambari API design and were built specifically to provide functionality for the Ambari UI.  This goal of this task is to take these existing management services, clean them up, make them consistent with the overall API and document them for general use. 

Review existing management services for usability and consistency with the monitoring API. All management API resources must utilize the API framework and follow the same pattern as the monitoring API where there is a plural collection resource followed by a singular instance resource. Also, package names should be consistent and have a common parent package where it makes sense to avoid having service classes strewn all over the place. Following these guidelines will help to ensure a consistent behavior across the entire API. If a service is truly private it should be clear by the package name. All services need to be represented as a single consistent API, not a random collection of independent API's/services. Current services will also be evaluated to ensure that they are necessary and can't be replaced/combined with other services.

This is an umbrella Jira for all management API cleanup.  The actual work of updating the API for a specific resource will be tracked in separate Jira's.

For more information, see the attached documents starting with the API guidelines doc.


  was:
Review existing management services for usability and consistency with the monitoring API. All management API resources must utilize the API framework and follow the same pattern as the monitoring API where there is a plural collection resource followed by a singular instance resource. Also, package names should be consistent and have a common parent package where it makes sense to avoid having service classes strewn all over the place. Following these guidelines will help to ensure a consistent behavior across the entire API. If a service is truly private it should be clear by the package name. All services need to be represented as a single consistent API, not a random collection of independent API's/services. Current services will also be evaluated to ensure that they are necessary and can't be replaced/combined with other services.

This is an umbrella Jira for all management API cleanup.  The actual work of updating the API for a specific resource will be tracked in separate Jira's.

For more information, see the attached documents starting with the API guidelines doc.


> Publish a management API which is consistent with the version 1 monitoring API
> ------------------------------------------------------------------------------
>
>                 Key: AMBARI-1380
>                 URL: https://issues.apache.org/jira/browse/AMBARI-1380
>             Project: Ambari
>          Issue Type: Bug
>            Reporter: John Speidel
>            Assignee: John Speidel
>             Fix For: 1.3.0
>
>         Attachments: Ambari-Cluster_Controller-SPI_v2.docx, ambari-monitoring-api-v102.docx, Ambari REST API Guidelines.docx, plugging_into_ambari_rest_api_framework.docx
>
>
> There are currently several Ambari REST services which provide various forms of management functionality.  These services/API's were not built in a manner which is consistent with the overall Ambari API design and were built specifically to provide functionality for the Ambari UI.  This goal of this task is to take these existing management services, clean them up, make them consistent with the overall API and document them for general use. 
> Review existing management services for usability and consistency with the monitoring API. All management API resources must utilize the API framework and follow the same pattern as the monitoring API where there is a plural collection resource followed by a singular instance resource. Also, package names should be consistent and have a common parent package where it makes sense to avoid having service classes strewn all over the place. Following these guidelines will help to ensure a consistent behavior across the entire API. If a service is truly private it should be clear by the package name. All services need to be represented as a single consistent API, not a random collection of independent API's/services. Current services will also be evaluated to ensure that they are necessary and can't be replaced/combined with other services.
> This is an umbrella Jira for all management API cleanup.  The actual work of updating the API for a specific resource will be tracked in separate Jira's.
> For more information, see the attached documents starting with the API guidelines doc.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira