tsu/swagger.yml at main · jnGreg/tsu · 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
swagger: "2.0"
info:
  title: "My API"
  version: "1.0"
paths:
  /articles/{article_id}:
    get:
      summary: Get an article by ID
      parameters:
        - name: article_id
          in: path
          type: integer
          required: true
      responses:
        200:
          description: Success
        404:
          description: Article not found

    put:
      summary: Update an article by ID
      parameters:
        - name: article_id
          in: path
          type: integer
          required: true
      responses:
        200:
          description: Success
        404:
          description: Article not found

    delete:
      summary: Delete an article by ID
      parameters:
        - name: article_id
          in: path
          type: integer
          required: true
      responses:
        204:
          description: Success
        404:
          description: Article not found
  /summaries/{summary_id}:
    get:
      summary: Get a summary by ID
      parameters:
        - name: summary_id
          in: path
          type: integer
          required: true
      responses:
        200:
          description: Success
        404:
          description: Summary not found

    put:
      summary: Update a summary by ID
      parameters:
        - name: summary_id
          in: path
          type: integer
          required: true
      responses:
        200:
          description: Success
        404:
          description: Summary not found

    delete:
      summary: Delete a summary by ID
      parameters:
        - name: summary_id
          in: path
          type: integer
          required: true
      responses:
        204:
          description: Success
        404:
          description: Summary not found