Skip to content

Commit

Permalink
Deprecate lessons_presentation_order (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
scottnicolson authored Mar 21, 2024
1 parent e8f6b56 commit 34e2d6d
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions source/includes/20170710/resources/_user.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Attribute | Data Type | Description
`extra_study_autoplay_audio` | Boolean | Automatically play pronunciation audio for vocabulary during extra study.
`lessons_autoplay_audio` | Boolean | Automatically play pronunciation audio for vocabulary during lessons.
`lessons_batch_size` | Integer | Number of subjects introduced to the user during lessons before quizzing.
`lessons_presentation_order` | String | The order in which lessons are presented. The options are `ascending_level_then_subject`, `shuffled`, and `ascending_level_then_shuffled`. The default (and best experience) is `ascending_level_then_subject`.
`lessons_presentation_order` | String | This is a deprecated user preference. It always returns `ascending_level_then_subject`. Setting this preference will do nothing. It exists only to ensure existing consumers of this API don't break.
`reviews_autoplay_audio` | Boolean | Automatically play pronunciation audio for vocabulary during reviews.
`reviews_display_srs_indicator` | Boolean | Toggle for display SRS change indicator after a subject has been completely answered during review.
`reviews_presentation_order` | String | The order in which reviews are presented. The options are `shuffled` and `lower_levels_first`. The default (and best experience) is `shuffled`.
Expand Down Expand Up @@ -122,9 +122,9 @@ Returns a summary of user information.

> Example Request

<%= partial('examples/PUT_shell', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "lessons_presentation_order": "shuffled", "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>
<%= partial('examples/PUT_shell', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>

<%= partial('examples/PUT_javascript', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "lessons_presentation_order": "shuffled", "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>
<%= partial('examples/PUT_javascript', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>

> Example Response

Expand All @@ -151,7 +151,7 @@ Returns a summary of user information.
"extra_study_autoplay_audio": false,
"lessons_autoplay_audio": true,
"lessons_batch_size": 3,
"lessons_presentation_order": "shuffled",
"lessons_presentation_order": "ascending_level_then_subject",
"reviews_autoplay_audio": true,
"reviews_display_srs_indicator": false,
"reviews_presentation_order": "shuffled"
Expand All @@ -176,7 +176,6 @@ Name | Data Type | Required?
`extra_study_autoplay_audio` | Boolean | false
`lessons_autoplay_audio` | Boolean | false
`lessons_batch_size` | Integer | false
`lessons_presentation_order` | String | false
`reviews_autoplay_audio` | Boolean | false
`reviews_display_srs_indicator` | Boolean | false
`reviews_presentation_order` | String | false

0 comments on commit 34e2d6d

Please sign in to comment.