Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APIMGMT-637: Add info about versioning / lifecycle markings #632

Merged
merged 6 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/guides/api-calls/allowing-domain-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ alias_paths:
- /guides/api-calls/domain-whitelisting
---

# Allowing Domain Access
# Allow domain access

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

## File Preview
## File preview

To enable file preview, your application might need to load javascript file from
the Box content delivery network (CDN). This file is loaded from the following
Expand Down
114 changes: 49 additions & 65 deletions content/guides/api-calls/api-versioning-strategy.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions content/guides/api-calls/ensure-consistency.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ required_guides: []
alias_paths: []
---

# Ensure Consistency
# Ensure consistency with headers

A few of the Box APIs support headers to control consistency between your
Some Box APIs support headers used to ensure consistency between your
application and Box.

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

| Item found? | Etag match? | HTTP Status |
| Item found? | Etag match? | HTTP status |
| ----------- | ----------- | ----------- |
| Yes | Yes | 200 |
| Yes | No | 412 |
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/guides/api-calls/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ alias_paths:

# API Calls

The Box API is a restful API that attempts to follow common HTTP standards
The Box API is a restful API that follow common HTTP standards
where possible. The following guides take a look at some of the useful
features and common mistakes that a developer can encounter when working with
these APIs.
Expand Down
5 changes: 2 additions & 3 deletions content/guides/api-calls/language-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ alias_paths:
- /docs/api-language-codes
---

# Language Codes
# Language codes

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

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

Expand Down
2 changes: 1 addition & 1 deletion content/guides/api-calls/permissions-and-errors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ required_guides: []
alias_paths: []
---

# Permissions & Errors
# Permissions and errors

The following guides provide information on the permissions or errors related to
the Box API. It includes pages on [Common Errors][1], [Rate Limits][2],
Expand Down
34 changes: 11 additions & 23 deletions content/guides/api-calls/request-extra-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,15 @@ required_guides: []
alias_paths: []
---

# Request Extra Fields
# Request extra fields

The number of fields returned for a resource can depend on the API endpoint used
The number of fields returned for a resource depends on the API endpoint used
to request the resource.

| Variant | |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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 |
| Full | The full set of fields that can be returned through a resource's own endpoints by using the `field` query parameter |
| 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 |

The API reference documentation has each of these variations labeled in more
detail. Most notably, the file, folder, web link, and user items have full and
mini variations.

## Using the field query parameter
## Use the `fields` query parameter

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

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

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

## Resource
## Resource variants

The following resource variants are available via our API.
The following resource variants are available in the Box API.

### Standard

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

### Full

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

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

```curl
curl https://api.box.com/2.0/files/12345?fields=is_package,lock \
Expand Down
2 changes: 1 addition & 1 deletion content/guides/api-calls/sorting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ required_guides: []
alias_paths: []
---

# Sorting Responses
# Sorting responses

Where an API returns a collection of items it often supports sorting of API
responses.
Expand Down
4 changes: 2 additions & 2 deletions content/guides/api-calls/status-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ required_guides: []
alias_paths: []
---

# Status Codes
# Status codes

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

| HTTP Status | |
Expand Down
4 changes: 2 additions & 2 deletions content/guides/api-calls/suppress-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ required_guides: []
alias_paths: []
---

# Suppress Notifications
# Suppress notifications

For some API calls, email and webhook notifications can be prevented by
For some API calls, you can block email and webhook notifications by
including a `box-notifications: off` header with the API call.

<Tabs>
Expand Down
2 changes: 1 addition & 1 deletion content/guides/api-calls/types-and-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ alias_paths:
- /docs/object-model
---

# Types & Formats
# Types and formats

The following sections explain some basic concepts about the types and formats
that can be encountered within the Box APIs.
Expand Down
2 changes: 1 addition & 1 deletion content/microcopy/headers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ secondary:
// display: |-
A boolean that determines whether to show the orange notification bar
in the header. Must be "true" or "false"
display: "true"
display: "false"

// message: |-
The content of the notification
Expand Down
Loading