Skip to content

Commit bb89049

Browse files
authored
Merge branch 'main' into DDOC-1131-incorrect-information-client-credentials
2 parents 1211ef9 + bea0019 commit bb89049

File tree

87 files changed

+999
-675
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+999
-675
lines changed

content/guides/api-calls/allowing-domain-access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ alias_paths:
1111
- /guides/api-calls/domain-whitelisting
1212
---
1313

14-
# Allowing Domain Access
14+
# Allow domain access
1515

1616
To use the Box APIs it is important that your application and users have access
1717
to the following domains, where needed.
1818

19-
## File Preview
19+
## File preview
2020

2121
To enable file preview, your application might need to load javascript file from
2222
the Box content delivery network (CDN). This file is loaded from the following

content/guides/api-calls/api-versioning-strategy.md

Lines changed: 49 additions & 65 deletions
Large diffs are not rendered by default.

content/guides/api-calls/ensure-consistency.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ required_guides: []
1717
alias_paths: []
1818
---
1919

20-
# Ensure Consistency
20+
# Ensure consistency with headers
2121

22-
A few of the Box APIs support headers to control consistency between your
22+
Some Box APIs support headers used to ensure consistency between your
2323
application and Box.
2424

2525
## `etag`, `if-match`, and `if-none-match`
@@ -83,7 +83,7 @@ The following endpoints support this header.
8383
The response of these APIs calls depends on the existence of the item,
8484
and whether the `etag` value matches the most recent version.
8585

86-
| Item found? | Etag match? | HTTP Status |
86+
| Item found? | Etag match? | HTTP status |
8787
| ----------- | ----------- | ----------- |
8888
| Yes | Yes | 200 |
8989
| Yes | No | 412 |
34.6 KB
Loading

content/guides/api-calls/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ alias_paths:
88

99
# API Calls
1010

11-
The Box API is a restful API that attempts to follow common HTTP standards
11+
The Box API is a restful API that follow common HTTP standards
1212
where possible. The following guides take a look at some of the useful
1313
features and common mistakes that a developer can encounter when working with
1414
these APIs.

content/guides/api-calls/language-codes.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ alias_paths:
77
- /docs/api-language-codes
88
---
99

10-
# Language Codes
10+
# Language codes
1111

12-
The Box API uses a modified version of the ISO 639-1 Language Code to specify a
13-
user's language.
12+
The Box API uses a modified version of the **ISO 639-1 Language Code** to specify a user's language.
1413

1514
The following is a list of language codes used when [creating][create_user] or [updating][update_user].
1615

content/guides/api-calls/permissions-and-errors/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ required_guides: []
66
alias_paths: []
77
---
88

9-
# Permissions & Errors
9+
# Permissions and errors
1010

1111
The following guides provide information on the permissions or errors related to
1212
the Box API. It includes pages on [Common Errors][1], [Rate Limits][2],

content/guides/api-calls/request-extra-fields.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,15 @@ required_guides: []
1010
alias_paths: []
1111
---
1212

13-
# Request Extra Fields
13+
# Request extra fields
1414

15-
The number of fields returned for a resource can depend on the API endpoint used
15+
The number of fields returned for a resource depends on the API endpoint used
1616
to request the resource.
1717

18-
| Variant | |
19-
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20-
| Standard | The standard set of fields returned when requesting a resource for its own endpoints, for example when requesting a file through the [`GET /files/:id`](endpoint://get_files_id) endpoint |
21-
| Full | The full set of fields that can be returned through a resource's own endpoints by using the `field` query parameter |
22-
| Mini | A subset of fields that is returned when a resource is returned as a nested part of another resource, for example when a file is returned when requesting all items in a folder through the [`GET /folders/:id/items`](endpoint://get_folders_id_items) endpoint |
23-
24-
The API reference documentation has each of these variations labeled in more
25-
detail. Most notably, the file, folder, web link, and user items have full and
26-
mini variations.
27-
28-
## Using the field query parameter
18+
## Use the `fields` query parameter
2919

3020
To request a specific field for a resource that is not returned by default in
31-
the standard response, append the `field` query parameter to your request. The
21+
the standard response, append the `fields` query parameter to your request. The
3222
value of this parameter is a comma separated list of field names.
3323

3424
```curl
@@ -48,18 +38,18 @@ curl https://api.box.com/2.0/files/12345?fields=is_package,lock \
4838

4939
<Message type='notice'>
5040
It is important to note that when a specific field is requested no other
51-
fields are returned except for those requested and the "base" set of fields.
41+
fields are returned except for those requested and the **base** set of fields.
5242
For a file, this base set is comprised of the `etag`, `id`, and `type` values.
5343
</Message>
5444

55-
## Resource
45+
## Resource variants
5646

57-
The following resource variants are available via our API.
47+
The following resource variants are available in the Box API.
5848

5949
### Standard
6050

61-
The default set of fields returned in an API response is commonly known as the
62-
standard resource variant. It is generally returned when requesting a resource
51+
The default set of fields returned in an API response.
52+
The standard variant is returned when requesting a resource
6353
through the main APIs available for that resource. For example, when requesting
6454
the [`GET /files/:id`](endpoint://get_files_id) endpoint the API will return
6555
the standard variation of a file.
@@ -148,14 +138,12 @@ curl https://api.box.com/2.0/files/12345 \
148138

149139
### Full
150140

151-
The total set of fields that can be returned in an API response is commonly known
152-
as the full resource variant. It can generally be returned when requesting a resource
141+
The total set of fields that can be returned in an API response. The full variant is returned when requesting a resource
153142
through the main APIs available for that resource and by appending the `fields`
154143
query parameter.
155144

156145
For example, when requesting the [`GET /files/:id`](endpoint://get_files_id)
157-
endpoint with the `fields=is_package,lock` parameter the API will return the fields
158-
specified plus the basic fields for the file.
146+
endpoint with the `fields=is_package,lock` parameter the API will return the fields specified plus the basic fields for the file.
159147

160148
```curl
161149
curl https://api.box.com/2.0/files/12345?fields=is_package,lock \

content/guides/api-calls/sorting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ required_guides: []
77
alias_paths: []
88
---
99

10-
# Sorting Responses
10+
# Sorting responses
1111

1212
Where an API returns a collection of items it often supports sorting of API
1313
responses.

content/guides/api-calls/status-codes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ required_guides: []
88
alias_paths: []
99
---
1010

11-
# Status Codes
11+
# Status codes
1212

13-
In general, the following rules can be applied to interpret the HTTP status
13+
The following rules can be applied to interpret the HTTP status
1414
codes received when using the Box API.
1515

1616
| HTTP Status | |

0 commit comments

Comments
 (0)