...
3.3.1: Monitoring REST API
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
openapi: 3.0.3
info:
title: Swagger Control Loop Monitoring
description: ""
version: 1.0.0
servers:
- url: '{scheme}://onap/controlloop/v2/'
variables:
scheme:
description: 'The Data Set API is accessible via https and http'
enum:
- 'https'
- 'http'
default: 'http'
tags:
- name: monitoring
description: Control Loop Monitoring
paths:
/runtime-catalogue/monitoring:
post:
tags:
- monitoring
summary: Input monitoring data into the database
requestBody:
description: Monitoring data to be input
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
required: true
responses:
200:
description: OK
405:
description: Invalid input
get:
tags:
- monitoring
summary: Get monitoring data for all participants
responses:
200:
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonitoringData'
404:
description: No monitoring data found
/runtime-catalogue/monitoring/{participant-id}:
get:
tags:
- monitoring
summary: Get monitoring data for a participant by participant id
parameters:
- name: participant-id
in: path
description: ID of a participant
required: true
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
404:
description: Monitoring data for the participant not found
put:
tags:
- monitoring
summary: Update monitoring data for a participant by participant id
parameters:
- name: participant-id
in: path
description: ID of a participant
required: true
schema:
type: string
requestBody:
description: Monitoring data to be updated
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringData'
404:
description: Monitoring data for the participant not found
delete:
tags:
- monitoring
summary: Delete monitoring data for a participant by participant id
parameters:
- name: participant-id
in: path
description: ID of a participant
required: true
schema:
type: string
responses:
200:
description: OK
404:
description: Monitoring data for the participant not found
components:
schemas:
MonitoringData:
properties:
participant-id:
type: string
control-loops:
type: array
items:
properties:
cl-instance-id:
type: string
status:
type: string
enum:
- INSTANTIATION_STARTED
- INSTANTIATED_RUNNING
- INSTANTIATED_FAILED
other-data:
type: string |
3.3.2: Monitoring Sequence Diagrams
...