-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
168 lines (167 loc) · 4.94 KB
/
openapi.yaml
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
openapi: 3.0.0
info:
title: KdB2 REST API
version: 0.1.0
paths:
/api/v0/search:
get:
summary: Search university syllabus
parameters:
- in: query
name: q
schema:
type: string
required: true
description: Search query
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResult'
'400':
description: url parameter 'q' undefined.
'404':
description: ''
'500':
description: Internal Server Error
/api/v0/syllabus/{courseID}:
get:
summary: Get syllabus for a specific course
parameters:
- in: path
name: courseID
schema:
type: string
required: true
description: Course ID for the syllabus
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Subject'
'400':
description: parameter courseID undefined
'404':
description: this courseID's subject is not found
servers:
- url: https://kdb2.tsukuba.one/
variables: {}
components:
schemas:
SubjectRef:
required:
- courseID
- title
type: object
properties:
courseID:
type: string
example: GA18132
title:
type: string
example: プログラミング入門
Subject:
type: object
required:
- id
- courseID
- title
- credit
- grade
- timeTable
- books
- className
- planPretopics
- keywords
- seeAlsoSubject
- summary
properties:
id:
type: string
example: "01H8PTK19XT78CRYFN9V2MHTX3"
description: "KdB2側が登録される項目1つに振るユニークな文字列"
courseID:
type: string
example: "EE21241"
description: "科目に振られるユニークな文字列"
title:
type: string
example: "地誌学"
description: "科目名"
credit:
type: number
example: 1
description: "この科目を受講することで修得できる単位数"
grade:
type: number
example: 2
description: "最低履修年次"
timeTable:
type: string
example: "春AB 木1"
description: "開講される学期、モジュール、曜日、時間帯"
books:
type: array
nullable: true
items:
type: string
example:
- "1. 中村和郎ほか 「地域と景観」古今書院"
- "2. 山下亜紀郎 「水環境問題の地域的諸相」古今書院"
description: "参考書籍"
className:
type: array
nullable: true
items:
type: string
example:
- "イントロダクション(授業概要と研究紹介)"
- "地誌学とは何か(地誌学と系統地理学)"
- "地域とは何か(地域概念の整理)"
- "地域的観点と地域モデルの原型"
- "都市の地域モデル1:市街地モデル"
- "都市の地域モデル2:都市圏モデル,都市群モデル"
- "農村の地域モデル"
- "地域モデルの作成方法"
- "都市の水環境問題の研究事例1:日本の事例"
- "都市の水環境問題の研究事例1:海外の事例"
description: "講義各回のテーマ、タイトル"
planPretopics:
type: string
example: '対面で実施する。詳細はmanabaで案内する。'
keywords:
type: array
nullable: true
items:
type: string
example:
- "地域"
- "地域構造"
- "地域モデル"
- "都市"
- "水環境問題"
seeAlsoSubject:
type: array
items:
$ref: '#/components/schemas/SubjectRef'
nullable: true
description: "関連科目"
summary:
type: string
example: "まず、地誌学的研究の基礎である各種の地域概念や地域モデルについて説明し、次に、具体的な研究事例として、おもに日本も含めたアジアの都市発展と環境問題について紹介する。"
description: "概要"
SearchResult:
type: array
items:
allOf:
- $ref: "#/components/schemas/Subject"
- type: object
required:
- score
properties:
score:
type: number