Skip to content

Commit ad6e5b9

Browse files
Merge branch 'release/v0.4.0'
2 parents cc8373b + db19507 commit ad6e5b9

File tree

1 file changed

+49
-50
lines changed

1 file changed

+49
-50
lines changed

swagger.yaml

Lines changed: 49 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
openapi: 3.0.2
33
info:
44
title: Hero for Developers
5-
version: 0.3.1
5+
version: 0.4.0
66
x-logo:
77
url: "./hero-logo.png"
88
backgroundColor: "#FAFAFA"
@@ -908,7 +908,6 @@ paths:
908908
summary: Create Date
909909
description: Creates a date resource.
910910
security:
911-
912911
- staging:
913912
- urn:hero:dates:dates
914913
- production:
@@ -4078,13 +4077,13 @@ components:
40784077
counts:
40794078
type: object
40804079
additionalProperties:
4081-
type: integer
4080+
type: string
40824081
format: int64
40834082
description: |-
40844083
counts is the meat of the analysis, providing a map of attendance
40854084
codes to their number of occurrences.
40864085
total:
4087-
type: integer
4086+
type: string
40884087
format: int64
40894088
description: |-
40904089
total is the total number of attendance records for this Student
@@ -4102,7 +4101,7 @@ components:
41024101
format: uuid
41034102
description: id is the audit record's unique identifier.
41044103
createTime:
4105-
type: integer
4104+
type: string
41064105
format: int64
41074106
description: |
41084107
createTime is when the resource was created in seconds from the
@@ -4266,39 +4265,39 @@ components:
42664265
Student's attendance summary for a given school term.
42674266
properties:
42684267
year:
4269-
type: integer
4268+
type: string
42704269
format: int64
42714270
description: year is the calendar year for which this summary applies.
42724271
term:
4273-
type: integer
4272+
type: string
42744273
format: int64
42754274
description: term is the term number for which this summary applies.
42764275
total:
4277-
type: integer
4276+
type: string
42784277
format: int64
42794278
description: |-
42804279
total is the total number of attendance records for this student
42814280
within the specified term.
42824281
present:
4283-
type: integer
4282+
type: string
42844283
format: int64
42854284
description: |-
42864285
present is the number of records with a Present code for this
42874286
student within the specified term.
42884287
late:
4289-
type: integer
4288+
type: string
42904289
format: int64
42914290
description: |-
42924291
late is the number of records with a Late code for this student
42934292
within the specified term.
42944293
justified:
4295-
type: integer
4294+
type: string
42964295
format: int64
42974296
description: |-
42984297
justified is the number of records with a Justified Absence code
42994298
for this student within the specified term.
43004299
unjustified:
4301-
type: integer
4300+
type: string
43024301
format: int64
43034302
description: |-
43044303
unjustified is the number of records with an Unjustified Absence
@@ -4412,13 +4411,13 @@ components:
44124411
description: |
44134412
campusId is the school campus the attendance record is assigned to.
44144413
createTime:
4415-
type: integer
4414+
type: string
44164415
format: int64
44174416
description: |
44184417
createTime is when the resource was created in seconds from the
44194418
epoch.
44204419
updateTime:
4421-
type: integer
4420+
type: string
44224421
format: int64
44234422
description: |-
44244423
updateTime is the last time the resource was modified in seconds
@@ -4440,13 +4439,13 @@ components:
44404439
date contains the date the attendance was recorded against as a
44414440
string to facilitate filtering.
44424441
present:
4443-
type: integer
4442+
type: string
44444443
format: int64
44454444
description: |-
44464445
present provides a count of "half-days attended", per the MoE
44474446
half-day calculation.
44484447
unjustifiablyAbsent:
4449-
type: integer
4448+
type: string
44504449
format: int64
44514450
description: |-
44524451
unjustifiablyAbsent provides a count of half-day unjustifiable
@@ -4463,13 +4462,13 @@ components:
44634462
format: uuid
44644463
description: id is the attendance record's unique identifier.
44654464
createTime:
4466-
type: integer
4465+
type: string
44674466
format: int64
44684467
description: |
44694468
createTime is when the resource was created in seconds from the
44704469
epoch.
44714470
updateTime:
4472-
type: integer
4471+
type: string
44734472
format: int64
44744473
description: |-
44754474
updateTime is the last time the resource was modified in seconds
@@ -4570,13 +4569,13 @@ components:
45704569
format: uuid
45714570
description: id is the attendance register's unique identifier.
45724571
createTime:
4573-
type: integer
4572+
type: string
45744573
format: int64
45754574
description: |
45764575
createTime is when the resource was created in seconds from the
45774576
epoch.
45784577
updateTime:
4579-
type: integer
4578+
type: string
45804579
format: int64
45814580
description: |-
45824581
updateTime is the last time the resource was modified in seconds
@@ -4710,13 +4709,13 @@ components:
47104709
format: uuid
47114710
description: id is the unique identifier of the school's date record.
47124711
createTime:
4713-
type: integer
4712+
type: string
47144713
format: int64
47154714
description: |-
47164715
createTime is when the resource was created in seconds from the
47174716
epoch.
47184717
updateTime:
4719-
type: integer
4718+
type: string
47204719
format: int64
47214720
description: |-
47224721
updateTime is the last time the resource was modified in seconds
@@ -4860,13 +4859,13 @@ components:
48604859
description: |-
48614860
id is the Enrolment Application's unique identifier.
48624861
createTime:
4863-
type: integer
4862+
type: string
48644863
format: int64
48654864
description: |-
48664865
createTime is when the resource was created in seconds from the
48674866
epoch.
48684867
updateTime:
4869-
type: integer
4868+
type: string
48704869
format: int64
48714870
description: |-
48724871
updateTime is the last time the resource was modified in seconds
@@ -5109,12 +5108,12 @@ components:
51095108
format: uuid
51105109
description: id is the unique identifier of the school's enrolment schema
51115110
createTime:
5112-
type: integer
5111+
type: string
51135112
format: int64
51145113
description: createTime is when the resource was created in seconds from the
51155114
epoch.
51165115
updateTime:
5117-
type: integer
5116+
type: string
51185117
format: int64
51195118
description: |-
51205119
updateTime is the last time the resource was modified in seconds from
@@ -5380,13 +5379,13 @@ components:
53805379
description: |-
53815380
id is the unique group identifier.
53825381
createTime:
5383-
type: integer
5382+
type: string
53845383
format: int64
53855384
description: |
53865385
createTime is when the resource was created in seconds from the
53875386
epoch.
53885387
updateTime:
5389-
type: integer
5388+
type: string
53905389
format: int64
53915390
description: |-
53925391
updateTime is the last time the resource was modified in seconds from
@@ -5640,13 +5639,13 @@ components:
56405639
format: uuid
56415640
description: id is the Access Request's unique identifier.
56425641
createTime:
5643-
type: integer
5642+
type: string
56445643
format: int64
56455644
description: |-
56465645
createTime is when the resource was created in seconds from the
56475646
epoch.
56485647
processedTime:
5649-
type: integer
5648+
type: string
56505649
format: int64
56515650
description: |-
56525651
processedTime is the last time the request was actioned by the caregiver
@@ -5707,7 +5706,7 @@ components:
57075706
description: |-
57085707
id is the unique identifier of the school's Enrolment record.
57095708
createTime:
5710-
type: integer
5709+
type: string
57115710
format: int64
57125711
description: |-
57135712
createTime is when the resource was created in seconds from the
@@ -5864,7 +5863,7 @@ components:
58645863
type:
58655864
"$ref": "#/components/schemas/peopleContactType"
58665865
priority:
5867-
type: integer
5866+
type: string
58685867
format: int64
58695868
description: |-
58705869
priority determines the order in which contacts are displayed.
@@ -5981,13 +5980,13 @@ components:
59815980
description: |-
59825981
id is the unique identifier of the school's Enrolment record.
59835982
createTime:
5984-
type: integer
5983+
type: string
59855984
format: int64
59865985
description: |-
59875986
createTime is when the resource was created in seconds from the
59885987
epoch.
59895988
updateTime:
5990-
type: integer
5989+
type: string
59915990
format: int64
59925991
description: |-
59935992
updateTime is the last time the resource was modified in seconds
@@ -6169,14 +6168,14 @@ components:
61696168
enrolmentId is the current or most recent educational facility the
61706169
Learner has been assigned.
61716170
siblingPosition:
6172-
type: integer
6171+
type: string
61736172
format: int64
61746173
description: |-
61756174
siblingPosition contains the position in the family this child holds
61766175
with respect to the current school they are enrolled in.
61776176
One-based index, you can't be the 0th position in a family.
61786177
siblingCount:
6179-
type: integer
6178+
type: string
61806179
format: int64
61816180
description: |-
61826181
siblingCount contains the number of known siblings the learner has
@@ -6361,13 +6360,13 @@ components:
63616360
format: uuid
63626361
description: id is the Person's unique identifier.
63636362
createTime:
6364-
type: integer
6363+
type: string
63656364
format: int64
63666365
description: |-
63676366
createTime is when the resource was created in seconds from the
63686367
epoch.
63696368
updateTime:
6370-
type: integer
6369+
type: string
63716370
format: int64
63726371
description: |-
63736372
updateTime is the last time the resource was modified in seconds
@@ -6398,7 +6397,7 @@ components:
63986397
jurisdictionalId is the unique learner identifier based on the
63996398
educational jurisdiction.
64006399
heroId:
6401-
type: integer
6400+
type: string
64026401
format: uint64
64036402
description: |-
64046403
heroId is the unique identifier across the system for systems that
@@ -7249,13 +7248,13 @@ components:
72497248
description: |-
72507249
id is the unique identifier linked to an option.
72517250
createTime:
7252-
type: integer
7251+
type: string
72537252
format: int64
72547253
description: |-
72557254
createTime is when the resource was created in seconds from the
72567255
epoch.
72577256
updateTime:
7258-
type: integer
7257+
type: string
72597258
format: int64
72607259
description: |-
72617260
updateTime is the last time the resource was modified in seconds
@@ -7337,12 +7336,12 @@ components:
73377336
format: uuid
73387337
description: id is the unique identifier linked to an option
73397338
createTime:
7340-
type: integer
7339+
type: string
73417340
format: int64
73427341
description: createTime is when the resource was created in seconds from the
73437342
epoch.
73447343
updateTime:
7345-
type: integer
7344+
type: string
73467345
format: int64
73477346
description: |-
73487347
updateTime is the last time the resource was modified in seconds from
@@ -7392,12 +7391,12 @@ components:
73927391
format: uuid
73937392
description: id is the unique identifier linked to an option heading
73947393
createTime:
7395-
type: integer
7394+
type: string
73967395
format: int64
73977396
description: createTime is when the resource was created in seconds from the
73987397
epoch.
73997398
updateTime:
7400-
type: integer
7399+
type: string
74017400
format: int64
74027401
description: |-
74037402
updateTime is the last time the resource was modified in seconds from
@@ -7493,12 +7492,12 @@ components:
74937492
format: uuid
74947493
description: id is the School's unique identifier.
74957494
createTime:
7496-
type: integer
7495+
type: string
74977496
format: int64
74987497
description: createTime is when the resource was created in seconds from the
74997498
epoch.
75007499
updateTime:
7501-
type: integer
7500+
type: string
75027501
format: int64
75037502
description: |-
75047503
updateTime is the last time the resource was modified in seconds from
@@ -7719,7 +7718,7 @@ components:
77197718
description: |-
77207719
id is the unique identifier of the school's timetabled period.
77217720
createTime:
7722-
type: integer
7721+
type: string
77237722
format: int64
77247723
description: |-
77257724
createTime is when the resource was created in seconds from the
@@ -7789,13 +7788,13 @@ components:
77897788
id is the unique identifier of the school's timetable structure
77907789
record.
77917790
createTime:
7792-
type: integer
7791+
type: string
77937792
format: int64
77947793
description: |-
77957794
createTime is when the resource was created in seconds from the
77967795
epoch.
77977796
updateTime:
7798-
type: integer
7797+
type: string
77997798
format: int64
78007799
description: |-
78017800
updateTime is the last time the resource was modified in seconds

0 commit comments

Comments
 (0)