github.com/sap/cf-mta-plugin@v2.6.3+incompatible/clients/swagger/mta_rest.yaml (about)

     1  ---
     2  swagger: "2.0"
     3  info:
     4    description: "This is an API for the deploy-service(MTA) application"
     5    version: "1.0.0"
     6    title: "MTA REST API"
     7    contact:
     8      email: "DL_563CD7577BCF844DBD000037@exchange.sap.corp"
     9    license:
    10      name: "Apache 2.0"
    11      url: "http://www.apache.org/licenses/LICENSE-2.0.html"
    12  host: "deploy-service.bosh-lite.com"
    13  basePath: "/spaces/{space_guid}"
    14  schemes:
    15  - "https"
    16  consumes:
    17  - "application/json"
    18  produces:
    19  - "application/json"
    20  security:
    21  - oauth2: []
    22  paths:
    23    /mtas:
    24      get:
    25        description: "Retrieves all Multi-Target Applications in a space\n"
    26        operationId: "GetMtas"
    27        parameters: []
    28        responses:
    29          200:
    30            description: "OK"
    31            schema:
    32              type: "array"
    33              items:
    34                $ref: "#/definitions/Mta"
    35    /mtas/{mta_id}:
    36      get:
    37        description: "Retrieves Multi-Target Application in a space\n"
    38        operationId: "GetMta"
    39        parameters:
    40        - name: "mta_id"
    41          in: "path"
    42          required: true
    43          type: "string"
    44        responses:
    45          200:
    46            description: "OK"
    47            schema:
    48              $ref: "#/definitions/Mta"
    49    /files:
    50      get:
    51        description: "Retrieves all Multi-Target Application files\n"
    52        operationId: "GetMtaFiles"
    53        parameters: []
    54        responses:
    55          200:
    56            description: "OK"
    57            schema:
    58              type: "array"
    59              items:
    60                $ref: "#/definitions/FileMetadata"
    61      post:
    62        description: "Uploads an Multi Target Application file\n"
    63        operationId: "UploadMtaFile"
    64        consumes:
    65        - "multipart/form-data"
    66        parameters:
    67        - name: "file"
    68          in: "formData"
    69          required: true
    70          type: "file"
    71        responses:
    72          201:
    73            description: "Created"
    74            schema:
    75              $ref: "#/definitions/FileMetadata"
    76    /operations:
    77      get:
    78        description: "Retrieves Multi-Target Application operations\n"
    79        operationId: "GetMtaOperations"
    80        parameters:
    81        - name: "last"
    82          in: "query"
    83          required: false
    84          type: "integer"
    85        - name: "state"
    86          in: "query"
    87          required: false
    88          type: "array"
    89          items:
    90            type: "string"
    91          collectionFormat: "multi"
    92        responses:
    93          200:
    94            description: "OK"
    95            schema:
    96              type: "array"
    97              items:
    98                $ref: "#/definitions/Operation"
    99      post:
   100        description: "Starts execution of a Multi-Target Application operation\n"
   101        operationId: "StartMtaOperation"
   102        parameters:
   103        - in: "body"
   104          name: "operation"
   105          required: true
   106          schema:
   107            $ref: "#/definitions/Operation"
   108        responses:
   109          202:
   110            description: "Accepted"
   111            headers:
   112              Location:
   113                type: "string"
   114                format: "uri"
   115                description: "A Location header, used for transpassing between different\
   116                  \ resources\n"
   117    /operations/{operationId}:
   118      get:
   119        description: "Retrieves Multi-Target Application operation\n"
   120        operationId: "GetMtaOperation"
   121        parameters:
   122        - name: "operationId"
   123          in: "path"
   124          required: true
   125          type: "string"
   126        - name: "embed"
   127          in: "query"
   128          description: "Adds the specified property in the response body\n"
   129          required: false
   130          type: "string"
   131        responses:
   132          200:
   133            description: "OK"
   134            schema:
   135              $ref: "#/definitions/Operation"
   136      post:
   137        description: "Executes a particular action over Multi-Target Application operation\n"
   138        operationId: "ExecuteOperationAction"
   139        parameters:
   140        - name: "operationId"
   141          in: "path"
   142          required: true
   143          type: "string"
   144        - name: "actionId"
   145          in: "query"
   146          required: true
   147          type: "string"
   148        responses:
   149          202:
   150            description: "Accepted"
   151            headers:
   152              Location:
   153                type: "string"
   154                format: "uri"
   155    /operations/{operationId}/actions:
   156      get:
   157        description: "Retrieves available actions for Multi-Target Application operation\n"
   158        operationId: "GetOperationActions"
   159        parameters:
   160        - name: "operationId"
   161          in: "path"
   162          required: true
   163          type: "string"
   164        responses:
   165          200:
   166            description: "OK"
   167            schema:
   168              type: "array"
   169              items:
   170                type: "string"
   171    /operations/{operationId}/logs:
   172      get:
   173        description: "Retrieves the logs Multi-Target Application operation\n"
   174        operationId: "GetMtaOperationLogs"
   175        parameters:
   176        - name: "operationId"
   177          in: "path"
   178          required: true
   179          type: "string"
   180        responses:
   181          200:
   182            description: "OK"
   183            schema:
   184              type: "array"
   185              items:
   186                $ref: "#/definitions/Log"
   187    /operations/{operationId}/logs/{logId}/content:
   188      get:
   189        description: "Retrieves the log content for Multi-Target Application operation\n"
   190        operationId: "GetMtaOperationLogContent"
   191        produces:
   192        - "text/plain"
   193        parameters:
   194        - name: "operationId"
   195          in: "path"
   196          required: true
   197          type: "string"
   198        - name: "logId"
   199          in: "path"
   200          required: true
   201          type: "string"
   202        responses:
   203          200:
   204            description: "OK"
   205            schema:
   206              type: "string"
   207    /csrf-token:
   208      get:
   209        description: "Retrieves a csrf-token header\n"
   210        operationId: "getCsrfToken"
   211        parameters: []
   212        responses:
   213          204:
   214            description: "No Content"
   215    /info:
   216      get:
   217        description: "Retrieve information about the Deploy Service application\n"
   218        operationId: "getInfo"
   219        parameters: []
   220        responses:
   221          200:
   222            description: "OK"
   223            schema:
   224              $ref: "#/definitions/Info"
   225  securityDefinitions:
   226    oauth2:
   227      type: "oauth2"
   228      tokenUrl: "https://uaa.bosh-lite.com/oauth/token"
   229      flow: "password"
   230      scopes: {}
   231  definitions:
   232    FileMetadata:
   233      type: "object"
   234      properties:
   235        id:
   236          type: "string"
   237        name:
   238          type: "string"
   239        size:
   240          type: "number"
   241        digest:
   242          type: "string"
   243        digestAlgorithm:
   244          type: "string"
   245        space:
   246          type: "string"
   247    Mta:
   248      type: "object"
   249      properties:
   250        metadata:
   251          $ref: "#/definitions/Metadata"
   252        modules:
   253          type: "array"
   254          items:
   255            $ref: "#/definitions/Module"
   256        services:
   257          type: "array"
   258          uniqueItems: true
   259          items:
   260            type: "string"
   261    Metadata:
   262      type: "object"
   263      properties:
   264        id:
   265          type: "string"
   266        version:
   267          type: "string"
   268    Module:
   269      type: "object"
   270      properties:
   271        moduleName:
   272          type: "string"
   273        appName:
   274          type: "string"
   275        createdOn:
   276          type: "string"
   277          format: "date"
   278        updatedOn:
   279          type: "string"
   280          format: "date"
   281        providedDendencyNames:
   282          type: "array"
   283          items:
   284            type: "string"
   285        services:
   286          type: "array"
   287          items:
   288            type: "string"
   289        uris:
   290          type: "array"
   291          items:
   292            type: "string"
   293        deployAttributes:
   294          type: "object"
   295          additionalProperties:
   296            type: "object"
   297            properties: {}
   298    Operation:
   299      type: "object"
   300      properties:
   301        processId:
   302          type: "string"
   303        processType:
   304          type: "string"
   305        startedAt:
   306          type: "string"
   307        spaceId:
   308          type: "string"
   309        mtaId:
   310          type: "string"
   311        user:
   312          type: "string"
   313        acquiredLock:
   314          type: "boolean"
   315        state:
   316          $ref: "#/definitions/State"
   317        errorType:
   318          $ref: "#/definitions/ErrorType"
   319        messages:
   320          type: "array"
   321          items:
   322            $ref: "#/definitions/Message"
   323        parameters:
   324          type: "object"
   325          additionalProperties:
   326            type: "object"
   327            properties: {}
   328    Message:
   329      type: "object"
   330      properties:
   331        id:
   332          type: "integer"
   333        message:
   334          type: "string"
   335        type:
   336          $ref: "#/definitions/MessageType"
   337    Log:
   338      type: "object"
   339      properties:
   340        id:
   341          type: "string"
   342        lastModified:
   343          type: "string"
   344          format: "date-time"
   345        content:
   346          type: "string"
   347          format: "uri"
   348        size:
   349          type: "integer"
   350          format: "int64"
   351        displayName:
   352          type: "string"
   353        description:
   354          type: "string"
   355        externalInfo:
   356          type: "string"
   357          format: "uri"
   358    Info:
   359      type: "object"
   360      properties:
   361        api_version:
   362          type: "integer"
   363    State:
   364      type: "string"
   365      enum:
   366      - "RUNNING"
   367      - "FINISHED"
   368      - "ERROR"
   369      - "ABORTED"
   370      - "ACTION_REQUIRED"
   371    ErrorType:
   372      type: "string"
   373      enum:
   374      - "CONTENT"
   375      - "INFRASTRUCTURE"
   376    MessageType:
   377      type: "string"
   378      enum:
   379      - "INFO"
   380      - "ERROR"
   381      - "WARNING"
   382      - "EXT"
   383      - "TASK_STARTUP"
   384  parameters:
   385    space_guid:
   386      name: "space_guid"
   387      in: "path"
   388      required: true
   389      type: "string"
   390    file:
   391      name: "file"
   392      in: "formData"
   393      required: true
   394      type: "file"
   395    last:
   396      name: "last"
   397      in: "query"
   398      required: false
   399      type: "integer"
   400    status:
   401      name: "status"
   402      in: "query"
   403      required: false
   404      type: "array"
   405      items:
   406        type: "string"
   407      collectionFormat: "multi"
   408    operation:
   409      in: "body"
   410      name: "operation"
   411      required: true
   412      schema:
   413        $ref: "#/definitions/Operation"
   414    operationId:
   415      name: "operationId"
   416      in: "path"
   417      required: true
   418      type: "string"
   419    actionId:
   420      name: "actionId"
   421      in: "query"
   422      required: true
   423      type: "string"
   424    embed:
   425      name: "embed"
   426      in: "query"
   427      description: "Adds the specified property in the response body\n"
   428      required: false
   429      type: "string"
   430    logId:
   431      name: "logId"
   432      in: "path"
   433      required: true
   434      type: "string"