Added missing documentation for authentication-enabled endpoints. Review: https://reviews.apache.org/r/47314/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/2e3707f2 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/2e3707f2 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/2e3707f2 Branch: refs/heads/master Commit: 2e3707f2d90ce103f4c4977094e5ae463566d900 Parents: f742f8d Author: Benjamin Bannier <benjamin.bann...@mesosphere.io> Authored: Fri May 13 11:36:00 2016 +0200 Committer: Alexander Rukletsov <al...@apache.org> Committed: Fri May 13 11:44:56 2016 +0200 ---------------------------------------------------------------------- docs/endpoints/files/browse.json.md | 7 ++++++- docs/endpoints/files/browse.md | 7 ++++++- docs/endpoints/files/debug.json.md | 7 ++++++- docs/endpoints/files/debug.md | 7 ++++++- docs/endpoints/files/download.json.md | 7 ++++++- docs/endpoints/files/download.md | 7 ++++++- docs/endpoints/files/read.json.md | 7 ++++++- docs/endpoints/files/read.md | 7 ++++++- docs/endpoints/logging/toggle.md | 4 ++++ docs/endpoints/metrics/snapshot.md | 7 ++++++- docs/endpoints/profiler/start.md | 7 ++++++- docs/endpoints/profiler/stop.md | 7 ++++++- docs/endpoints/registrar/registry.md | 7 ++++++- src/files/files.cpp | 13 +++++++++---- src/master/registrar.cpp | 4 +++- 15 files changed, 88 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/browse.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/browse.json.md b/docs/endpoints/files/browse.json.md index ee2f48f..7615743 100644 --- a/docs/endpoints/files/browse.json.md +++ b/docs/endpoints/files/browse.json.md @@ -16,4 +16,9 @@ a JSON object. Query parameters: -> path=VALUE The path of directory to browse. \ No newline at end of file +> path=VALUE The path of directory to browse. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/browse.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/browse.md b/docs/endpoints/files/browse.md index 3060c5b..22d5c58 100644 --- a/docs/endpoints/files/browse.md +++ b/docs/endpoints/files/browse.md @@ -16,4 +16,9 @@ a JSON object. Query parameters: -> path=VALUE The path of directory to browse. \ No newline at end of file +> path=VALUE The path of directory to browse. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/debug.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/debug.json.md b/docs/endpoints/files/debug.json.md index 7e367b3..a4dc0de 100644 --- a/docs/endpoints/files/debug.json.md +++ b/docs/endpoints/files/debug.json.md @@ -12,4 +12,9 @@ Returns the internal virtual path mapping. ### DESCRIPTION ### This endpoint shows the internal virtual path map as a -JSON object. \ No newline at end of file +JSON object. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/debug.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/debug.md b/docs/endpoints/files/debug.md index 31d3446..9361ffe 100644 --- a/docs/endpoints/files/debug.md +++ b/docs/endpoints/files/debug.md @@ -12,4 +12,9 @@ Returns the internal virtual path mapping. ### DESCRIPTION ### This endpoint shows the internal virtual path map as a -JSON object. \ No newline at end of file +JSON object. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/download.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/download.json.md b/docs/endpoints/files/download.json.md index 6b73f29..4e98317 100644 --- a/docs/endpoints/files/download.json.md +++ b/docs/endpoints/files/download.json.md @@ -16,4 +16,9 @@ given path. Query parameters: -> path=VALUE The path of directory to browse. \ No newline at end of file +> path=VALUE The path of directory to browse. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/download.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/download.md b/docs/endpoints/files/download.md index 17cdb26..709e027 100644 --- a/docs/endpoints/files/download.md +++ b/docs/endpoints/files/download.md @@ -16,4 +16,9 @@ given path. Query parameters: -> path=VALUE The path of directory to browse. \ No newline at end of file +> path=VALUE The path of directory to browse. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/read.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/read.json.md b/docs/endpoints/files/read.json.md index c4d5967..2fbdc67 100644 --- a/docs/endpoints/files/read.json.md +++ b/docs/endpoints/files/read.json.md @@ -17,4 +17,9 @@ Query parameters: > path=VALUE The path of directory to browse. > offset=VALUE Value added to base address to obtain a second > address -> length=VALUE Length of file to read. \ No newline at end of file +> length=VALUE Length of file to read. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/files/read.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/read.md b/docs/endpoints/files/read.md index 2e1ffac..3966d24 100644 --- a/docs/endpoints/files/read.md +++ b/docs/endpoints/files/read.md @@ -17,4 +17,9 @@ Query parameters: > path=VALUE The path of directory to browse. > offset=VALUE Value added to base address to obtain a second > address -> length=VALUE Length of file to read. \ No newline at end of file +> length=VALUE Length of file to read. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/logging/toggle.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/logging/toggle.md b/docs/endpoints/logging/toggle.md index f76accd..014a196 100644 --- a/docs/endpoints/logging/toggle.md +++ b/docs/endpoints/logging/toggle.md @@ -25,4 +25,8 @@ Query parameters: > toggled (e.g., 10secs, 15mins, etc.) +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. + [glog]: https://code.google.com/p/google-glog \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/metrics/snapshot.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/metrics/snapshot.md b/docs/endpoints/metrics/snapshot.md index 7d3a7ef..0912fa9 100644 --- a/docs/endpoints/metrics/snapshot.md +++ b/docs/endpoints/metrics/snapshot.md @@ -18,4 +18,9 @@ The optional query parameter 'timeout' determines the maximum amount of time the endpoint will take to respond. If the timeout is exceeded, some metrics may not be included in the response. -The key is the metric name, and the value is a double-type. \ No newline at end of file +The key is the metric name, and the value is a double-type. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/profiler/start.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/profiler/start.md b/docs/endpoints/profiler/start.md index 36bd0b6..a25f0d0 100644 --- a/docs/endpoints/profiler/start.md +++ b/docs/endpoints/profiler/start.md @@ -11,4 +11,9 @@ layout: documentation Start profiling. ### DESCRIPTION ### -Start to use google perftools do profiling. \ No newline at end of file +Start to use google perftools do profiling. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/profiler/stop.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/profiler/stop.md b/docs/endpoints/profiler/stop.md index 085b852..5028d13 100644 --- a/docs/endpoints/profiler/stop.md +++ b/docs/endpoints/profiler/stop.md @@ -11,4 +11,9 @@ layout: documentation Stops profiling. ### DESCRIPTION ### -Stop to use google perftools do profiling. \ No newline at end of file +Stop to use google perftools do profiling. + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/docs/endpoints/registrar/registry.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/registrar/registry.md b/docs/endpoints/registrar/registry.md index b3697a6..e347db2 100644 --- a/docs/endpoints/registrar/registry.md +++ b/docs/endpoints/registrar/registry.md @@ -55,4 +55,9 @@ Example: ] } } -``` \ No newline at end of file +``` + + +### AUTHENTICATION ### +This endpoint requires authentication iff HTTP authentication is +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/src/files/files.cpp ---------------------------------------------------------------------- diff --git a/src/files/files.cpp b/src/files/files.cpp index 4e91610..22e02df 100644 --- a/src/files/files.cpp +++ b/src/files/files.cpp @@ -56,6 +56,7 @@ using namespace process; +using process::AUTHENTICATION; using process::DESCRIPTION; using process::HELP; using process::TLDR; @@ -259,7 +260,8 @@ const string FilesProcess::BROWSE_HELP = HELP( "", "Query parameters:", "", - "> path=VALUE The path of directory to browse.")); + "> path=VALUE The path of directory to browse."), + AUTHENTICATION(true)); Future<Response> FilesProcess::browse( @@ -334,7 +336,8 @@ const string FilesProcess::READ_HELP = HELP( "> path=VALUE The path of directory to browse.", "> offset=VALUE Value added to base address to obtain " "a second address", - "> length=VALUE Length of file to read.")); + "> length=VALUE Length of file to read."), + AUTHENTICATION(true)); Future<Response> FilesProcess::read( @@ -476,7 +479,8 @@ const string FilesProcess::DOWNLOAD_HELP = HELP( "", "Query parameters:", "", - "> path=VALUE The path of directory to browse.")); + "> path=VALUE The path of directory to browse."), + AUTHENTICATION(true)); Future<Response> FilesProcess::download( @@ -527,7 +531,8 @@ const string FilesProcess::DEBUG_HELP = HELP( "Returns the internal virtual path mapping."), DESCRIPTION( "This endpoint shows the internal virtual path map as a", - "JSON object.")); + "JSON object."), + AUTHENTICATION(true)); Future<Response> FilesProcess::debug( http://git-wip-us.apache.org/repos/asf/mesos/blob/2e3707f2/src/master/registrar.cpp ---------------------------------------------------------------------- diff --git a/src/master/registrar.cpp b/src/master/registrar.cpp index a509f45..f5e1e07 100644 --- a/src/master/registrar.cpp +++ b/src/master/registrar.cpp @@ -52,6 +52,7 @@ using process::spawn; using process::terminate; using process::wait; // Necessary on some OS's to disambiguate. +using process::AUTHENTICATION; using process::DESCRIPTION; using process::Failure; using process::Future; @@ -321,7 +322,8 @@ string RegistrarProcess::registryHelp() " ]", " }", "}", - "```")); + "```"), + AUTHENTICATION(true)); }
