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

Anand Mazumdar updated MESOS-5790:
----------------------------------
    Description: 
Currently, there are a lot of JSON snippets in the [API Docs | 
http://mesos.apache.org/documentation/latest/scheduler-http-api/ ] that are not 
valid JSON i.e. have {{...}} to make the snippet succinct/easy to read. e.g., 
{code}
{{"filters"       : {...}
{code} 

However, this is a problem for framework developers who are trying to use the 
new API. Looking at the corresponding protobuf definitions can be a good place 
to start but hardly ideal.

It would be good to address the shortcomings and make the JSON snippets 
complete.

  was:
Currently, there are a lot of JSON snippets in the [API Docs | 
http://mesos.apache.org/documentation/latest/scheduler-http-api/ ] that are not 
valid JSON i.e. have {{...}} e.g., {{"filters"       : {...}}} to make the 
snippet succinct/easy to read. However, this is a problem for framework 
developers who are trying to use the new API. Looking at the corresponding 
protobuf definitions can be a good place to start but hardly ideal.

It would be good to address the shortcomings and make the JSON snippets 
complete.


> Ensure all examples in Scheduler HTTP API docs are valid JSON
> -------------------------------------------------------------
>
>                 Key: MESOS-5790
>                 URL: https://issues.apache.org/jira/browse/MESOS-5790
>             Project: Mesos
>          Issue Type: Improvement
>            Reporter: Anand Mazumdar
>              Labels: mesosphere, newbie
>
> Currently, there are a lot of JSON snippets in the [API Docs | 
> http://mesos.apache.org/documentation/latest/scheduler-http-api/ ] that are 
> not valid JSON i.e. have {{...}} to make the snippet succinct/easy to read. 
> e.g., 
> {code}
> {{"filters"       : {...}
> {code} 
> However, this is a problem for framework developers who are trying to use the 
> new API. Looking at the corresponding protobuf definitions can be a good 
> place to start but hardly ideal.
> It would be good to address the shortcomings and make the JSON snippets 
> complete.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to