kursstatistik-api/swagger.json at master · KTH/kursstatistik-api · 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
{
  "swagger": "2.0",
  "info": {
    "title": "Node API",
    "description": "Template API project for Node.js",
    "version": "1.0.0"
  },
  "basePath": "/api/kursstatistik",
  "produces": ["application/json"],
  "paths": {
    "/_checkAPIkey": {
      "get": {
        "operationId": "checkAPIkey",
        "summary": "GET a test endpoint that is protected by api key to validate that consumer has a proper api key",
        "description": "",
        "parameters": [],
        "tags": ["system"],
        "responses": {
          "200": {
            "description": "An empty response"
          },
          "default": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "security": [
          {
            "api_key": ["read"]
          }
        ]
      }
    },
    "/v1/courseRoundStaitics/{roundEndDate}": {
      "post": {
        "operationId": "requestRoundStatisticsByLadokId",
        "summary": "Requests round statistics by Ladok ID",
        "description": "",
        "parameters": [
          {
            "name": "roundEndDate",
            "in": "path",
            "description": "End date of the roun(s) to get the correct result, format yyyy-mm-dd",
            "required": true,
            "type": "string"
          },
          {
            "name": "Ladok roundId list",
            "in": "body",
            "description": "List of ladok round ids",
            "required": true,
            "type": "array",
            "items": { "type": "string" }
          }
        ],
        "tags": ["v1"],
        "responses": {
          "200": {
            "description": "The requested round statistics",
            "schema": {
              "$ref": "#/definitions/ReturnObject"
            }
          },
          "400": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "security": [
          {
            "api_key": ["write"]
          }
        ]
      }
    }
  },
  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "name": "api_key",
      "in": "header",
      "scopes": {
        "read": "Read access to data",
        "write": "Write access to data"
      }
    }
  },
  "definitions": {
    "ReturnObject": {
      "properties": {
        "registeredStudents": {
          "type": "string",
          "description": "Sum of first time registered students for round(s)"
        },
        "examinationGrade": {
          "type": "string",
          "description": "Percentage of registeredStudents and sutents that has finnish the course before course end date"
        }
      }
    },
    "Error": {
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        }
      }
    },
    "UserList": {
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "fields": {
          "type": "string"
        }
      }
    }
  }
}