blob: 8cb0e23bd5ad93368ecfd61c28379d29307c595f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
##############################################################################
# Copyright (c) 2017 akhil.batra@research.iiit.ac.in and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
swagger: '2.0'
info:
title: QTIP-API
version: "1.0"
consumes:
- application/json
produces:
- application/json
paths:
/qpis:
get:
summary: List all QPIs
operationId: qtip.api.controllers.qpi.list_qpis
tags:
- QPI
- Standalone
- Agent
responses:
200:
description: A list of QPIs
schema:
items:
$ref: '#/definitions/QPIs'
501:
description: Resource not implemented
schema:
$ref: '#/definitions/Error'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/qpis/{name}:
get:
summary: Get a QPI
operationId: qtip.api.controllers.qpi.get_qpi
tags:
- QPI
- Standalone
- Agent
parameters:
- name: name
in: path
description: QPI name
required: true
type: string
responses:
200:
description: QPI information
schema:
$ref: '#/definitions/QPI'
404:
description: QPI not found
schema:
$ref: '#/definitions/Error'
501:
description: Resource not implemented
schema:
$ref: '#/definitions/Error'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
definitions:
QPI:
type: object
required:
- name
properties:
name:
type: string
description:
type: string
formula:
type: string
sections:
type: array
items:
type: object
QPIs:
type: object
required:
- qpis
properties:
qpis:
type: array
items:
type: string
Error:
type: object
properties:
status:
type: integer
format: int32
title:
type: string
detail:
type: string
type:
type: string
|
