Skip to content

Commit e8b91ff

Browse files
committed
Revert term/semester
1 parent 4453e9a commit e8b91ff

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

source/index.html.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -170,18 +170,18 @@ curl --request GET \
170170
"data": {
171171
"unarchived_courses": [
172172
{
173-
"term": "f19",
173+
"semester": "f19",
174174
"title": "blank",
175175
"display_name": "",
176-
"display_term": "Fall 2019"
176+
"display_semester": "Fall 2019"
177177
}
178178
],
179179
"archived_courses": [
180180
{
181-
"term": "f19",
181+
"semester": "f19",
182182
"title": "sample",
183183
"display_name": "",
184-
"display_term": "Fall 2019"
184+
"display_semester": "Fall 2019"
185185
}
186186
]
187187
}
@@ -199,10 +199,10 @@ Get all the courses the user is taking or have taken.
199199
```shell
200200
curl --request POST \
201201
--url <base_url>/api/courses \
202-
--form course_term=f19 \
202+
--form course_semester=f19 \
203203
--form course_title=api \
204204
--form head_instructor=instructor \
205-
--form base_course_term=f19 \
205+
--form base_course_semester=f19 \
206206
--form base_course_title=sample \
207207
--header 'Authorization: my_token'
208208
```
@@ -219,10 +219,10 @@ Note that the endpoint builds a course based on a prior course offering (called
219219

220220
Parameter | Description
221221
--------- | -----------
222-
course_term | term of the new course
222+
course_semester | semester of the new course
223223
course_title | Title (or code) of the new course
224224
head_instructor | Head instructor of the new course
225-
base_course_term | term of the base course
225+
base_course_semester | semester of the base course
226226
base_course_title | Title (or code) of the base course
227227

228228
# Courses.Users
@@ -231,7 +231,7 @@ base_course_title | Title (or code) of the base course
231231

232232
```shell
233233
curl --request GET \
234-
--url <base_url>/api/<term>/<course>/users \
234+
--url <base_url>/api/<semester>/<course>/users \
235235
--header 'Authorization: my_token'
236236
```
237237

@@ -267,13 +267,13 @@ This end point gets all users in a course.
267267

268268
### HTTP Request
269269

270-
`GET /api/<term>/<course>/users`
270+
`GET /api/<semester>/<course>/users`
271271

272272
## Get Graders
273273

274274
```shell
275275
curl --request GET \
276-
--url <base_url>/api/<term>/<course>/graders \
276+
--url <base_url>/api/<semester>/<course>/graders \
277277
--header 'Authorization: my_token'
278278
```
279279

@@ -307,31 +307,31 @@ curl --request GET \
307307

308308
### HTTP Request
309309

310-
`GET /api/<term>/<course>/graders`
310+
`GET /api/<semester>/<course>/graders`
311311

312312
# Courses.Reports
313313

314314
## Generate Grade Summaries
315315

316316
```shell
317317
curl --request POST \
318-
--url <base_url>/api/<term>/<course>/reports/summaries \
318+
--url <base_url>/api/<semester>/<course>/reports/summaries \
319319
--header 'Authorization: my_token'
320320
```
321321

322322
This endpoint helps system administrators set up cron jobs for automatic grade summary generation.
323323

324324
### HTTP Request
325325

326-
`POST /api/<term>/<course>/reports/summaries`
326+
`POST /api/<semester>/<course>/reports/summaries`
327327

328328

329329
# Gradeables
330330
## Get gradeable values
331331

332332
```shell
333333
curl -X GET \
334-
<base_url>/api/<term>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>
334+
<base_url>/api/<semester>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>
335335

336336
```
337337
> Possible response examples:
@@ -359,11 +359,11 @@ curl -X GET \
359359
}
360360
```
361361

362-
The endpoint returns values associated with an autograded gradeable with the given gradeable_id, which allows for determining a score on an assignment, if it has been graded, etc.
362+
The endpoint returns values associated with an autograded gradeable with the given gradeable_id, which allows for desemesterining a score on an assignment, if it has been graded, etc.
363363

364364
### HTTP Request
365365

366-
`GET /api/<term>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>`
366+
`GET /api/<semester>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>`
367367

368368
### Parameters
369369

@@ -375,7 +375,7 @@ user_id | User's unique ID
375375

376376
```shell
377377
curl -X POST \
378-
<base_url>/api/<term>/<course>/gradeable/<gradeable_id>/upload\
378+
<base_url>/api/<semester>/<course>/gradeable/<gradeable_id>/upload\
379379
-F user_id=student \
380380
-F vcs_checkout=true \
381381
-F git_repo_id=true
@@ -406,7 +406,7 @@ The endpoint requests for a VCS gradeable with the given gradeable_id to be subm
406406

407407
### HTTP Request
408408

409-
`POST /api/<term>/<course>/gradeable/<gradeable_id>/upload`
409+
`POST /api/<semester>/<course>/gradeable/<gradeable_id>/grade`
410410

411411
### Parameters
412412

0 commit comments

Comments
 (0)