...
3.2.1: Instantiation REST API
Code Block | ||||
---|---|---|---|---|
| ||||
swagger: "2.0"
info:
description: ""
version: "1.0.0"
title: "Swagger Control Loop Instantiation"
host: "onap/controlloop"
basePath: "/v2"
tags:
- name: "instantiate"
description: "Control Loop Instantiation"
schemes:
- "https"
paths:
/runtime-catalogue/instantiate/runtime-loop:
post:
tags:
- "instantiate"
summary: "Instantiate a deployed control loop"
description: ""
operationId: "instantiateLoop"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Control loop that is to be instantiated"
required: true
schema:
$ref: "#/definitions/Runtime-Loop"
responses:
"200":
description: "Success"
"404":
description: "Control Loop not found"
"405":
description: "Invalid input"
security:
- api_key: []
securityDefinitions:
api_key:
type: "apiKey"
name: "api_key"
in: "header"
definitions:
Runtime-Loop:
type: "object"
required:
- "name"
properties:
id:
type: "integer"
example: "1"
loop:
type: "array"
items:
type: "object"
properties:
application-key:
type: "string"
configuration:
type: "object"
example:
- application-id: "org.onap.PM_Subscription_Handler"
configuration:
- enable-tls: true
pmsh_publish_topic_name: 'pm_subscription_hander.DCAE_OUTPUT'
xml:
name: "Runtime-Loop"
ApiResponse:
type: "object"
properties:
code:
type: "integer"
format: "int32"
type:
type: "string"
message:
type: "string" | ||||
PlantUML Macro | ||||
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
|
3.2.2: Instantiation Sequence Diagrams
...