Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 0 additions & 3 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ flat_api/docs/CollectionCreation.md
flat_api/docs/CollectionModification.md
flat_api/docs/CollectionPrivacy.md
flat_api/docs/CollectionType.md
flat_api/docs/CreateLtiConfiguration200Response.md
flat_api/docs/CreditTransaction.md
flat_api/docs/EduLibrary.md
flat_api/docs/EduResource.md
Expand Down Expand Up @@ -280,7 +279,6 @@ flat_api/models/collection_creation.py
flat_api/models/collection_modification.py
flat_api/models/collection_privacy.py
flat_api/models/collection_type.py
flat_api/models/create_lti_configuration200_response.py
flat_api/models/credit_transaction.py
flat_api/models/edu_library.py
flat_api/models/edu_resource.py
Expand Down Expand Up @@ -482,7 +480,6 @@ flat_api/test/test_collection_creation.py
flat_api/test/test_collection_modification.py
flat_api/test/test_collection_privacy.py
flat_api/test/test_collection_type.py
flat_api/test/test_create_lti_configuration200_response.py
flat_api/test/test_credit_transaction.py
flat_api/test/test_edu_library.py
flat_api/test/test_edu_resource.py
Expand Down
9 changes: 4 additions & 5 deletions OPERATIONS.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"schema_version": 1,
"spec_version": "2.26.0",
"spec_version": "2.26.2",
"generator": {
"name": "python",
"version": "7.24.0"
Expand Down Expand Up @@ -474,7 +474,7 @@
"operation_id": "getGroupScores",
"method": "get",
"path": "/groups/{group}/scores",
"symbol": "score_api.get_group_scores",
"symbol": "group_api.get_group_scores",
"paginated": false,
"documented": true
},
Expand Down Expand Up @@ -634,15 +634,15 @@
"operation_id": "getUserLikes",
"method": "get",
"path": "/users/{user}/likes",
"symbol": "user_api.get_user_likes",
"symbol": "score_api.get_user_likes",
"paginated": true,
"documented": true
},
{
"operation_id": "getUserScores",
"method": "get",
"path": "/users/{user}/scores",
"symbol": "user_api.get_user_scores",
"symbol": "score_api.get_user_scores",
"paginated": true,
"documented": true
},
Expand Down Expand Up @@ -1049,7 +1049,6 @@
"CollectionModification",
"CollectionPrivacy",
"CollectionType",
"CreateLtiConfiguration200Response",
"CreditTransaction",
"EduLibrary",
"EduResource",
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.0.1
2.0.2
4 changes: 2 additions & 2 deletions docs/reference/ApiAccessToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Name | Type | Description | Notes
**id** | **str** | Unique identifier of this private token | [optional]
**name** | **str** | Name of the personal access token | [optional]
**token** | **str** | The token. This token will only be returned once, then only the first 4 characters will be returned. | [optional]
**issued_date** | **datetime** | The date then this token was issued | [optional]
**expiration_date** | **datetime** | The date then this token will expire | [optional]
**issued_date** | **datetime** | The date when this token was issued | [optional]
**expiration_date** | **datetime** | The date when this token will expire | [optional]
**scopes** | [**List[AppScopes]**](AppScopes.md) | The list of scopes associated to the token | [optional]

## Example
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/Assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Name | Type | Description | Notes
**cover_file** | **str** | The id of the cover to display | [optional]
**attachments** | [**List[MediaAttachment]**](MediaAttachment.md) | Reference material handed to the students with the assignment: scores, videos, links and Drive files. A score attached here is the one each student receives their own copy of. |
**use_dedicated_attachments** | **bool** | For all assignments created after 02/2023, all the underlying resources must be dedicated and stored in the assignment. This boolean indicates that this assignment only supports dedicated attachments. | [optional]
**max_points** | **float** | If set, the grading will be enabled for the assignement | [optional]
**max_points** | **float** | If set, the grading will be enabled for the assignment | [optional]
**release_grades** | **str** | For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions | [optional]
**shuffle_exercises** | **bool** | Mixing worksheets exercises for each student | [optional]
**shuffle_exercises** | **bool** | Shuffle the worksheet exercises for each student | [optional]
**toolset** | **str** | The id of the associated toolset | [optional]
**nb_playback_authorized** | **float** | The number of playback authorized on the scores of the assignment. | [optional]
**nb_playback_authorized** | **float** | The number of playbacks authorized on the scores of the assignment. | [optional]
**restrict_play_note** | **bool** | Restrict the ability to get an audio feedback every time a student adds or selects a note. | [optional]
**restrict_to_audio_tracks** | **bool** | Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback. | [optional]
**submission_students_mode** | [**AssignmentSubmissionStudentsMode**](AssignmentSubmissionStudentsMode.md) | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/AssignmentCopy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classroom** | **str** | The destination classroom where the assignment will be copied |
**assignment** | **str** | An optional destination assignment where the original assignement will be copied. Must be a draft. | [optional]
**assignment** | **str** | An optional destination assignment where the original assignment will be copied. Must be a draft. | [optional]
**scheduled_date** | **datetime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. Alternatively the existing `scheduledDate` from the copied assignment will be used. | [optional]
**library_parent** | **str** | Identifier of the parent resource where the new one will created, e.g. a folder id or `root` |
**library_parent** | **str** | Identifier of the parent resource where the new one will be created, e.g. a folder id or `root` |
**verify_if_not_already_in_resource_library** | **bool** | Option to check if the assignment is already in Resource Library | [optional]

## Example
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/AssignmentCopyResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Name | Type | Description | Notes
**cover_file** | **str** | The id of the cover to display | [optional]
**attachments** | [**List[MediaAttachment]**](MediaAttachment.md) | Reference material handed to the students with the assignment: scores, videos, links and Drive files. A score attached here is the one each student receives their own copy of. |
**use_dedicated_attachments** | **bool** | For all assignments created after 02/2023, all the underlying resources must be dedicated and stored in the assignment. This boolean indicates that this assignment only supports dedicated attachments. | [optional]
**max_points** | **float** | If set, the grading will be enabled for the assignement | [optional]
**max_points** | **float** | If set, the grading will be enabled for the assignment | [optional]
**release_grades** | **str** | For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions | [optional]
**shuffle_exercises** | **bool** | Mixing worksheets exercises for each student | [optional]
**shuffle_exercises** | **bool** | Shuffle the worksheet exercises for each student | [optional]
**toolset** | **str** | The id of the associated toolset | [optional]
**nb_playback_authorized** | **float** | The number of playback authorized on the scores of the assignment. | [optional]
**nb_playback_authorized** | **float** | The number of playbacks authorized on the scores of the assignment. | [optional]
**restrict_play_note** | **bool** | Restrict the ability to get an audio feedback every time a student adds or selects a note. | [optional]
**restrict_to_audio_tracks** | **bool** | Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback. | [optional]
**submission_students_mode** | [**AssignmentSubmissionStudentsMode**](AssignmentSubmissionStudentsMode.md) | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/AssignmentCopyToClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Copy the assignment to a class
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classroom** | **str** | The destination classroom where the assignment will be copied |
**assignment** | **str** | An optional destination assignment where the original assignement will be copied. Must be a draft. | [optional]
**assignment** | **str** | An optional destination assignment where the original assignment will be copied. Must be a draft. | [optional]
**scheduled_date** | **datetime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. Alternatively the existing `scheduledDate` from the copied assignment will be used. | [optional]

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/AssignmentCopyToResourceLibrary.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Copy the assignment to the EDU Resource Library

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**library_parent** | **str** | Identifier of the parent resource where the new one will created, e.g. a folder id or `root` |
**library_parent** | **str** | Identifier of the parent resource where the new one will be created, e.g. a folder id or `root` |
**verify_if_not_already_in_resource_library** | **bool** | Option to check if the assignment is already in Resource Library | [optional]

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/AssignmentSubmission.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**return_date** | **str** | The date when the teacher returned the work | [optional]
**return_creator** | **str** | The User unique identifier of the teacher who returned the submission | [optional]
**grade** | **float** | Optional grade. If unset, no grade was set. | [optional]
**draft_grade** | **float** | Optional grade. If unset, no grade was set. This value is only visible by the teacher, and we will be set to `grade` once the teacher returns the submission | [optional]
**draft_grade** | **float** | Optional grade. If unset, no grade was set. This value is only visible to the teacher, and is copied to `grade` once the teacher returns the submission | [optional]
**max_points** | **float** | Optional max points for the grade. If set, a corresponding `draftGrade` or `grade` will be set. | [optional]
**exercises_ids** | **List[str]** | The ids of exercises when they need to be in a specific order | [optional]
**playback** | [**List[AssignmentSubmissionPlayback]**](AssignmentSubmissionPlayback.md) | |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/AssignmentSubmissionCommentCreation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AssignmentSubmissionCommentCreation

Creation of a assignment submission comment
Creation of an assignment submission comment

## Properties

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/AssignmentSubmissionUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Name | Type | Description | Notes
**attachments** | [**List[ClassAttachmentCreation]**](ClassAttachmentCreation.md) | | [optional]
**playback** | [**List[AssignmentSubmissionPlayback]**](AssignmentSubmissionPlayback.md) | | [optional]
**submit** | **bool** | If `true`, the submission will be marked as done | [optional]
**draft_grade** | **float** | Optional grade. If unset, no grade was set. This value is only visible by the teacher, and we will be set to `grade` once the teacher returns the submission | [optional]
**draft_grade** | **float** | Optional grade. If unset, no grade was set. This value is only visible to the teacher, and is copied to `grade` once the teacher returns the submission | [optional]
**grade** | **float** | Optional grade. If unset, no grade was set. | [optional]
**exercises_ids** | **List[str]** | The ids of exercises when they need to be in a specific order | [optional]
**var_return** | **bool** | If `true`, the submission will be marked as done | [optional]
**var_return** | **bool** | If `true`, the submission will be returned to the student (teachers only) | [optional]

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/AssignmentUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ Name | Type | Description | Notes
**teacher_instructions** | **str** | Teacher-only instructions (plain text) | [optional]
**teacher_instructions_html** | **str** | HTML version of teacher-only instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility. | [optional]
**attachments** | [**List[ClassAttachmentCreation]**](ClassAttachmentCreation.md) | The complete attachment list. Omitting this property on an update leaves the existing attachments alone; sending it replaces them. Dropping a dedicated score from the list deletes the students' copies of it, so send the full set you want to keep rather than only the additions. Duplicates, judged by `url`, `score`, `worksheet` or `googleDriveFileId`, are discarded silently, and exceeding the per-assignment limit fails with `ASSIGNMENT_ATTACHMENTS_LIMIT`. | [optional]
**nb_playback_authorized** | **float** | The number of playback authorized on the scores of the assignment. | [optional]
**nb_playback_authorized** | **float** | The number of playbacks authorized on the scores of the assignment. | [optional]
**restrict_play_note** | **bool** | Restrict the ability to get an audio feedback every time a student adds or selects a note. | [optional]
**restrict_to_audio_tracks** | **bool** | Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback. | [optional]
**toolset** | **str** | The id of the toolset to apply to this assignment. The toolset will be copied to the assignment as a dedicated object to prevent unexpected changes when making modifications to the template toolset. This property can be set to null to delete the linked toolset and switch back to all the tools available for this assignment. | [optional]
**cover_file** | **str** | The id of the cover to display | [optional]
**cover** | **str** | The URL of the cover to display | [optional]
**max_points** | **float** | If set, the grading will be enabled for the assignement with this value as the maximum of points | [optional]
**max_points** | **float** | If set, the grading will be enabled for the assignment with this value as the maximum of points | [optional]
**release_grades** | **str** | For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions | [optional]
**shuffle_exercises** | **bool** | Mixing worksheets exercises for each student | [optional]
**shuffle_exercises** | **bool** | Shuffle the worksheet exercises for each student | [optional]
**submission_students_mode** | [**AssignmentSubmissionStudentsMode**](AssignmentSubmissionStudentsMode.md) | | [optional]
**recording_type** | **str** | For performance assignments: recording type that will be either 'audio' or 'video'. * `audio`: Only audio will be required during the recording. * `video`: Camera will be required during the recording. Only set when type is 'performance'. | [optional]
**allow_metronome** | **bool** | For performance assignments: Enable students to use the metronome while they are recording, helping them stay in time. Only set when type is 'performance'. | [optional]
Expand Down
Loading
Loading