Skip to content

C
CONF
Commit 93cafadb authored by Spiros Koulouzis's avatar Spiros Koulouzis
Browse files
Options

confilcts

parent 640dca7f
Show whitespace changes
Inline Side-by-side
Showing with 546 additions and 282 deletions
openAPI/CONF-3.0.0-swagger.yaml
View file @ 93cafadb
---
swagger: "2.0" swagger: "2.0"
info: info:
description: "CONF allows application developers to seamlessly plan a customized virtual infrastructure based on application level constraints on QoS and resource budgets, provisioning the virtual infrastructure, deploy application components onto the virtual infrastructure, and start execution on demand using TOSCA." description: CONF allows application developers to seamlessly plan a customized virtual infrastructure based on application level constraints on QoS and resource budgets, provisioning the virtual infrastructure, deploy application components onto the virtual infrastructure, and start execution on demand using TOSCA.
version: "3.0.0" version: 3.0.0
title: "CONF" title: CONF
contact: contact:
email: "z.zhao@uva.nl" email: z.zhao@uva.nl
license: license:
name: "Apache 2.0" name: Apache 2.0
url: "http://www.apache.org/licenses/LICENSE-2.0.html" url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: "/conf-api/3.0" basePath: /conf-api/3.0
schemes: schemes:
- "https" - https
- "http" - http
paths: paths:
/tosca_template: /tosca_template:
post: post:
summary: "upload a tosca template description file" summary: upload a tosca template description file
description: "uploads and validates TOSCA template file" description: uploads and validates TOSCA template file
operationId: "uploadToscaTemplate" operationId: uploadToscaTemplate
consumes: consumes:
- "multipart/form-data" - multipart/form-data
parameters: parameters:
- in: "formData" - name: file
name: "file" in: formData
type: file description: tosca Template description
description: "tosca Template description"
required: true required: true
type: file
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
/tosca_template/ids: /tosca_template/ids:
get: get:
summary: "Get all topolog template IDs" summary: Get all topolog template IDs
description: "Returns all IDs" description: Returns all IDs
operationId: "getToscaTemplateIDs" operationId: getToscaTemplateIDs
produces: produces:
- "application/json" - application/json
parameters: []
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: array type: array
items: items:
type: string type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
/tosca_template/{id}: /tosca_template/{id}:
get: get:
summary: "Find topolog template by ID" summary: Find topolog template by ID
description: "Returns a single topolog template" description: Returns a single topolog template
operationId: "getToscaTemplateByID" operationId: getToscaTemplateByID
produces: produces:
- "text/plain" - text/plain
parameters: parameters:
- name: "id" - name: id
in: "path" in: path
description: "ID of topolog template to return" description: ID of topolog template to return
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
put: put:
summary: "Updates exisintg topolog template" summary: Updates exisintg topolog template
description: "" description: ""
operationId: "updateToscaTemplateByID" operationId: updateToscaTemplateByID
consumes: consumes:
- "multipart/form-data" - multipart/form-data
produces: produces:
- "text/plain" - text/plain
parameters: parameters:
- in: "formData" - name: file
name: "file" in: formData
description: tosca Template description
required: false
type: file type: file
description: "tosca Template description" - name: id
- name: "id" in: path
in: "path" description: ID of topolog template to return
description: "ID of topolog template to return"
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
delete: delete:
summary: "Deletes a tosca topology template" summary: Deletes a tosca topology template
description: "" description: ""
operationId: "deleteToscaTemplateByID" operationId: deleteToscaTemplateByID
parameters: parameters:
- name: "id" - name: id
in: "path" in: path
description: "ID of topology template to return" description: ID of topology template to return
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
/planner/plan/{id}: /planner/plan/{id}:
get: get:
summary: "plan tosca template" summary: plan tosca template
description: "Returns the ID of the planed topolog template" description: Returns the ID of the planed topolog template
operationId: "planToscaTemplateByID" operationId: planToscaTemplateByID
produces: produces:
- "text/plain" - text/plain
parameters: parameters:
- name: "id" - name: id
in: "path" in: path
description: "ID of topolog template to plan" description: ID of topolog template to plan
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
/provisioner/provision/{id}: /provisioner/provision/{id}:
get: get:
summary: "provision tosca template" summary: provision tosca template
description: "provosions the operationId: Plan Tosca Template Returns the provision ID" description: 'provosions the operationId: Plan Tosca Template Returns the provision ID'
operationId: "provisionPlanToscaTemplateByID" operationId: provisionPlanToscaTemplateByID
produces: produces:
- "text/plain" - text/plain
parameters: parameters:
- name: "id" - name: id
in: "path" in: path
description: "ID of topolog template to plan" description: ID of topolog template to plan
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
/deployer/deploy/{id}: /deployer/deploy/{id}:
get: get:
summary: "deploy the software tosca template" summary: deploy the software tosca template
description: "Returns the deployment ID" description: Returns the deployment ID
operationId: "deployProvisionToscaTemplateByID" operationId: deployProvisionToscaTemplateByID
produces: produces:
- "text/plain" - text/plain
parameters: parameters:
- name: "id" - name: id
in: "path" in: path
description: "ID of topolog template to deploy" description: ID of topolog template to deploy
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
/credential: /credential:
post: post:
summary: "Create credentials" summary: Create credentials
description: "Creates credentials" description: Creates credentials
operationId: "createCredentials" operationId: createCredentials
produces:
- "application/json"
consumes: consumes:
- "application/json" - application/json
produces:
- application/json
parameters: parameters:
- in: "body" - in: body
name: "body" name: body
description: "Created user object" description: Created user object
required: true required: true
schema: schema:
$ref: "#/definitions/Credentials" $ref: '#/definitions/Credentials'
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:Credentials" - write:Credentials
- "read:Credentials" - read:Credentials
/credential/ids: /credential/ids:
get: get:
summary: "Get all credential IDs" summary: Get all credential IDs
description: "Returns all IDss " description: 'Returns all IDss '
operationId: "getCredentialIDs" operationId: getCredentialIDs
produces: produces:
- "application/json" - application/json
parameters: []
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: array type: array
items: items:
type: string type: string
400: "400":
description: "Invalid ID supplied" description: Invalid ID supplied
404: "404":
description: "ToscaTemplate not found" description: ToscaTemplate not found
405: "405":
description: "Invalid input" description: Invalid input
security: security:
- auth: - auth:
- "write:ToscaTemplate" - write:ToscaTemplate
- "read:ToscaTemplate" - read:ToscaTemplate
/user: /user:
post: post:
summary: "Create user" summary: Create user
description: "This can only be done by admin." description: This can only be done by admin.
operationId: "createUser" operationId: createUser
produces: produces:
- "application/json" - application/json
parameters: parameters:
- in: "body" - in: body
name: "body" name: body
description: "Created user object" description: Created user object
required: true required: true
schema: schema:
$ref: "#/definitions/User" $ref: '#/definitions/User'
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
type: "string" type: string
409: "409":
description: "already exists" description: already exists
security: security:
- auth: - auth:
- "admin:User" - admin:User
/user/login: /user/login:
get: get:
tags: tags:
- "user" - user
summary: "Logs user into the system" summary: Logs user into the system
description: "" description: ""
produces: produces:
- "application/json" - application/json
parameters: parameters:
- name: "username" - name: username
in: "query" in: query
description: "The user name for login" description: The user name for login
required: true required: true
type: "string" type: string
- name: "password" - name: password
in: "query" in: query
description: "The password for login in clear text" description: The password for login in clear text
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema:
type: "string"
headers: headers:
X-Rate-Limit: X-Rate-Limit:
type: "integer" type: integer
format: "int32" format: int32
description: "calls per hour allowed by the user" description: calls per hour allowed by the user
X-Expires-After: X-Expires-After:
type: "string" type: string
format: "date-time" format: date-time
description: "date in UTC when token expires" description: date in UTC when token expires
400: schema:
description: "Invalid username/password supplied" type: string
"400":
description: Invalid username/password supplied
/user/logout: /user/logout:
get: get:
summary: "Logs out current logged in user session" summary: Logs out current logged in user session
description: "" description: ""
produces: produces:
- "application/json" - application/json
parameters: [] parameters: []
responses: responses:
default: default:
description: "successful operation" description: successful operation
/user/{username}: /user/{username}:
get: get:
summary: "Get user by user name" summary: Get user by user name
description: "" description: ""
produces: produces:
- "application/json" - application/json
parameters: parameters:
- name: "username" - name: username
in: "path" in: path
description: "The name that needs to be fetched. Use user1 for testing. " description: 'The name that needs to be fetched. Use user1 for testing. '
required: true required: true
type: "string" type: string
responses: responses:
200: "200":
description: "successful operation" description: successful operation
schema: schema:
$ref: "#/definitions/User" $ref: '#/definitions/User'
400: "400":
description: "Invalid username supplied" description: Invalid username supplied
404: "404":
description: "User not found" description: User not found
security: security:
- auth: - auth:
- "admin:User" - admin:User
put: put:
tags: tags:
- "user" - user
summary: "Updated user" summary: Updated user
description: "This can only be done by the logged in user." description: This can only be done by the logged in user.
produces: produces:
- "application/json" - application/json
parameters: parameters:
- name: "username" - name: username
in: "path" in: path
description: "name that need to be updated" description: name that need to be updated
required: true required: true
type: "string" type: string
- in: "body" - in: body
name: "body" name: body
description: "Updated user object" description: Updated user object
required: true required: true
schema: schema:
$ref: "#/definitions/User" $ref: '#/definitions/User'
responses: responses:
400: "400":
description: "Invalid user supplied" description: Invalid user supplied
404: "404":
description: "User not found" description: User not found
security: security:
- auth: - auth:
- "admin:User" - admin:User
delete: delete:
summary: "Delete user" summary: Delete user
description: "This can only be done by the logged in user." description: This can only be done by the logged in user.
produces: produces:
- "application/json" - application/json
parameters: parameters:
- name: "username" - name: username
in: "path" in: path
description: "The name that needs to be deleted" description: The name that needs to be deleted
required: true required: true
type: "string" type: string
responses: responses:
400: "400":
description: "Invalid username supplied" description: Invalid username supplied
404: "404":
description: "User not found" description: User not found
security: security:
- auth: - auth:
- "admin:User" - admin:User
securityDefinitions: securityDefinitions:
auth: auth:
type: "oauth2" type: oauth2
authorizationUrl: "http://localhost/oauth/dialog" authorizationUrl: http://localhost/oauth/dialog
flow: "implicit" flow: implicit
scopes: scopes:
write:ToscaTemplate: "modify topolog template in your account" write:ToscaTemplate: modify topolog template in your account
read:ToscaTemplate: "read your topolog template" read:ToscaTemplate: read your topolog template
admin:User: "Grants access to admin operations" admin:User: Grants access to admin operations
write:Credentials: "modify cloud credentials in your account" write:Credentials: modify cloud credentials in your account
read:Credentials: "read your cloud credentials" read:Credentials: read your cloud credentials
definitions: definitions:
User: User:
$ref: "https://raw.githubusercontent.com/skoulouzis/CONF/DRIP_3.0/openAPI/User.yml#/User" type: object
Credentials: Credentials:
$ref: "https://raw.githubusercontent.com/skoulouzis/CONF/DRIP_3.0/openAPI/TOSCA/Credentials.yml#/Credentials" type: object
properties:
protocol:
type: string
token_type:
type: string
token:
type: string
keys:
type: object
additionalProperties:
type: string
user:
type: string
cloud_provider_name:
type: string
NodeTemplate: NodeTemplate:
$ref: "https://raw.githubusercontent.com/skoulouzis/CONF/DRIP_3.0/openAPI/TOSCA/NodeTemplate.yml#/NodeTemplate" type: object
properties:
derived_from:
type: string
properties:
type: object
additionalProperties:
type: object
properties: {}
requirements:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
interfaces:
type: object
additionalProperties:
type: object
properties: {}
capabilities:
type: object
additionalProperties:
type: object
properties: {}
type:
type: string
description:
type: string
directives:
type: array
items:
type: string
attributes:
type: object
additionalProperties:
type: object
properties: {}
artifacts:
type: object
additionalProperties:
type: object
properties: {}
TopologyTemplate: TopologyTemplate:
$ref: "https://raw.githubusercontent.com/skoulouzis/CONF/DRIP_3.0/openAPI/TOSCA/TopologyTemplate.yml#/TopologyTemplate" type: object
properties:
description:
type: string
inputs:
type: object
additionalProperties:
type: string
node_templates:
type: object
additionalProperties:
$ref: '#/definitions/NodeTemplate_2'
relationship_templates:
type: object
additionalProperties:
type: object
properties: {}
outputs:
type: object
additionalProperties:
type: object
properties: {}
groups:
type: object
additionalProperties:
type: object
properties: {}
substitution_mappings:
type: object
additionalProperties:
type: object
properties: {}
policies:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
ToscaTemplate: ToscaTemplate:
$ref: "https://raw.githubusercontent.com/skoulouzis/CONF/DRIP_3.0/openAPI/TOSCA/ToscaTemplate.yml#/ToscaTemplate" type: object
properties:
tosca_definitions_version:
type: string
tosca_default_namespace:
type: string
template_name:
type: string
topology_template:
$ref: '#/definitions/TopologyTemplate_2'
template_author:
type: string
template_version:
type: string
description:
type: string
imports:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
dsl_definitions:
type: object
additionalProperties:
type: object
properties: {}
node_types:
type: object
additionalProperties:
type: object
properties: {}
relationship_types:
type: object
additionalProperties:
type: object
properties: {}
relationship_templates:
type: object
additionalProperties:
type: object
properties: {}
capability_types:
type: object
additionalProperties:
type: object
properties: {}
artifact_types:
type: object
additionalProperties:
type: object
properties: {}
data_types:
type: object
additionalProperties:
type: object
properties: {}
interface_types:
type: object
additionalProperties:
type: object
properties: {}
policy_types:
type: object
additionalProperties:
type: object
properties: {}
group_types:
type: object
additionalProperties:
type: object
properties: {}
repositories:
type: object
additionalProperties:
type: object
properties: {}
Provisioner:
type: object
NodeTemplate_2:
type: object
properties:
derived_from:
type: string
properties:
type: object
additionalProperties:
type: object
properties: {}
requirements:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
interfaces:
type: object
additionalProperties:
type: object
properties: {}
capabilities:
type: object
additionalProperties:
type: object
properties: {}
type:
type: string
description:
type: string
directives:
type: array
items:
type: string
attributes:
type: object
additionalProperties:
type: object
properties: {}
artifacts:
type: object
additionalProperties:
type: object
properties: {}
TopologyTemplate_2:
type: object
properties:
description:
type: string
inputs:
type: object
additionalProperties:
type: string
node_templates:
type: object
additionalProperties:
$ref: '#/definitions/NodeTemplate_2'
relationship_templates:
type: object
additionalProperties:
type: object
properties: {}
outputs:
type: object
additionalProperties:
type: object
properties: {}
groups:
type: object
additionalProperties:
type: object
properties: {}
substitution_mappings:
type: object
additionalProperties:
type: object
properties: {}
policies:
type: array
items:
type: object
additionalProperties:
type: object
properties: {}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment