Skip to content

Commit f721046

Browse files
Merge pull request #48 from Clever/SYNC-2075-more-edits
SYNC-2075 More edits
2 parents 2be605a + 5e70a87 commit f721046

4 files changed

Lines changed: 114 additions & 278 deletions

File tree

full-v3.yml

Lines changed: 26 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ paths:
321321
/resources/{id}/users:
322322
get:
323323
tags: ["Resources"]
324-
description: Returns the contact, staff, student and/or teacher users for a resource
324+
description: Returns the student and/or teacher users for a resource
325325
operationId: getUsersForResource
326326
parameters:
327327
- in: path
@@ -331,8 +331,6 @@ paths:
331331
- in: query
332332
name: role
333333
enum:
334-
- "contact"
335-
- "staff"
336334
- "student"
337335
- "teacher"
338336
- in: query
@@ -923,7 +921,7 @@ paths:
923921
/users/{id}/mystudents:
924922
get:
925923
tags: ["Users"]
926-
description: Returns the student users for a teacher user
924+
description: Returns the student users for a teacher or contact user
927925
operationId: getStudentsForUser
928926
parameters:
929927
- in: path
@@ -1270,16 +1268,6 @@ definitions:
12701268
data:
12711269
$ref: "#/definitions/User"
12721270

1273-
AdminName:
1274-
type: object
1275-
properties:
1276-
first:
1277-
type: string
1278-
x-nullable: true
1279-
last:
1280-
type: string
1281-
x-nullable: true
1282-
12831271
Course:
12841272
type: object
12851273
properties:
@@ -1359,8 +1347,7 @@ definitions:
13591347
items:
13601348
type: string
13611349
district_contact:
1362-
$ref: "#/definitions/DistrictAdmin"
1363-
x-nullable: true
1350+
type: string
13641351
x-validation: true
13651352

13661353
Location:
@@ -1701,7 +1688,7 @@ definitions:
17011688
Contact:
17021689
type: object
17031690
properties:
1704-
id:
1691+
legacy_id:
17051692
type: string
17061693
x-validation: true
17071694
phone:
@@ -1717,18 +1704,6 @@ definitions:
17171704
- Work
17181705
- Other
17191706
- ""
1720-
relationship:
1721-
type: string
1722-
x-nullable: true
1723-
x-validation: true
1724-
enum:
1725-
- "Parent"
1726-
- "Grandparent"
1727-
- "Self"
1728-
- "Aunt/Uncle"
1729-
- "Sibling"
1730-
- "Other"
1731-
- ""
17321707
sis_id:
17331708
type: string
17341709
x-nullable: true
@@ -1737,28 +1712,11 @@ definitions:
17371712
x-validation: true
17381713
items:
17391714
$ref: "#/definitions/StudentRelationship"
1740-
students:
1741-
type: array
1742-
x-validation: true
1743-
items:
1744-
type: string
1745-
type:
1746-
type: string
1747-
x-nullable: true
1748-
x-validation: true
1749-
enum:
1750-
- "Parent/Guardian"
1751-
- "Emergency"
1752-
- "Primary"
1753-
- "Secondary"
1754-
- "Family"
1755-
- "Other"
1756-
- ""
17571715

17581716
DistrictAdmin:
17591717
type: object
17601718
properties:
1761-
id:
1719+
legacy_id:
17621720
type: string
17631721
x-validation: true
17641722
title:
@@ -1768,7 +1726,7 @@ definitions:
17681726
Staff:
17691727
type: object
17701728
properties:
1771-
id:
1729+
legacy_id:
17721730
type: string
17731731
x-validation: true
17741732
credentials:
@@ -1797,7 +1755,7 @@ definitions:
17971755
Student:
17981756
type: object
17991757
properties:
1800-
id:
1758+
legacy_id:
18011759
type: string
18021760
x-validation: true
18031761
created:
@@ -1976,7 +1934,7 @@ definitions:
19761934
Teacher:
19771935
type: object
19781936
properties:
1979-
id:
1937+
legacy_id:
19801938
type: string
19811939
x-validation: true
19821940
created:
@@ -1989,9 +1947,6 @@ definitions:
19891947
district:
19901948
type: string
19911949
x-validation: true
1992-
email:
1993-
type: string
1994-
x-nullable: true
19951950
last_modified:
19961951
type: string
19971952
format: datetime
@@ -2042,21 +1997,24 @@ definitions:
20421997
x-validation: true
20431998
name:
20441999
$ref: "#/definitions/Name"
2045-
contact:
2046-
$ref: "#/definitions/Contact"
2047-
x-nullable: true
2048-
district_admin:
2049-
$ref: "#/definitions/DistrictAdmin"
2050-
x-nullable: true
2051-
staff:
2052-
$ref: "#/definitions/Staff"
2053-
x-nullable: true
2054-
student:
2055-
$ref: "#/definitions/Student"
2056-
x-nullable: true
2057-
teacher:
2058-
$ref: "#/definitions/Teacher"
2059-
x-nullable: true
2000+
roles:
2001+
type: object
2002+
additionalProperties:
2003+
contact:
2004+
$ref: '#/definitions/Contact'
2005+
x-nullable: true
2006+
district_admin:
2007+
$ref: '#/definitions/DistrictAdmin'
2008+
x-nullable: true
2009+
staff:
2010+
$ref: '#/definitions/Staff'
2011+
x-nullable: true
2012+
student:
2013+
$ref: '#/definitions/Student'
2014+
x-nullable: true
2015+
teacher:
2016+
$ref: '#/definitions/Teacher'
2017+
x-nullable: true
20602018

20612019
CourseObject:
20622020
type: object

0 commit comments

Comments
 (0)