kc-fullstack-dev-tech-task/swagger.yaml at main · gamalkh299/kc-fullstack-dev-tech-task · 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
swagger: "2.0"
info:
  description: "This is tech test task for Full stack developer"
  version: "1.0.0"
  title: "Course catalog"
host: api.cc.localhost
basePath: /
schemes: [http]
tags:
  - name: "categories"
    description: "Categories of courses"
  - name: "courses"
    description: "Courses"
paths:
  /categories:
    get:
      tags:
        - "categories"
      summary: "Get all categories"
      description: "Returns all categories"
      operationId: "getCategories"
      produces:
        - "application/json"
      responses:
        "200":
          description: "successful operation"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Category"
  /categories/{id}:
    get:
      tags:
        - "categories"
      summary: "Get category by id"
      description: "Returns a category by id"
      operationId: "getCategoryById"
      produces:
        - "application/json"
      parameters:
        - name: "id"
          in: "path"
          description: "ID of category to return"
          required: true
          type: "string"
          format: "guid"
      responses:
        "200":
          description: "successful operation"
          schema:
            $ref: "#/definitions/Category"
  /courses:
    get:
      tags:
        - "courses"
      summary: "Get all courses"
      description: "Returns all courses"
      operationId: "getCourses"
      produces:
        - "application/json"
      parameters:
        - name: "category_id"
          in: "query"
          description: "Filter by category id"
          required: false
          type: "string"
          format: "guid"
      responses:
        "200":
          description: "successful operation"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Course"
  /courses/{id}:
    get:
      tags:
        - "courses"
      summary: "Get course by id"
      description: "Returns a course by id"
      operationId: "getCourseById"
      produces:
        - "application/json"
      parameters:
        - name: "id"
          in: "path"
          description: "ID of course to return"
          required: true
          type: "string"
          format: "guid"
      responses:
        "200":
          description: "successful operation"
          schema:
            $ref: "#/definitions/Course"
definitions:
    Category:
        type: "object"
        properties:
          id:
              type: "string"
              format: "guid"
          name:
              type: "string"
          description:
              type: "string"
          parent_id:
              type:
                - "null"
                - "string"
              format: "guid"
              description: "Parent category id"
          count_of_courses:
              type: "integer"
              format: "int32"
              description: "Count of courses in category including subcategories"
          created_at:
              type: "string"
              format: "date-time"
          updated_at:
              type: "string"
              format: "date-time"
    Course:
        type: "object"
        properties:
          id:
              type: "string"
              format: "guid"
          name:
              type: "string"
          description:
              type: "string"
          preview:
              type: "string"
              description: "URL to preview image"
          main_category_name:
              type: "string"
              description: "Main category name"
          created_at:
              type: "string"
              format: "date-time"
          updated_at:
              type: "string"
              format: "date-time"