DUE-VDM/specs.yaml at master · DITAS-Project/DUE-VDM · GitHub

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
swagger: '2.0'
info:
  description: This is the API exposed by DUE-VDM
  version: 1.0.0
  title: DUE-VDM API
  # put the contact info for your development or API team
  contact:
    email: mirco.manzoni@mail.polimi.it

  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html

# tags are used for organizing operations
tags:
- name: debug
  description: Check the status of the component

paths:
  /debug/:
    get:
      tags:
      - debug
      summary: Debug hello world
      produces:
      - application/json
      responses:
        404:
          description: Not Found
        200:
          description: search results matching criteria
          schema:
            type: object
            properties:
              msg:
                type: string
        400:
          description: bad input parameter
  /debug/vdcs:
    get:
      tags:
      - debug
      summary: Get all the VDCs the DUE-VDM monitor
      produces:
      - application/json
      responses:
        404:
          description: Not Found
        200:
          description: search results matching criteria
          schema:
            type: array
            items:
               type: string
        400:
          description: bad input parameter
  /debug/{vdc}/methods:
    get:
      tags:
      - debug
      summary: Get all the methods monitored related to
               the given {vdc}
      produces:
      - application/json
      parameters:
      - in: path
        name: vdc
        required: true
        type: string
      responses:
        404:
          description: Not Found
        200:
          description: search results matching criteria
          schema:
            type: array
            items:
               type: string
        400:
          description: bad input parameter

# Host and schemes dynamically retrieved if not set
# host: virtserver.swaggerhub.com
# schemes:
#  - https
#basePath: /rest