Skip to content

Commit fbbd4e9

Browse files
committed
updated .md
1 parent b68bc4a commit fbbd4e9

File tree

5 files changed

+5
-6
lines changed

5 files changed

+5
-6
lines changed

pages/subjects/create-a-subject.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
### Create a Subject
2-
Creates a new Subject with the given `name` and `category`, linked to the request user's Branch (`custom_to_branch`=True).
2+
Creates a new Subject with the given `name` and `category`, linked to the API key's Branch (`custom_to_branch`=True).
33

pages/subjects/delete-a-subject.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
### Delete a Subject
2-
Deletes a Subject created by the user's Branch (`custom_to_branch`=True). Only the Subject's unique id is required in the URL. Subjects not created by the user's Branch cannot be deleted.
2+
Deletes a Subject that was created by your Branch (i.e., where `custom_to_branch`=True). Only Subjects created by your Branch can be deleted; attempting to delete a Subject not owned by your Branch will result in an error. Provide the Subject’s unique ID in the URL path.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
### List all Subjects
22

3-
Returns all Subjects, sorted by id in descending order (highest first). Includes Subjects linked to the user's Branch, as well as unassigned Subjects (custom_to_branch = null). Subjects assigned to other Branches or marked as hidden for the user's Branch are excluded.
3+
Returns all Subjects, sorted by `id` in descending order (highest first). Includes Subjects associated with the API key's Branch, as well as unassigned Subjects (`custom_to_branch` = null). Subjects linked to other Branches or marked as hidden for the API key's Branch are excluded.

pages/subjects/subject-object.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
### Subject Object
22

3-
Subject object contains the `id`, `name`, `category_id`, `category_name` and `custom_to_branch` for Subjects found
4-
on your TutorCruncher account.
3+
The Subject object contains the `id`, `name`, `category_id`, `category_name`, and `custom_to_branch` for Subjects associated with the API key's Branch on your TutorCruncher account.

pages/subjects/subject-object.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ attributes:
1818
-
1919
name: custom_to_branch
2020
type: bool
21-
description: Indicates whether the Subject is specific to the requesting user's Branch (True) or shared across all Branches (null).
21+
description: Indicates whether the Subject is specific to the API key's Branch (True), or shared across all Branches (null).
2222

0 commit comments

Comments
 (0)