docs/GlossaryTermsApi.md in phrase-2.7.1 vs docs/GlossaryTermsApi.md in phrase-2.7.2
- old
+ new
@@ -2,25 +2,25 @@
All URIs are relative to *https://api.phrase.com/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**glossary_term_create**](GlossaryTermsApi.md#glossary_term_create) | **POST** /accounts/{account_id}/glossaries/{glossary_id}/terms | Create a glossary term
-[**glossary_term_delete**](GlossaryTermsApi.md#glossary_term_delete) | **DELETE** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Delete a glossary term
-[**glossary_term_show**](GlossaryTermsApi.md#glossary_term_show) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Get a single glossary term
-[**glossary_term_update**](GlossaryTermsApi.md#glossary_term_update) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Update a glossary term
-[**glossary_terms_list**](GlossaryTermsApi.md#glossary_terms_list) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms | List glossary terms
+[**glossary_term_create**](GlossaryTermsApi.md#glossary_term_create) | **POST** /accounts/{account_id}/glossaries/{glossary_id}/terms | Create a term
+[**glossary_term_delete**](GlossaryTermsApi.md#glossary_term_delete) | **DELETE** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Delete a term
+[**glossary_term_show**](GlossaryTermsApi.md#glossary_term_show) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Get a single term
+[**glossary_term_update**](GlossaryTermsApi.md#glossary_term_update) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Update a term
+[**glossary_terms_list**](GlossaryTermsApi.md#glossary_terms_list) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms | List terms
## glossary_term_create
> GlossaryTerm glossary_term_create(account_id, glossary_id, glossary_term_create_parameters, opts)
-Create a glossary term
+Create a term
-Create a new glossary term.
+Create a new term in a term base (previously: glossary).
### Example
```ruby
# load the gem
@@ -43,11 +43,11 @@
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
- #Create a glossary term
+ #Create a term
result = api_instance.glossary_term_create(account_id, glossary_id, glossary_term_create_parameters, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling GlossaryTermsApi->glossary_term_create: #{e}"
end
@@ -79,13 +79,13 @@
## glossary_term_delete
> glossary_term_delete(account_id, glossary_id, id, opts)
-Delete a glossary term
+Delete a term
-Delete an existing glossary term.
+Delete an existing term in a term base (previously: glossary).
### Example
```ruby
# load the gem
@@ -108,11 +108,11 @@
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
- #Delete a glossary term
+ #Delete a term
api_instance.glossary_term_delete(account_id, glossary_id, id, opts)
rescue Phrase::ApiError => e
puts "Exception when calling GlossaryTermsApi->glossary_term_delete: #{e}"
end
```
@@ -143,13 +143,13 @@
## glossary_term_show
> GlossaryTerm glossary_term_show(account_id, glossary_id, id, opts)
-Get a single glossary term
+Get a single term
-Get details on a single glossary term.
+Get details for a single term in the term base (previously: glossary).
### Example
```ruby
# load the gem
@@ -172,11 +172,11 @@
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
- #Get a single glossary term
+ #Get a single term
result = api_instance.glossary_term_show(account_id, glossary_id, id, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling GlossaryTermsApi->glossary_term_show: #{e}"
end
@@ -208,13 +208,13 @@
## glossary_term_update
> GlossaryTerm glossary_term_update(account_id, glossary_id, id, glossary_term_update_parameters, opts)
-Update a glossary term
+Update a term
-Update an existing glossary term.
+Update an existing term in a term base (previously: glossary).
### Example
```ruby
# load the gem
@@ -238,11 +238,11 @@
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
- #Update a glossary term
+ #Update a term
result = api_instance.glossary_term_update(account_id, glossary_id, id, glossary_term_update_parameters, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling GlossaryTermsApi->glossary_term_update: #{e}"
end
@@ -275,13 +275,13 @@
## glossary_terms_list
> Array<GlossaryTerm> glossary_terms_list(account_id, glossary_id, opts)
-List glossary terms
+List terms
-List all glossary terms the current user has access to.
+List all terms in term bases (previously: glossary) that the current user has access to.
### Example
```ruby
# load the gem
@@ -305,10 +305,10 @@
page: 1, # Integer | Page number
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
}
begin
- #List glossary terms
+ #List terms
result = api_instance.glossary_terms_list(account_id, glossary_id, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling GlossaryTermsApi->glossary_terms_list: #{e}"
end