Skip to content

Commit 006fdb2

Browse files
superojlasuperojla
committed
Merge branch 'main' of github.com:box/developer.box.com into staging
2 parents 8339ed9 + 98a4422 commit 006fdb2

File tree

12 files changed

+49
-34
lines changed

12 files changed

+49
-34
lines changed

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,25 @@ Box can issue a new breaking change to API endpoints **once** per year, reservin
6767
Each stable version is supported for a minimum of 12 months. This means that when a new version is released, the previous version becomes deprecated and will be available for use, but no new features will be added.
6868
It also means, that a new version cannot be released sooner than every 12 months.
6969

70-
We strongly recommend updating your apps to make requests to the latest stable API version. However, if your app uses a stable version that is no longer supported, then you will get a response with an HTTP error code `400 - Bad Request`. For details, see [Versioning Errors](#versioning-errors).
70+
We strongly recommend updating your apps to make requests to the latest stable API version. However, if your app uses a stable version that is no longer supported, then you will get a response with an HTTP error code `400 - Bad Request`. For details, see [Versioning Errors](g://api-calls/permissions-and-errors/versioning-errors).
7171

7272
If your request doesn't include a version, the API defaults to the initial Box API version—the version available before
7373
year-based versioning was introduced. However, relying on this behavior is not recommended when adopting deprecated
7474
changes. To ensure consistency, always specify the API version, with each request. By making your application
7575
version-aware, you anchor it to a specific set of features, ensuring consistent behavior throughout the supported
7676
timeframe.
7777

78-
### Endpoint marking
78+
### Endpoint versioning indication
7979

80-
To keep you informed about the current API state, and improve the readability of the versioned API reference, the affected endpoints are marked with the following terms:
80+
To keep you informed about the current API state, and improve the readability of the versioned API reference, the affected endpoints are marked with a pill based on the `x-stability-level` tag or `deprecated` attribute.
8181

82-
* **Beta**: Endpoints marked with **beta**, are offered subject to Box’s Main Beta Agreement, meaning the available capabilities may change at any time. Although beta endpoints not the same as versioned endpoints, they are a part of API lifecycle.
82+
![An example of a beta pill used for API reference endpoints](./images/api-versioning-pills.png)
8383

84-
* **Latest version**: The latest version applies to APIs that are already versioned. **Latest version** marks the most recent API version of an endpoint.
85-
86-
* **Deprecated**: If a version is deprecated, it is still available for use, but no new features are added. Such a version is marked with **Deprecated**.
84+
| Schema element | Pill name | Description|
85+
|---------------------|-----------|------------|
86+
| `x-stability-level: beta` | Beta | Endpoints marked with **beta**, are offered subject to Box’s Main Beta Agreement, meaning the available capabilities may change at any time. Although beta endpoints not the same as versioned endpoints, they are a part of API lifecycle. |
87+
|`x-stability-level: stable` or no `x-stability-level` tag | Latest version | The latest version applies to APIs that are already versioned. **Latest version** marks the most recent stable API version of an endpoint.|
88+
| `deprecated: true` | Deprecated | An endpoint is deprecated, which means it is still available for use, but no new features are added. Such an endpoint is annotated with the `deprecated` attribute set to `true`.|
8789

8890
## Calling an API version
8991

‎content/guides/api-calls/images/api-versioning-pills.png‎

34.6 KB
Loading

‎content/guides/box-ai/ai-agents/get-agent-default-config.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To send a request, use the
2727
`GET /2.0/ai_agent_default` endpoint.
2828

2929
Make sure you have generated the developer token
30-
to authorize your app. See [prerequisites for using Box AI][prereq]
30+
to authorize your app. See [getting started with Box AI][prereq]
3131
for details.
3232

3333
<Samples id='get_ai_agent_default' />

‎content/guides/box-ai/ai-tutorials/ask-questions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ you can ask Box AI to summarize the content.
2828

2929
## Before you start
3030

31-
Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate.
31+
Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate.
3232

3333
## Send a request
3434

‎content/guides/box-ai/ai-tutorials/default-agent-overrides.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Endpoints related to metadata extraction are currently a beta feature offered su
2323

2424
## Before you start
2525

26-
Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate.
26+
Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate.
2727
To get more context, read about [agent overrides][agent-overrides].
2828

2929
## Override prompt

‎content/guides/box-ai/ai-tutorials/extract-metadata-structured.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To learn more about creating templates, see [Creating metadata templates in the
2626

2727
## Before you start
2828

29-
Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate.
29+
Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate.
3030

3131
## Send a request
3232

‎content/guides/box-ai/ai-tutorials/extract-metadata.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Box AI API allows you to query a document and extract metadata based on a provid
2424

2525
## Before you start
2626

27-
Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate.
27+
Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate.
2828

2929
## Send a request
3030

‎content/guides/box-ai/ai-tutorials/generate-text.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ based on provided content.
2828

2929
## Before you start
3030

31-
Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate.
31+
Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate.
3232

3333
## Send a request
3434

‎content/guides/embed/box-embed.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To fetch the Box Embed widget code from the Box web app, perform the following s
3434

3535
1. Navigate to the chosen Hub.
3636
2. Click on the ellipsis menu in the top right corner.
37-
3. Click **Embed Widget**.
37+
3. Click **Embed Hub**.
3838

3939
<ImageFrame border>
4040
![Box Embed](./box-embed-new.png)

‎content/guides/embed/ui-elements/explorer.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -352,8 +352,9 @@ function App() {
352352
353353
// Define metadata source
354354
// Example: enterprise_123456789.metadatatemplate
355-
const metadataSource = `metadata.enterprise_${EID}.${templateName}`;
356-
355+
const metadataSource = `enterprise_${EID}.${templateName}`;
356+
const metadataSourceFieldName = `metadata.${metadataSource}`;
357+
357358
const metadataQuery = {
358359
from: metadataSource,
359360
@@ -368,22 +369,22 @@ function App() {
368369
369370
// Define which other metadata fields you'd like to display
370371
fields: [
371-
`${metadataSource}.name`,
372-
`${metadataSource}.last_contacted_at`,
373-
`${metadataSource}.industry`,
374-
`${metadataSource}.role`,
372+
`${metadataSourceFieldName}.name`,
373+
`${metadataSourceFieldName}.last_contacted_at`,
374+
`${metadataSourceFieldName}.industry`,
375+
`${metadataSourceFieldName}.role`,
375376
],
376377
};
377378
378379
// The metadata fields/columns to view - must be valid field names from the metadata template
379380
const fieldsToShow = [
380381
// Determine if the user can edit the metadata directly from Content Explorer component
381-
{ key: `${metadataSource}.name`, canEdit: false },
382+
{ key: `${metadataSourceFieldName}.name`, canEdit: false },
382383
383384
// Determine label alias on metadata column with displayName prop
384-
{ key: `${metadataSource}.industry`, canEdit: false, displayName: "alias" },
385-
{ key: `${metadataSource}.last_contacted_at`, canEdit: true },
386-
{ key: `${metadataSource}.role`, canEdit: true },
385+
{ key: `${metadataSourceFieldName}.industry`, canEdit: false, displayName: "alias" },
386+
{ key: `${metadataSourceFieldName}.last_contacted_at`, canEdit: true },
387+
{ key: `${metadataSourceFieldName}.role`, canEdit: true },
387388
];
388389
389390
// defaultView - a required prop to paint the metadata view.

0 commit comments

Comments
 (0)