Skip to content

Commit

Permalink
JSDOCS
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel committed Apr 17, 2017
1 parent 59e6836 commit a37ef76
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 50 deletions.
4 changes: 3 additions & 1 deletion lib/fields.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ module.exports = function methods(request) {

return {
/**
* @param agent_id String
* @param agentId
* @param field String
* @param AcceptHeader String
* @param requestStream Boolean
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/fields/{field}
* https://dcos.io/docs/1.9/administration/logging/logging-api/#/
Expand Down
72 changes: 40 additions & 32 deletions lib/range.js
View file
Original file line number Diff line number Diff line change
@@ -1,46 +1,54 @@
module.exports = function methods(request) {

return {
/**
* @param agentId String
* @param AcceptHeader String
* @param requestStream Boolean
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range
*/
get: (agentId, AcceptHeader, requestStream, parameters) => {
/**
* @param agent_id String
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range
*/
return request('GET', agentId, '/range/', AcceptHeader, requestStream)(parameters);
},
/**
* @param agentId String
* @param AcceptHeader String
* @param requestStream Boolean
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/download
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range_download
*/
download: (agentId, AcceptHeader, requestStream, parameters) => {
/**
* @param agent_id String
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/download
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range_download
*/
return request('GET', agentId, '/range/download/', AcceptHeader, requestStream)(parameters);
},
framework: (agentId, frameworkId, executorId, containerId, AcceptHeader, requestStream) => {
/**
* @param agent_id String
* @param framework_id String
* @param executor_id Stringd
* @param containe_id Stringd
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/framework/{framework_id}/executor/{executor_id}/container/{container_id}
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range_framework_framework_id_executor_executor_id_container_container_id
*/
/**
* @param agentId String
* @param frameworkId String
* @param executorId String
* @param containerId String
* @param AcceptHeader String
* @param requestStream Boolean
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/framework/{framework_id}/executor/{executor_id}/container/{container_id}
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range_framework_framework_id_executor_executor_id_container_container_id
*/
framework: (agentId, frameworkId, executorId, containerId, AcceptHeader, requestStream, parameters) => {
return request('GET', agentId, '/range/framework/' + frameworkId + '/executor/' + executorId + '/container/' + containerId + '/', AcceptHeader, requestStream)(parameters);
},
frameworkDownload: (agentId, frameworkId, executorId, containerId, AcceptHeader, requestStream) => {
/**
* @param agent_id String
* @param framework_id String
* @param executor_id Stringd
* @param containe_id Stringd
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/framework/{framework_id}/executor/{executor_id}/container/{container_id}/download
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range_framework_framework_id_executor_executor_id_container_container_id_download
*/
/**
* @param agentId String
* @param frameworkId String
* @param executorId String
* @param containerId String
* @param AcceptHeader String
* @param requestStream Boolean
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/range/framework/{framework_id}/executor/{executor_id}/container/{container_id}/download
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_range_framework_framework_id_executor_executor_id_container_container_id_download
*/
frameworkDownload: (agentId, frameworkId, executorId, containerId, AcceptHeader, requestStream , parameters) => {
return request('GET', agentId, '/range/framework/' + frameworkId + '/executor/' + executorId + '/container/' + containerId + '/download/', AcceptHeader, requestStream)(parameters);
}

Expand Down
37 changes: 20 additions & 17 deletions lib/stream.js
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
module.exports = function methods(request) {

return {
/**
* Stream the log entries back to client with Server-Sent-Events.
* @param agent_id String
* @param parameters Object
* @param AcceptHeader String
* @param requestStream Boolean
* /system/v1/agent/{agent_id}/logs/v1/stream/
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_stream
*/
get: (agentId, AcceptHeader, requestStream, parameters) => {
/**
* Stream the log entries back to client with Server-Sent-Events.
* @param agent_id String
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/stream/
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_stream
*/
return request('GET', agentId, '/stream/', AcceptHeader, requestStream)(parameters);
},
/**
* Stream the log entries back to client with Server-Sent-Events.
* @param agentId String
* @param frameworkId String
* @param executorId String
* @param containerId String
* @param AcceptHeader String
* @param requestStream Boolean
* /system/v1/agent/{agent_id}/logs/v1/stream/framework/{framework_id}/executor/{executor_id}/container/{container_id}
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_stream_framework_framework_id_executor_executor_id_container_container_id
*/
framework: (agentId, frameworkId, executorId, containerId, AcceptHeader, requestStream) => {
/**
* Stream the log entries back to client with Server-Sent-Events.
* @param agent_id String
* @param framework_id String
* @param executor_id Stringd
* @param containe_id Stringd
* @param parameters Object
* /system/v1/agent/{agent_id}/logs/v1/stream/framework/{framework_id}/executor/{executor_id}/container/{container_id}
* https://dcos.io/docs/1.9/administration/logging/logging-api/#!/default/get_stream_framework_framework_id_executor_executor_id_container_container_id
*/
return request('GET', agentId, '/stream/framework/' + frameworkId + '/executor/' + executorId + '/container/' + containerId + '/', AcceptHeader, requestStream,)(parameters);
},

Expand Down

0 comments on commit a37ef76

Please sign in to comment.