{"docs":{"name":"OpenStax Exercises API","info":"\n

Access to the API must be achieved through an OAuth flow or by having a user that is logged in to the system (with a session, etc).

\n\n

When communicating with the API, developers must set a header in the HTTP request to specify which version of the API they want to use:

\n\n \n \n \n \n \n \n \n \n \n \n
Header NameValueVersion Accessed
'Accept''application/vnd.exercises.openstax.v1'v1
\n

Many of the API specifications provide a related JSON schema. These schemas are based on the standard defined at http://json-schema.org/. A lot of these schemas aren’t overly specific to the actions they are listed under, e.g. they always say that an id is required but that isn’t the case when new data is being posted to a create call.

\n","copyright":"Copyright © 2011-2026 Rice University","doc_url":"/api/docs/v1","api_url":"/api","resources":{"books":{"doc_url":"/api/docs/v1/books","id":"books","api_url":"/api","name":"Books","short_description":"Lists of OpenStax books and pages in each book","full_description":"\n

Returns lists of OpenStax books and pages in each book

\n","version":"v1","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/v1/books/index","name":"index","apis":[{"api_url":"/api/books","http_method":"GET","short_description":"Returns a list of books in both the ABL and some archive version or latest","deprecated":null}],"formats":null,"full_description":"\n

Returns a list of books in both the ABL and some archive version (default: latest)

\n","errors":[],"params":[{"name":"archive_version","full_name":"archive_version","description":"\n

Archive code pipeline version (default: latest version)

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/books/show","name":"show","apis":[{"api_url":"/api/books/:uuid","http_method":"GET","short_description":"Returns a list of pages in some book","deprecated":null}],"formats":null,"full_description":"\n

Returns a list of pages in some book in some archive version (default: latest)

\n","errors":[],"params":[{"name":"archive_version","full_name":"archive_version","description":"\n

Archive code pipeline version (default: latest version)

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\n

Book uuid

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"exercises":{"doc_url":"/api/docs/v1/exercises","id":"exercises","api_url":"/api","name":"Exercises","short_description":"A collection of related questions.","full_description":"\n

Exercises are collections of related questions about a very specific situation or topic, possibly united by a common background story.

\n","version":"v1","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/v1/exercises/index","name":"index","apis":[{"api_url":"/api/exercises","http_method":"GET","short_description":"Return a set of Exercises matching query terms","deprecated":null},{"api_url":"/api/exercises/search","http_method":"GET","short_description":"Return a set of Exercises matching query terms","deprecated":null},{"api_url":"/api/exercises/search","http_method":"POST","short_description":"Return a set of Exercises matching query terms","deprecated":null}],"formats":null,"full_description":"\n

Accepts a query string along with options and returns a JSON representation of the matching Exercises. Only Exercises visible to the caller will be returned. The schema for the returned JSON result is shown below.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"total_count\",\n    \"items\"\n  ],\n  \"properties\": {\n    \"total_count\": {\n      \"type\": \"integer\",\n      \"description\": \"The number of items matching the query; can be more than the number returned if paginating\"\n    },\n    \"items\": {\n      \"type\": \"array\",\n      \"description\": \"The items matching the query or a subset thereof when paginating\",\n      \"items\": {}\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[{"name":"q","full_name":"q","description":"\n

The search query string, built up as a space-separated collection of search conditions on different fields. Each condition is formatted as “field_name:comma-separated-values”. The resulting list of exercises will match all of the conditions (boolean ‘and’). Each condition will produce a list of exercises where those exercises must match any of the comma-separated-values (boolean ‘or’). The fields_names and their characteristics are given below. When a field is listed as using wildcard matching, it means that any fields that start with a comma-separated-value will be matched.

\n\n\n\n

You can also add search terms without prefixes, separated by spaces. These terms will be searched for in all of the prefix categories. Any matching exercises will be returned. When combined with prefixed search terms, the final results will contain exercises matching any of the non prefixed terms and all of the prefixed terms.

\n\n

Examples:

\n\n

content:DTFT – returns exercises containing the DTFT word.

\n\n

number:1 version:2 – returns exercise 1@2.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_by","full_name":"order_by","description":"\n

A string that indicates how to sort the results of the query. The string is a comma-separated list of fields with an optional sort direction. The sort will be performed in the order the fields are given. The fields can be one of number, uuid, version, title, created_at, updated_at, published_at. Sort directions can either be ASC for an ascending sort, or DESC for a descending sort. If not provided, an ascending sort is assumed. Sort directions should be separated from the fields by a space. (default: number ASC)

\n\n

Example:

\n\n

number, version DESC – sorts by number ascending, then by version descending

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["https://exercises.openstax.org/api/exercises/?q=author:\"bob\" content:\"test\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/exercises/create","name":"create","apis":[{"api_url":"/api/exercises","http_method":"POST","short_description":"Creates an Exercise","deprecated":null}],"formats":null,"full_description":"\n

Creates an Exercise with the given attributes.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"questions\"\n  ],\n  \"properties\": {\n    \"images\": {\n      \"type\": \"string\"\n    },\n    \"logic\": {},\n    \"tags\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"nickname\": {\n      \"type\": \"string\"\n    },\n    \"license\": {},\n    \"solutions_are_public\": {\n      \"type\": \"string\"\n    },\n    \"derived_from\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"title\": {\n      \"type\": \"string\"\n    },\n    \"stimulus_html\": {\n      \"type\": \"string\"\n    },\n    \"questions\": {\n      \"type\": \"array\",\n      \"items\": {}\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/exercises/show","name":"show","apis":[{"api_url":"/api/exercises/:uid","http_method":"GET","short_description":"Gets the specified Exercise","deprecated":null}],"formats":null,"full_description":"\n

Gets the Exercise that matches the provided UID.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"questions\"\n  ],\n  \"properties\": {\n    \"images\": {\n      \"type\": \"string\"\n    },\n    \"logic\": {},\n    \"tags\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"uuid\": {\n      \"type\": \"string\"\n    },\n    \"group_uuid\": {\n      \"type\": \"string\"\n    },\n    \"number\": {\n      \"type\": \"integer\"\n    },\n    \"version\": {\n      \"type\": \"integer\"\n    },\n    \"uid\": {\n      \"type\": \"string\"\n    },\n    \"published_at\": {\n      \"type\": \"string\"\n    },\n    \"nickname\": {\n      \"type\": \"string\"\n    },\n    \"license\": {},\n    \"solutions_are_public\": {\n      \"type\": \"string\"\n    },\n    \"authors\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"copyright_holders\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"delegations\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"derived_from\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"is_vocab\": {\n      \"type\": \"string\"\n    },\n    \"vocab_term_uid\": {\n      \"type\": \"integer\"\n    },\n    \"title\": {\n      \"type\": \"string\"\n    },\n    \"context\": {\n      \"type\": \"string\"\n    },\n    \"stimulus_html\": {\n      \"type\": \"string\"\n    },\n    \"questions\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"versions\": {\n      \"type\": \"array\"\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/exercises/update","name":"update","apis":[{"api_url":"/api/exercises/:uid","http_method":"PUT","short_description":"Updates the specified Exercise","deprecated":null}],"formats":null,"full_description":"\n

Updates the Exercise that matches the provided UID with the given attributes.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"questions\"\n  ],\n  \"properties\": {\n    \"images\": {\n      \"type\": \"string\"\n    },\n    \"logic\": {},\n    \"tags\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"nickname\": {\n      \"type\": \"string\"\n    },\n    \"license\": {},\n    \"solutions_are_public\": {\n      \"type\": \"string\"\n    },\n    \"derived_from\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"title\": {\n      \"type\": \"string\"\n    },\n    \"stimulus_html\": {\n      \"type\": \"string\"\n    },\n    \"questions\": {\n      \"type\": \"array\",\n      \"items\": {}\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/exercises/destroy","name":"destroy","apis":[{"api_url":"/api/exercises/:uid","http_method":"DELETE","short_description":"Deletes the specified Exercise","deprecated":null}],"formats":null,"full_description":"\n

Deletes the Exercise that matches the provided UID.

\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"publications":{"doc_url":"/api/docs/v1/publications","id":"publications","api_url":"/api","name":"Publications","short_description":"Contains information about a publishable object.","full_description":"\n

Publications contain information about the publication status of publishable objects, such as Exercises, Solutions and code Libraries.

\n","version":"v1","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/v1/publications/publish","name":"publish","apis":[{"api_url":"/api/object_name/:object_uid/publish","http_method":"PUT","short_description":"Publishes the specified object","deprecated":null}],"formats":null,"full_description":"\n

Publishes the specified object.

\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"users":{"doc_url":"/api/docs/v1/users","id":"users","api_url":"/api","name":"Users","short_description":"A human user of OpenStax Exercises.","full_description":"\n

Users have the following String attributes: username first_name last_name full_name title

\n","version":"v1","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/v1/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"Return a set of Users matching query terms","deprecated":null}],"formats":null,"full_description":"\n

Accepts a query string along with options and returns a JSON representation of the matching Users. Some User data may be filtered out depending on the caller’s status and privileges in the system. The schema for the returned JSON result is shown below.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"total_count\",\n    \"items\"\n  ],\n  \"properties\": {\n    \"total_count\": {\n      \"type\": \"integer\",\n      \"description\": \"The number of accounts matching the query; can be more than the number returned\"\n    },\n    \"items\": {\n      \"type\": \"array\",\n      \"description\": \"The accounts matching the query or a subset thereof when paginating\",\n      \"items\": {}\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[{"name":"q","full_name":"q","description":"\n

The search query string, built up as a space-separated collection of search conditions on different fields. Each condition is formatted as “field_name:comma-separated-values”. The resulting list of users will match all of the conditions (boolean ‘and’). Each condition will produce a list of users where those users must match any of the comma-separated-values (boolean ‘or’). The fields_names and their characteristics are given below. When a field is listed as using wildcard matching, it means that any fields that start with a comma-separated-value will be matched.

\n\n\n\n

You can also add search terms without prefixes, separated by spaces. These terms will be searched for in all of the prefix categories. Any matching users will be returned. When combined with prefixed search terms, the final results will contain users matching any of the non prefixed terms and all of the prefixed terms.

\n\n

Examples:

\n\n

username:ric – returns ‘richb’ and ‘ricardo’ users.

\n\n

username:ric name:"Van Buren" – returns the ‘Ricardo Van Buren’ user.

\n\n

ric – returns ‘richb’, ‘ricardo’, and ‘Jimmy Rich’ users.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_by","full_name":"order_by","description":"\n

A string that indicates how to sort the results of the query. The string is a comma-separated list of fields with an optional sort direction. The sort will be performed in the order the fields are given. The fields can be one of username, first_name, last_name, full_name, id, created_at. Sort directions can either be ASC for an ascending sort, or DESC for a descending sort. If not provided, an ascending sort is assumed. Sort directions should be separated from the fields by a space. (default: username ASC)

\n\n

Example:

\n\n

last_name, username DESC – sorts by last name ascending, then by username descending

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["https://users.openstax.org/api/users/?q=username:bob%20name=Jones"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/users/show","name":"show","apis":[{"api_url":"/api/user","http_method":"GET","short_description":"Gets the current user's profile","deprecated":null}],"formats":null,"full_description":"\n

Gets the current user’s profile.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"integer\"\n    },\n    \"username\": {\n      \"type\": \"string\"\n    },\n    \"first_name\": {\n      \"type\": \"string\"\n    },\n    \"last_name\": {\n      \"type\": \"string\"\n    },\n    \"full_name\": {\n      \"type\": \"string\"\n    },\n    \"title\": {\n      \"type\": \"string\"\n    },\n    \"faculty_status\": {\n      \"type\": \"string\"\n    },\n    \"self_reported_role\": {\n      \"type\": \"string\"\n    },\n    \"uuid\": {\n      \"type\": \"string\"\n    },\n    \"support_identifier\": {\n      \"type\": \"string\"\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/users/update","name":"update","apis":[{"api_url":"/api/user","http_method":"PATCH","short_description":"Updates the current user's profile","deprecated":null}],"formats":null,"full_description":"\n

Updates the current user’s profile.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"first_name\": {\n      \"type\": \"string\"\n    },\n    \"last_name\": {\n      \"type\": \"string\"\n    },\n    \"full_name\": {\n      \"type\": \"string\"\n    },\n    \"title\": {\n      \"type\": \"string\"\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/users/destroy","name":"destroy","apis":[{"api_url":"/api/user","http_method":"DELETE","short_description":"Disables the current user's account","deprecated":null}],"formats":null,"full_description":"\n

Disables the current user’s account.

\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"vocab_terms":{"doc_url":"/api/docs/v1/vocab_terms","id":"vocab_terms","api_url":"/api","name":"Vocab_terms","short_description":"A vocabulary term, its definition and distractors","full_description":"\n

Vocabulary terms represent a word or phrase, its definition and related distractor terms or definitions.

\n","version":"v1","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/v1/vocab_terms/index","name":"index","apis":[{"api_url":"/api/vocab_terms","http_method":"GET","short_description":"Return a set of VocabTerms matching query terms","deprecated":null},{"api_url":"/api/vocab_terms/search","http_method":"GET","short_description":"Return a set of VocabTerms matching query terms","deprecated":null},{"api_url":"/api/vocab_terms/search","http_method":"POST","short_description":"Return a set of VocabTerms matching query terms","deprecated":null}],"formats":null,"full_description":"\n

Accepts a query string along with options and returns a JSON representation of the matching VocabTerms. Only VocabTerms visible to the caller will be returned. The schema for the returned JSON result is shown below.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"total_count\",\n    \"items\"\n  ],\n  \"properties\": {\n    \"total_count\": {\n      \"type\": \"integer\",\n      \"description\": \"The number of items matching the query; can be more than the number returned if paginating\"\n    },\n    \"items\": {\n      \"type\": \"array\",\n      \"description\": \"The items matching the query or a subset thereof when paginating\",\n      \"items\": {}\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[{"name":"q","full_name":"q","description":"\n

The search query string, built up as a space-separated collection of search conditions on different fields. Each condition is formatted as “field_name:comma-separated-values”. The resulting list of vocab_terms will match all of the conditions (boolean ‘and’). Each condition will produce a list of vocab terms where those vocab terms must match any of the comma-separated-values (boolean ‘or’). The fields_names and their characteristics are given below. When a field is listed as using wildcard matching, it means that any fields that start with a comma-separated-value will be matched.

\n\n\n\n

You can also add search terms without prefixes, separated by spaces. These terms will be searched for in all of the prefix categories. Any matching vocab terms will be returned. When combined with prefixed search terms, the final results will contain vocab terms matching any of the non prefixed terms and all of the prefixed terms.

\n\n

Examples:

\n\n

content:DTFT – returns vocab terms containing the DTFT word.

\n\n

number:1 version:2 – returns vocab term 1@2.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_by","full_name":"order_by","description":"\n

A string that indicates how to sort the results of the query. The string is a comma-separated list of fields with an optional sort direction. The sort will be performed in the order the fields are given. The fields can be one of number, uuid, version, name, definition, created_at, updated_at, published_at. Sort directions can either be ASC for an ascending sort, or DESC for a descending sort. If not provided, an ascending sort is assumed. Sort directions should be separated from the fields by a space. (default: number ASC)

\n\n

Example:

\n\n

number, version DESC – sorts by number ascending, then by version descending

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["https://exercises.openstax.org/api/vocab_terms/?q=name:\"term\" definition:\"def\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/vocab_terms/create","name":"create","apis":[{"api_url":"/api/vocab_terms","http_method":"POST","short_description":"Creates a VocabTerm","deprecated":null}],"formats":null,"full_description":"\n

Creates a VocabTerm with the given attributes.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"term\",\n    \"definition\",\n    \"distractor_terms\",\n    \"distractor_literals\",\n    \"exercise_uuids\",\n    \"exercise_uids\"\n  ],\n  \"properties\": {\n    \"tags\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"nickname\": {\n      \"type\": \"string\"\n    },\n    \"license\": {},\n    \"solutions_are_public\": {\n      \"type\": \"string\"\n    },\n    \"derived_from\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"term\": {\n      \"type\": \"string\"\n    },\n    \"definition\": {\n      \"type\": \"string\"\n    },\n    \"distractor_terms\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"distractor_literals\": {\n      \"type\": \"array\"\n    },\n    \"exercise_uuids\": {\n      \"type\": \"array\"\n    },\n    \"exercise_uids\": {\n      \"type\": \"array\"\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/vocab_terms/show","name":"show","apis":[{"api_url":"/api/vocab_terms/:uid","http_method":"GET","short_description":"Gets the specified VocabTerm","deprecated":null}],"formats":null,"full_description":"\n

Gets the VocabTerm that matches the provided UID.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"term\",\n    \"definition\",\n    \"distractor_terms\",\n    \"distractor_literals\",\n    \"exercise_uuids\",\n    \"exercise_uids\"\n  ],\n  \"properties\": {\n    \"tags\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"uuid\": {\n      \"type\": \"string\"\n    },\n    \"group_uuid\": {\n      \"type\": \"string\"\n    },\n    \"number\": {\n      \"type\": \"integer\"\n    },\n    \"version\": {\n      \"type\": \"integer\"\n    },\n    \"uid\": {\n      \"type\": \"string\"\n    },\n    \"published_at\": {\n      \"type\": \"string\"\n    },\n    \"nickname\": {\n      \"type\": \"string\"\n    },\n    \"license\": {},\n    \"solutions_are_public\": {\n      \"type\": \"string\"\n    },\n    \"authors\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"copyright_holders\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"delegations\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"derived_from\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"term\": {\n      \"type\": \"string\"\n    },\n    \"definition\": {\n      \"type\": \"string\"\n    },\n    \"distractor_terms\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"distractor_literals\": {\n      \"type\": \"array\"\n    },\n    \"exercise_uuids\": {\n      \"type\": \"array\"\n    },\n    \"exercise_uids\": {\n      \"type\": \"array\"\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/vocab_terms/update","name":"update","apis":[{"api_url":"/api/vocab_terms/:uid","http_method":"PUT","short_description":"Updates the specified VocabTerm","deprecated":null}],"formats":null,"full_description":"\n

Updates the VocabTerm that matches the provided UID with the given attributes.

\n\n

Schema

\n
\n{\n  \"type\": \"object\",\n  \"required\": [\n    \"term\",\n    \"definition\",\n    \"distractor_terms\",\n    \"distractor_literals\",\n    \"exercise_uuids\",\n    \"exercise_uids\"\n  ],\n  \"properties\": {\n    \"tags\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"nickname\": {\n      \"type\": \"string\"\n    },\n    \"license\": {},\n    \"solutions_are_public\": {\n      \"type\": \"string\"\n    },\n    \"derived_from\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"term\": {\n      \"type\": \"string\"\n    },\n    \"definition\": {\n      \"type\": \"string\"\n    },\n    \"distractor_terms\": {\n      \"type\": \"array\",\n      \"items\": {}\n    },\n    \"distractor_literals\": {\n      \"type\": \"array\"\n    },\n    \"exercise_uuids\": {\n      \"type\": \"array\"\n    },\n    \"exercise_uids\": {\n      \"type\": \"array\"\n    }\n  },\n  \"additionalProperties\": false\n}\n
","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/vocab_terms/destroy","name":"destroy","apis":[{"api_url":"/api/vocab_terms/:uid","http_method":"DELETE","short_description":"Deletes the specified VocabTerm","deprecated":null}],"formats":null,"full_description":"\n

Deletes the VocabTerm that matches the provided UID.

\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}