[jira] [Commented] (MESOS-4787) HTTP endpoint docs should use shorter paths

["Neil Conway (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MESOS-4787?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15169532#comment-15169532 ] 

Neil Conway commented on MESOS-4787:
------------------------------------

cc [~klueska] [~bmahler]

> HTTP endpoint docs should use shorter paths
> -------------------------------------------
>
>                 Key: MESOS-4787
>                 URL: https://issues.apache.org/jira/browse/MESOS-4787
>             Project: Mesos
>          Issue Type: Documentation
>          Components: documentation
>            Reporter: Neil Conway
>            Priority: Minor
>              Labels: documentation, mesosphere
>
> My understanding is that the recommended path for the v1 scheduler API is {{/api/v1/scheduler}}, but the HTTP endpoint docs for this endpoint list the path as {{/master/api/v1/scheduler}}; the filename of the doc page is also in the {{master}} subdirectory.
> Similarly, we document the master state endpoint as {{/master/state}}, whereas the preferred name is now just {{/state}}, and so on for most of the other endpoints. Unlike we the V1 API, we might want to consider backward compatibility and document both forms -- not sure. But certainly it seems like we should encourage people to use the shorter paths, not the longer ones.



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