[jira] [Created] (YUNIKORN-165) Return response fields of APIs as a proper struct rather than free text

["Ayub Pathan (Jira)" <ji...@apache.org>]

Ayub Pathan created YUNIKORN-165:
------------------------------------

             Summary: Return response fields of APIs as a proper struct rather than free text
                 Key: YUNIKORN-165
                 URL: https://issues.apache.org/jira/browse/YUNIKORN-165
             Project: Apache YuniKorn
          Issue Type: Bug
          Components: core - common
            Reporter: Ayub Pathan


For most of the APIs, some of the fields are recorded as free text, this can be improved by sending them as proper data structure like map etc. This helps in easy consumption of the REST aPI response.

For example:
 * Some fields from Apps API like resource,usedResource, partition can be returned as maps..
{noformat}
    {
        "allocations": [
            {
                "allocationKey": "1e5225f7-4d60-400f-8b9b-5b7027b4c394",
                "allocationTags": null,
                "applicationId": "abcd",
                "nodeId": "docker-desktop",
                "partition": "default",
                "priority": "<nil>",
                "queueName": "root.development",
                "resource": "[memory:100 vcore:200]",
                "uuid": "b1b89eaf-81fb-4b2b-b20a-bf7bd96d3430"
            }
        ],
        "applicationID": "abcd",
        "applicationState": "Running",
        "partition": "[mycluster]default",
        "queueName": "root.development",
        "submissionTime": 1589740021170274400,
        "usedResource": "[memory:100 vcore:200]"
    }, {noformat}
 

 *  same for nodes API response(fields like available, capacity, occupied, allocated) as well.
{noformat}
    [
    {
        "nodesInfo": [
            {
                "RackName": "/rack-default",
                "allocated": "[memory:0 vcore:0]",
                "allocations": null,
                "available": "[ephemeral-storage:56450230179 hugepages-1Gi:0 hugepages-2Mi:0 memory:1824 pods:110 vcore:3250]",
                "capacity": "[ephemeral-storage:56450230179 hugepages-1Gi:0 hugepages-2Mi:0 memory:1982 pods:110 vcore:4000]",
                "hostName": "docker-desktop",   
                "nodeID": "docker-desktop",
                "occupied": "[memory:158 vcore:750]",
                "schedulable": true
            }
        ],
        "partitionName": "[mycluster]default"
    }
] {noformat}

 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: issues-help@yunikorn.apache.org