You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ka...@apache.org on 2017/08/18 17:31:46 UTC
[5/5] mesos git commit: Updated endpoints help docs.
Updated endpoints help docs.
Review: https://reviews.apache.org/r/61732
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/4c71ba1b
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/4c71ba1b
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/4c71ba1b
Branch: refs/heads/master
Commit: 4c71ba1bdae7022f6e60edbfbf4118cd3854734e
Parents: 58fd8cf
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Thu Aug 17 22:30:17 2017 -0400
Committer: Kapil Arya <ka...@mesosphere.io>
Committed: Fri Aug 18 13:30:15 2017 -0400
----------------------------------------------------------------------
docs/endpoints/index.md | 1 +
docs/endpoints/master/frameworks.md | 3 +++
docs/endpoints/master/slaves.md | 3 +++
docs/endpoints/master/tasks.json.md | 2 ++
docs/endpoints/master/tasks.md | 2 ++
.../endpoints/slave/api/v1/resource_provider.md | 28 ++++++++++++++++++++
6 files changed, 39 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/4c71ba1b/docs/endpoints/index.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/index.md b/docs/endpoints/index.md
index eb88154..8711537 100644
--- a/docs/endpoints/index.md
+++ b/docs/endpoints/index.md
@@ -115,6 +115,7 @@ For example, `http://agent.com:5051/files/browse`.
### slave(id) ###
* [/api/v1](slave/api/v1.md)
* [/api/v1/executor](slave/api/v1/executor.md)
+* [/api/v1/resource_provider](slave/api/v1/resource_provider.md)
* [/containers](slave/containers.md)
* [/flags](slave/flags.md)
* [/health](slave/health.md)
http://git-wip-us.apache.org/repos/asf/mesos/blob/4c71ba1b/docs/endpoints/master/frameworks.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/frameworks.md b/docs/endpoints/master/frameworks.md
index 1a7950a..7aa2213 100644
--- a/docs/endpoints/master/frameworks.md
+++ b/docs/endpoints/master/frameworks.md
@@ -20,6 +20,9 @@ current master is not the leader.
Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be
found.
+Query parameters:
+> framework_id=VALUE The ID of the framework returned (if no framework ID is specified, all frameworks will be returned).
+
### AUTHENTICATION ###
This endpoint requires authentication iff HTTP authentication is
http://git-wip-us.apache.org/repos/asf/mesos/blob/4c71ba1b/docs/endpoints/master/slaves.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/slaves.md b/docs/endpoints/master/slaves.md
index f9bb7ef..9365cdb 100644
--- a/docs/endpoints/master/slaves.md
+++ b/docs/endpoints/master/slaves.md
@@ -24,6 +24,9 @@ This endpoint shows information about the agents which are registered
in this master or recovered from registry, formatted as a JSON
object.
+Query parameters:
+> slave_id=VALUE The ID of the slave returned (when no slave_id is specified, all slaves will be returned).
+
### AUTHENTICATION ###
This endpoint requires authentication iff HTTP authentication is
http://git-wip-us.apache.org/repos/asf/mesos/blob/4c71ba1b/docs/endpoints/master/tasks.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/tasks.json.md b/docs/endpoints/master/tasks.json.md
index f6b808d..f9553d7 100644
--- a/docs/endpoints/master/tasks.json.md
+++ b/docs/endpoints/master/tasks.json.md
@@ -26,9 +26,11 @@ accessing the endpoint.
Query parameters:
+> framework_id=VALUE Only return tasks belonging to the framework with this ID.
> limit=VALUE Maximum number of tasks returned (default is 100).
> offset=VALUE Starts task list at offset.
> order=(asc|desc) Ascending or descending sort order (default is descending).
+> task_id=VALUE Only return tasks with this ID (should be used together with parameter 'framework_id').
### AUTHENTICATION ###
http://git-wip-us.apache.org/repos/asf/mesos/blob/4c71ba1b/docs/endpoints/master/tasks.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/tasks.md b/docs/endpoints/master/tasks.md
index da04c9f..019a14b 100644
--- a/docs/endpoints/master/tasks.md
+++ b/docs/endpoints/master/tasks.md
@@ -26,9 +26,11 @@ accessing the endpoint.
Query parameters:
+> framework_id=VALUE Only return tasks belonging to the framework with this ID.
> limit=VALUE Maximum number of tasks returned (default is 100).
> offset=VALUE Starts task list at offset.
> order=(asc|desc) Ascending or descending sort order (default is descending).
+> task_id=VALUE Only return tasks with this ID (should be used together with parameter 'framework_id').
### AUTHENTICATION ###
http://git-wip-us.apache.org/repos/asf/mesos/blob/4c71ba1b/docs/endpoints/slave/api/v1/resource_provider.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/api/v1/resource_provider.md b/docs/endpoints/slave/api/v1/resource_provider.md
new file mode 100644
index 0000000..c721c6d
--- /dev/null
+++ b/docs/endpoints/slave/api/v1/resource_provider.md
@@ -0,0 +1,28 @@
+---
+title: Apache Mesos - HTTP Endpoints - /api/v1/resource_provider
+layout: documentation
+---
+<!--- This is an automatically generated file. DO NOT EDIT! --->
+
+### USAGE ###
+> /api/v1/resource_provider
+> /slave(1)/api/v1/resource_provider
+
+### TL;DR; ###
+Endpoint for the local resource provider HTTP API.
+
+### DESCRIPTION ###
+This endpoint is used by the local resource providers to interact
+with the agent via Call/Event messages.
+
+Returns 200 OK iff the initial SUBSCRIBE Call is successful. This
+will result in a streaming response via chunked transfer encoding.
+The local resource providers can process the response incrementally.
+
+Returns 202 Accepted for all other Call messages iff the request is
+accepted.
+
+
+### AUTHENTICATION ###
+This endpoint requires authentication iff HTTP authentication is
+enabled.
\ No newline at end of file