dry.multiapps.multiapps-controller-api.1.173.1.source-code.mtarest.yaml Maven / Gradle / Ivy
---
swagger: "2.0"
info:
description: "This is the API of the Cloud Foundry MultiApps Controller"
version: "1.4.0"
title: "MTA REST API"
contact: {}
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
schemes:
- "https"
paths:
/api/v1/csrf-token:
get:
summary: ""
description: "Retrieves a csrf-token header "
operationId: "getCsrfToken"
parameters: []
responses:
204:
description: "No Content"
security:
- oauth2: []
/api/v1/info:
get:
summary: ""
description: "Retrieve information about the Deploy Service application "
operationId: "getInfo"
produces:
- "application/json"
parameters: []
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/Info"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/files:
get:
summary: ""
description: "Retrieves all Multi-Target Application files "
operationId: "getMtaFiles"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
description: "GUID of space with mtas"
required: true
type: "string"
- name: "namespace"
in: "query"
description: "Filter mtas by namespace"
required: false
type: "string"
responses:
200:
description: "OK"
schema:
type: "array"
items:
$ref: "#/definitions/FileMetadata"
security:
- oauth2: []
post:
summary: ""
description: "Uploads a Multi Target Application archive or an Extension Descriptor "
operationId: "uploadMtaFile"
consumes:
- "multipart/form-data"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
description: "GUID of space you wish to deploy in"
required: true
type: "string"
- name: "namespace"
in: "query"
description: "file namespace"
required: false
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/FileMetadata"
201:
description: "Created"
schema:
$ref: "#/definitions/FileMetadata"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/files/async:
post:
summary: ""
description: "Uploads a Multi Target Application archive or an Extension Descriptor\
\ from a remote endpoint"
operationId: "startUploadFromUrl"
consumes:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
description: "GUID of space you wish to deploy in"
required: true
type: "string"
- name: "namespace"
in: "query"
description: "file namespace"
required: false
type: "string"
- in: "body"
name: "body"
description: "URL reference to a remote file"
required: false
schema:
$ref: "#/definitions/FileUrl"
responses:
202:
description: "Accepted"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/files/jobs/{jobId}:
get:
summary: ""
description: "Gets the status of an async upload job"
operationId: "getAsyncUploadJob"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
description: "GUID of space you wish to deploy in"
required: true
type: "string"
- name: "namespace"
in: "query"
description: "file namespace"
required: false
type: "string"
- name: "jobId"
in: "path"
description: "ID of the upload job"
required: true
type: "string"
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/AsyncUploadResult"
201:
description: "Created"
schema:
$ref: "#/definitions/AsyncUploadResult"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/mtas:
get:
summary: ""
description: "Retrieves all Multi-Target Applications in a space "
operationId: "getMtas"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
description: "GUID of space with mtas"
required: true
type: "string"
responses:
200:
description: "OK"
schema:
type: "array"
items:
$ref: "#/definitions/Mta"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/mtas/{mtaId}:
get:
summary: ""
description: "Retrieves Multi-Target Application in a space "
operationId: "getMta"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
description: "GUID of space with mtas"
required: true
type: "string"
- name: "mtaId"
in: "path"
description: "mtaID of requested mta"
required: true
type: "string"
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/Mta"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/operations:
get:
summary: ""
description: "Retrieves Multi-Target Application operations "
operationId: "getMtaOperations"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
required: true
type: "string"
- name: "mtaId"
in: "query"
required: false
type: "string"
- name: "last"
in: "query"
required: false
type: "integer"
format: "int32"
- name: "state"
in: "query"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
responses:
200:
description: "OK"
schema:
type: "array"
items:
$ref: "#/definitions/Operation"
security:
- oauth2: []
post:
summary: ""
description: "Starts execution of a Multi-Target Application operation "
operationId: "startMtaOperation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
required: true
type: "string"
- in: "body"
name: "body"
required: false
schema:
$ref: "#/definitions/Operation"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Operation"
202:
description: "Accepted"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/operations/{operationId}:
get:
summary: ""
description: "Retrieves Multi-Target Application operation "
operationId: "getMtaOperation"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
required: true
type: "string"
- name: "operationId"
in: "path"
required: true
type: "string"
- name: "embed"
in: "query"
description: "Adds the specified property in the response body "
required: false
type: "string"
responses:
200:
description: "OK"
schema:
$ref: "#/definitions/Operation"
security:
- oauth2: []
post:
summary: ""
description: "Executes a particular action over Multi-Target Application operation "
operationId: "executeOperationAction"
parameters:
- name: "spaceGuid"
in: "path"
required: true
type: "string"
- name: "operationId"
in: "path"
required: true
type: "string"
- name: "actionId"
in: "query"
required: true
type: "string"
responses:
202:
description: "Accepted"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/operations/{operationId}/actions:
get:
summary: ""
description: "Retrieves available actions for Multi-Target Application operation "
operationId: "getOperationActions"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
required: true
type: "string"
- name: "operationId"
in: "path"
required: true
type: "string"
responses:
200:
description: "OK"
schema:
type: "array"
items:
type: "string"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/operations/{operationId}/logs:
get:
summary: ""
description: "Retrieves the logs Multi-Target Application operation "
operationId: "getMtaOperationLogs"
produces:
- "application/json"
parameters:
- name: "spaceGuid"
in: "path"
required: true
type: "string"
- name: "operationId"
in: "path"
required: true
type: "string"
responses:
200:
description: "OK"
schema:
type: "array"
items:
$ref: "#/definitions/Log"
security:
- oauth2: []
/api/v1/spaces/{spaceGuid}/operations/{operationId}/logs/{logId}/content:
get:
summary: ""
description: "Retrieves the log content for Multi-Target Application operation "
operationId: "getMtaOperationLogContent"
produces:
- "text/plain"
parameters:
- name: "spaceGuid"
in: "path"
required: true
type: "string"
- name: "operationId"
in: "path"
required: true
type: "string"
- name: "logId"
in: "path"
required: true
type: "string"
responses:
200:
description: "OK"
schema:
type: "string"
security:
- oauth2: []
securityDefinitions:
oauth2:
type: "oauth2"
tokenUrl: "https://uaa.bosh-lite.com/oauth/token"
flow: "password"
scopes: {}
definitions:
AsyncUploadResult:
type: "object"
properties:
status:
type: "string"
readOnly: true
enum:
- "RUNNING"
- "FINISHED"
- "ERROR"
bytes_processed:
type: "integer"
format: "int64"
readOnly: true
error:
type: "string"
readOnly: true
file:
readOnly: true
$ref: "#/definitions/FileMetadata"
mta_id:
type: "string"
readOnly: true
client_actions:
type: "array"
readOnly: true
items:
type: "string"
enum:
- "RETRY_UPLOAD"
FileMetadata:
type: "object"
properties:
id:
type: "string"
readOnly: true
name:
type: "string"
readOnly: true
size:
type: "integer"
readOnly: true
digest:
type: "string"
readOnly: true
digestAlgorithm:
type: "string"
readOnly: true
space:
type: "string"
readOnly: true
namespace:
type: "string"
readOnly: true
FileUrl:
type: "object"
properties:
file_url:
type: "string"
readOnly: true
Info:
type: "object"
properties:
api_version:
type: "integer"
format: "int32"
readOnly: true
Log:
type: "object"
properties:
id:
type: "string"
readOnly: true
lastModified:
type: "string"
format: "date-time"
readOnly: true
content:
type: "string"
readOnly: true
size:
type: "integer"
format: "int64"
readOnly: true
displayName:
type: "string"
readOnly: true
description:
type: "string"
readOnly: true
externalInfo:
type: "string"
readOnly: true
Message:
type: "object"
properties:
id:
type: "integer"
format: "int64"
readOnly: true
text:
type: "string"
readOnly: true
timestamp:
type: "string"
format: "date-time"
readOnly: true
type:
type: "string"
readOnly: true
enum:
- "INFO"
- "ERROR"
- "WARNING"
- "EXT"
- "TASK_STARTUP"
Metadata:
type: "object"
properties:
id:
type: "string"
readOnly: true
version:
type: "string"
readOnly: true
namespace:
type: "string"
readOnly: true
Module:
type: "object"
properties:
moduleName:
type: "string"
readOnly: true
appName:
type: "string"
readOnly: true
createdOn:
type: "string"
format: "date-time"
readOnly: true
updatedOn:
type: "string"
format: "date-time"
readOnly: true
providedDendencyNames:
type: "array"
readOnly: true
items:
type: "string"
services:
type: "array"
readOnly: true
items:
type: "string"
uris:
type: "array"
readOnly: true
items:
type: "string"
Mta:
type: "object"
properties:
metadata:
readOnly: true
$ref: "#/definitions/Metadata"
modules:
type: "array"
readOnly: true
items:
$ref: "#/definitions/Module"
services:
type: "array"
readOnly: true
uniqueItems: true
items:
type: "string"
Operation:
type: "object"
properties:
processId:
type: "string"
readOnly: true
processType:
readOnly: true
$ref: "#/definitions/ProcessType"
startedAt:
type: "string"
format: "date-time"
readOnly: true
endedAt:
type: "string"
format: "date-time"
readOnly: true
spaceId:
type: "string"
readOnly: true
mtaId:
type: "string"
readOnly: true
namespace:
type: "string"
readOnly: true
user:
type: "string"
readOnly: true
acquiredLock:
type: "boolean"
readOnly: true
state:
type: "string"
readOnly: true
enum:
- "RUNNING"
- "FINISHED"
- "ERROR"
- "ABORTED"
- "ACTION_REQUIRED"
errorType:
type: "string"
readOnly: true
enum:
- "CONTENT"
- "INFRASTRUCTURE"
messages:
type: "array"
readOnly: true
items:
$ref: "#/definitions/Message"
parameters:
type: "object"
readOnly: true
additionalProperties:
type: "object"
ProcessType:
type: "object"
properties:
name:
type: "string"
readOnly: true
© 2015 - 2025 Weber Informatics LLC | Privacy Policy