blob: fb95d7158ef441cf1e7fec1964bfdce73d6f2dd9 [file] [log] [blame]
{
"swagger" : "2.0",
"info" : {
"description" : "Ambari REST APIs has inherent support for querying, sorting and pagination",
"version" : "v1",
"title" : "Swagger spec for Ambari REST API",
"license" : {
"name" : "Apache License, Version 2.0",
"url" : "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"basePath" : "/api/v1",
"tags" : [ {
"name" : "Actions",
"description" : "Endpoint for action definition specific operations"
}, {
"name" : "Alerts",
"description" : "Endpoint for alert specific operations"
}, {
"name" : "Auth",
"description" : "Endpoint for authentication operations"
}, {
"name" : "Blueprints",
"description" : "Endpoint for blueprint specific operations"
}, {
"name" : "Cluster Services",
"description" : "Endpoint for service specific operations"
}, {
"name" : "Clusters",
"description" : "Endpoint for cluster-specific operations"
}, {
"name" : "Config Groups",
"description" : "Endpoint for config-group-specific operations"
}, {
"name" : "Configurations",
"description" : "Endpoint for configuration-specific operations"
}, {
"name" : "Groups",
"description" : "Endpoint for group specific operations"
}, {
"name" : "Host Components",
"description" : "Endpoint for host component specific operations"
}, {
"name" : "Hosts",
"description" : "Endpoint for host-specific operations"
}, {
"name" : "RequestSchedules",
"description" : "Endpoint for request schedule specific operations"
}, {
"name" : "Requests",
"description" : "Endpoint for request specific operations"
}, {
"name" : "Root Service Configurations",
"description" : "Endpoint for Ambari root service component configuration related operations"
}, {
"name" : "Services",
"description" : "Endpoint for querying root-level services, ie. Ambari Server and Ambari Agents"
}, {
"name" : "Settings",
"description" : "Endpoint for settings-specific operations"
}, {
"name" : "Stacks",
"description" : "Endpoint for stack specific operations"
}, {
"name" : "User Authentication Sources",
"description" : "Endpoint for user specific authentication source operations"
}, {
"name" : "Users",
"description" : "Endpoint for user specific operations"
}, {
"name" : "Views"
} ],
"paths" : {
"/actions" : {
"get" : {
"tags" : [ "Actions" ],
"summary" : "Get all action definitions",
"description" : "",
"operationId" : "ActionService#getActionDefinitions",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "Actions/action_name"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string",
"default" : "Actions/action_name.asc"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ActionResponseSwagger"
}
}
},
"401" : {
"description" : "Not authenticated"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/actions/{actionName}" : {
"get" : {
"tags" : [ "Actions" ],
"summary" : "Get the details of an action definition",
"description" : "",
"operationId" : "ActionService#getActionDefinition",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "actionName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "Actions/*"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/ActionResponseSwagger"
}
},
"401" : {
"description" : "Not authenticated"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Actions" ],
"summary" : "Creates an action definition - Currently Not Supported",
"description" : "",
"operationId" : "ActionService#createActionDefinition",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "actionName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ActionRequestSwagger"
}
} ],
"responses" : {
"400" : {
"description" : "Invalid request"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Actions" ],
"summary" : "Updates an action definition - Currently Not Supported",
"description" : "",
"operationId" : "ActionService#updateActionDefinition",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "actionName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ActionRequestSwagger"
}
} ],
"responses" : {
"400" : {
"description" : "Invalid request"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Actions" ],
"summary" : "Deletes an action definition - Currently Not Supported",
"description" : "",
"operationId" : "ActionService#deleteActionDefinition",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "actionName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/alert_targets" : {
"get" : {
"tags" : [ "Alerts" ],
"summary" : "Returns all alert targets",
"description" : "",
"operationId" : "getTargets",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "AlertTarget/*"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0.0
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "integer",
"minimum" : 1.0
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AlertTargetSwagger"
}
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Alerts" ],
"summary" : "Creates an alert target",
"description" : "",
"operationId" : "createTarget",
"produces" : [ "text/plain" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AlertTargetSwagger"
}
}, {
"name" : "validate_config",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "overwrite_existing",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/alert_targets/{targetId}" : {
"get" : {
"tags" : [ "Alerts" ],
"summary" : "Returns a single alert target",
"description" : "",
"operationId" : "getTarget",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "targetId",
"in" : "path",
"description" : "alert target id",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "AlertTarget/*"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0.0
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "integer",
"minimum" : 1.0
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/AlertTargetSwagger"
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Alerts" ],
"summary" : "Updates an alert target",
"description" : "",
"operationId" : "updateTarget",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "targetId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AlertTargetSwagger"
}
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Alerts" ],
"summary" : "Deletes an alert target",
"description" : "",
"operationId" : "deleteTarget",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "targetId",
"in" : "path",
"required" : true,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/auth" : {
"post" : {
"tags" : [ "Auth" ],
"summary" : "User authorization request",
"description" : "",
"operationId" : "getUsersViaPost",
"produces" : [ "text/plain" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/AuthRequestCreateAuthSwagger"
}
} ],
"responses" : {
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/blueprints" : {
"get" : {
"tags" : [ "Blueprints" ],
"summary" : "Get all blueprints",
"description" : "",
"operationId" : "BlueprintService#getBlueprints",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "Blueprints/blueprint_name"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string",
"default" : "Blueprints/blueprint_name.asc"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BlueprintSwagger"
}
}
},
"401" : {
"description" : "Not authenticated"
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Blueprints" ],
"summary" : "Deletes multiple blueprints that match the predicate. Omitting the predicate will delete all blueprints.",
"description" : "",
"operationId" : "BlueprintService#deleteBlueprints",
"produces" : [ "text/plain" ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/blueprints/{blueprintName}" : {
"get" : {
"tags" : [ "Blueprints" ],
"summary" : "Get the details of a blueprint",
"description" : "",
"operationId" : "BlueprintService#getBlueprint",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "blueprintName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "Blueprints/*"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BlueprintSwagger"
}
}
},
"401" : {
"description" : "Not authenticated"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Blueprints" ],
"summary" : "Creates a blueprint",
"description" : "",
"operationId" : "BlueprintService#createBlueprint",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "blueprintName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/BlueprintSwagger"
}
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "The requested resource doesn't exist."
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"409" : {
"description" : "The requested resource already exists."
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Blueprints" ],
"summary" : "Deletes a blueprint",
"description" : "",
"operationId" : "BlueprintService#deleteBlueprint",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "blueprintName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters" : {
"get" : {
"tags" : [ "Clusters" ],
"summary" : "Returns all clusters",
"description" : "",
"operationId" : "getClusters",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0.0
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "integer",
"minimum" : 1.0
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ClusterResponseWrapper"
}
}
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}" : {
"get" : {
"tags" : [ "Clusters" ],
"summary" : "Returns information about a specific cluster",
"description" : "",
"operationId" : "getCluster",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "Clusters/*"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/ClusterResponseWrapper"
}
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Clusters" ],
"summary" : "Creates a cluster",
"description" : "",
"operationId" : "createCluster",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterRequestSwagger"
}
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"409" : {
"description" : "The requested resource already exists."
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Clusters" ],
"summary" : "Updates a cluster",
"description" : "",
"operationId" : "updateCluster",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterRequestSwagger"
}
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Clusters" ],
"summary" : "Deletes a cluster",
"description" : "",
"operationId" : "deleteCluster",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/artifacts" : {
"get" : {
"tags" : [ "Clusters" ],
"summary" : "Returns all artifacts associated with the cluster",
"description" : "",
"operationId" : "getClusterArtifacts",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0.0
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "integer",
"minimum" : 1.0
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ClusterArtifactResponse"
}
}
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Clusters" ],
"summary" : "Updates multiple artifacts",
"description" : "",
"operationId" : "updateClusterArtifacts",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterArtifactRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Clusters" ],
"summary" : "Deletes all artifacts of a cluster that match the provided predicate",
"description" : "",
"operationId" : "deleteClusterArtifacts",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/artifacts/{artifactName}" : {
"get" : {
"tags" : [ "Clusters" ],
"summary" : "Get the details of a cluster artifact",
"description" : "",
"operationId" : "getClusterArtifact",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "artifactName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/ClusterArtifactResponse"
}
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Clusters" ],
"summary" : "Creates a cluster artifact",
"description" : "",
"operationId" : "createClusterArtifact",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "artifactName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterArtifactRequest"
}
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"409" : {
"description" : "The requested resource already exists."
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Clusters" ],
"summary" : "Updates a single artifact",
"description" : "",
"operationId" : "updateClusterArtifact",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "artifactName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterArtifactRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Clusters" ],
"summary" : "Deletes a single artifact",
"description" : "",
"operationId" : "deleteClusterArtifact",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "artifactName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/config_groups" : {
"get" : {
"tags" : [ "Config Groups" ],
"summary" : "Returns all config groups",
"description" : "",
"operationId" : "getConfigGroups",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "ConfigGroup/*"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0.0
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "integer",
"minimum" : 1.0
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConfigGroupWrapper"
}
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Config Groups" ],
"summary" : "Creates a config group",
"description" : "",
"operationId" : "createConfigGroup",
"produces" : [ "text/plain" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ConfigGroupRequest"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/config_groups/{groupId}" : {
"get" : {
"tags" : [ "Config Groups" ],
"summary" : "Returns a single config group",
"description" : "",
"operationId" : "getConfigGroup",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "ConfigGroup/*"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/ConfigGroupWrapper"
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Config Groups" ],
"summary" : "Updates a config group",
"description" : "",
"operationId" : "updateConfigGroup",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ConfigGroupRequest"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Config Groups" ],
"summary" : "Deletes a config group",
"description" : "",
"operationId" : "deleteConfigGroup",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/configurations" : {
"get" : {
"tags" : [ "Configurations" ],
"summary" : "Get all configurations",
"description" : "",
"operationId" : "getConfigurations",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0.0
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "integer",
"minimum" : 1.0
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConfigurationResponse"
}
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Configurations" ],
"summary" : "Create new configurations",
"description" : "",
"operationId" : "createConfigurations",
"produces" : [ "text/plain" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ConfigurationRequest"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster not found"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/configurations/service_config_versions" : {
"get" : {
"tags" : [ "Configurations" ],
"summary" : "Get all service config versions",
"description" : "",
"operationId" : "getServiceConfigVersions",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0.0
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "integer",
"minimum" : 1.0
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ServiceConfigVersionResponse"
}
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/host_components" : {
"get" : {
"tags" : [ "Host Components" ],
"summary" : "Get all host components for a host",
"description" : "",
"operationId" : "getHostComponents",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "format",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HostComponentSwagger"
}
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Host Components" ],
"summary" : "Delete host components",
"description" : "",
"operationId" : "deleteHostComponents",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/host_components/{hostComponentName}" : {
"get" : {
"tags" : [ "Host Components" ],
"summary" : "Get single host component for a host",
"description" : "",
"operationId" : "getHostComponent",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "hostComponentName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "format",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/HostComponentSwagger"
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Host Components" ],
"summary" : "Create new host component",
"description" : "",
"operationId" : "createHostComponent",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "hostComponentName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ServiceComponentHostResponse"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Host Components" ],
"summary" : "Update host component detail",
"description" : "",
"operationId" : "updateHostComponent",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "hostComponentName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ServiceComponentHostResponse"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Host Components" ],
"summary" : "Delete host component",
"description" : "",
"operationId" : "deleteHostComponent",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "hostComponentName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/host_components/{hostComponentName}/processes" : {
"get" : {
"tags" : [ "Host Components" ],
"summary" : "Get processes of a specific host component",
"description" : "",
"operationId" : "getProcesses",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "hostComponentName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/HostComponentProcessResponse"
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/request_schedules" : {
"get" : {
"tags" : [ "RequestSchedules" ],
"summary" : "Get all request schedules",
"description" : "",
"operationId" : "getRequestSchedules",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "RequestSchedule/*"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RequestScheduleResponseSwagger"
}
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "RequestSchedules" ],
"summary" : "Create new request schedule",
"description" : "",
"operationId" : "createRequestSchedule",
"produces" : [ "text/plain" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/RequestScheduleRequestSwagger"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster not found"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/request_schedules/{requestScheduleId}" : {
"get" : {
"tags" : [ "RequestSchedules" ],
"summary" : "Get request schedule",
"description" : "",
"operationId" : "getRequestSchedule",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "requestScheduleId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "RequestSchedule/*"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"$ref" : "#/definitions/RequestScheduleResponseSwagger"
}
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "RequestSchedules" ],
"summary" : "Delete a request schedule",
"description" : "Changes status from COMPLETED to DISABLED",
"operationId" : "deleteRequestSchedule",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "requestScheduleId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "Cluster or host not found"
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/services" : {
"get" : {
"tags" : [ "Cluster Services" ],
"summary" : "Get all services",
"description" : "Returns all services.",
"operationId" : "ServiceService#getServices",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "ServiceInfo/service_name,ServiceInfo/cluster_name"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string",
"default" : "ServiceInfo/service_name.asc,ServiceInfo/cluster_name.asc"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ServiceResponseSwagger"
}
}
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}" : {
"get" : {
"tags" : [ "Cluster Services" ],
"summary" : "Get the details of a service",
"description" : "Returns the details of a service.",
"operationId" : "ServiceService#getService",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "ServiceInfo/*"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ServiceResponseSwagger"
}
}
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Cluster Services" ],
"summary" : "Creates a service",
"description" : "",
"operationId" : "ServiceService#createServices",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ServiceRequestSwagger"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"409" : {
"description" : "The requested resource already exists."
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Cluster Services" ],
"summary" : "Updates a service",
"description" : "",
"operationId" : "ServiceService#updateService",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ServiceRequestSwagger"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Cluster Services" ],
"summary" : "Deletes a service",
"description" : "",
"operationId" : "ServiceService#deleteService",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/artifacts" : {
"get" : {
"tags" : [ "Cluster Services" ],
"summary" : "Get all service artifacts",
"description" : "",
"operationId" : "ServiceService#getArtifacts",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "Artifacts/artifact_name"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string",
"default" : "Artifacts/artifact_name"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ClusterServiceArtifactResponse"
}
}
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Cluster Services" ],
"summary" : "Updates multiple artifacts",
"description" : "",
"operationId" : "ServiceService#updateArtifacts",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterServiceArtifactRequest"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"delete" : {
"tags" : [ "Cluster Services" ],
"summary" : "Deletes all artifacts of a service that match the provided predicate",
"description" : "",
"operationId" : "ServiceService#deleteArtifacts",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}" : {
"get" : {
"tags" : [ "Cluster Services" ],
"summary" : "Get the details of a service artifact",
"description" : "",
"operationId" : "ServiceService#getArtifact",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "artifactName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter fields in the response (identifier fields are mandatory)",
"required" : false,
"type" : "string",
"default" : "Artifacts/artifact_name"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort resources in result by (asc | desc)",
"required" : false,
"type" : "string",
"default" : "Artifacts/artifact_name"
}, {
"name" : "page_size",
"in" : "query",
"description" : "The number of resources to be returned for the paged response.",
"required" : false,
"type" : "integer",
"default" : 10
}, {
"name" : "from",
"in" : "query",
"description" : "The starting page resource (inclusive). \"start\" is also accepted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "to",
"in" : "query",
"description" : "The ending page resource (inclusive). \"end\" is also accepted.",
"required" : false,
"type" : "string"
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ClusterServiceArtifactResponse"
}
}
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"500" : {
"description" : "Internal server error"
}
}
},
"post" : {
"tags" : [ "Cluster Services" ],
"summary" : "Creates a service artifact",
"description" : "",
"operationId" : "ServiceService#createArtifact",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "artifactName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterServiceArtifactRequest"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"201" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" : {
"description" : "Not authenticated"
},
"403" : {
"description" : "Not permitted to perform the operation"
},
"404" : {
"description" : "The requested resource doesn't exist."
},
"409" : {
"description" : "The requested resource already exists."
},
"500" : {
"description" : "Internal server error"
}
}
},
"put" : {
"tags" : [ "Cluster Services" ],
"summary" : "Updates a single artifact",
"description" : "",
"operationId" : "ServiceService#updateArtifact",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "artifactName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/ClusterServiceArtifactRequest"
}
}, {
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Successful operation"
},
"202" : {
"description" : "Request is accepted, but not completely processed yet"
},
"400" : {
"description" : "Invalid arguments"
},
"401" :