diff --git a/content/guides/api-calls/permissions-and-errors/scopes.md b/content/guides/api-calls/permissions-and-errors/scopes.md index 790b6a154..eb28b3ff4 100644 --- a/content/guides/api-calls/permissions-and-errors/scopes.md +++ b/content/guides/api-calls/permissions-and-errors/scopes.md @@ -325,19 +325,19 @@ The standard OAuth scopes are also supported when downscoping. [console]: https://app.box.com/developers/console [ui-elements]: https://github.com/box/box-ui-elements [pricing]: https://www.box.com/pricing/platform -[reference]: https://developer.box.com/reference +[reference]: page://reference [at]: g://authentication/tokens [security]: g://security [jwt]: g://authentication/jwt -[mu]:page://platform/user-types/#managed-users +[mu]: page://platform/user-types/#managed-users [au]: g://authentication/jwt/as-user [uat]: g://authentication/jwt/user-access-tokens [appaccess]: g://authentication/jwt/jwt-setup/#application-access -[appu]:page://platform/user-types/#app-user +[appu]: page://platform/user-types/#app-user [governance]: https://www.box.com/security/governance-and-compliance [suppress]: g://api-calls/suppress-notifications [ds]: g://authentication/tokens/downscope -[sa]:page://platform/user-types/#service-account \ No newline at end of file +[sa]: page://platform/user-types/#service-account \ No newline at end of file diff --git a/content/guides/api-calls/permissions-and-errors/versioning-errors.md b/content/guides/api-calls/permissions-and-errors/versioning-errors.md index 2bb68a1bf..715d7d798 100644 --- a/content/guides/api-calls/permissions-and-errors/versioning-errors.md +++ b/content/guides/api-calls/permissions-and-errors/versioning-errors.md @@ -11,7 +11,7 @@ Box provides versioning capabilities for selected API endpoints. The version con API versioning empowers Box to continually enhance its platform, while also offering third-party developers a reliable avenue for feature updates and deprecations. -To stay informed about the API modifications, monitor the [Changelog](https://developer.box.com/changelog/) and maintain a current email address in the **App Info** section of the Developer Console. +To stay informed about the API modifications, monitor the [Changelog](page://changelog) and maintain a current email address in the **App Info** section of the Developer Console. ## Error examples diff --git a/content/guides/applications/app-types/custom-apps.md b/content/guides/applications/app-types/custom-apps.md index 22841869b..093e3ffd5 100644 --- a/content/guides/applications/app-types/custom-apps.md +++ b/content/guides/applications/app-types/custom-apps.md @@ -66,6 +66,6 @@ Custom Apps may require approval before use. [oauth2]: g://authentication/oauth2 [jwt]: g://authentication/jwt -[cc]: g://authentication/client-credentials/ -[uie]: g://embed/ui-elements/ +[cc]: g://authentication/client-credentials +[uie]: g://embed/ui-elements [users]: g;//getting-started/user-types/#managed-users/ diff --git a/content/guides/applications/app-types/index.md b/content/guides/applications/app-types/index.md index ecd864d7f..1478ef57c 100644 --- a/content/guides/applications/app-types/index.md +++ b/content/guides/applications/app-types/index.md @@ -35,6 +35,6 @@ create. [devtoken]: g://authentication/tokens/developer-tokens [custom-apps]: g://applications/app-types/custom-apps [custom-skills]: g://applications/app-types/custom-skills -[ccg]: g://authentication/client-credentials/ -[laa]: g://applications/app-types/limited-access-apps/ +[ccg]: g://authentication/client-credentials +[laa]: g://applications/app-types/limited-access-apps [insights]: https://support.box.com/hc/en-us/articles/20738406915219-Platform-Insights \ No newline at end of file diff --git a/content/guides/applications/app-types/limited-access-apps.md b/content/guides/applications/app-types/limited-access-apps.md index e553a2675..519f338c2 100644 --- a/content/guides/applications/app-types/limited-access-apps.md +++ b/content/guides/applications/app-types/limited-access-apps.md @@ -12,7 +12,7 @@ with a [limited number of endpoints][limited]. ## Authentication methods -Limited Access Apps only support App Token authentication. +Limited Access Apps only support App Token authentication. Learn more about App Tokens @@ -20,7 +20,7 @@ Limited Access Apps only support App Token authentication. ## When to use -A Limited Access App is best used when the application: +A Limited Access App is best used when the application: - wants to use Box View or only Box's preview services - only needs to access a [limited number of endpoints][limited] @@ -33,11 +33,11 @@ A Limited Access App is best used when the application: ## Approval -Limited Access Apps may require approval before use. +Limited Access Apps may require approval before use. Learn how to approve Limited Access Apps -[bv]: g://embed/box-view/ +[bv]: g://embed/box-view [limited]: g://authentication/app-token/endpoints \ No newline at end of file diff --git a/content/guides/applications/web-app-integrations/configure.md b/content/guides/applications/web-app-integrations/configure.md index 6fe666191..9fd052a53 100644 --- a/content/guides/applications/web-app-integrations/configure.md +++ b/content/guides/applications/web-app-integrations/configure.md @@ -143,8 +143,8 @@ Center. Follow the [Integrations][integrations] guide for more details. [ca]: g://applications/app-types/custom-apps [pu]: g://applications/web-app-integrations/types -[uid]:page://platform/appendix/locating-values/#user-ids -[fid]:page://platform/appendix/locating-values/#content-ids +[uid]: page://platform/appendix/locating-values/#user-ids +[fid]: page://platform/appendix/locating-values/#content-ids [code]: g://authentication/oauth2/without-sdk/#3-user-grants-application-access [custom-oauth2]: g://authentication/oauth2/oauth2-setup [devconsole]: https://app.box.com/developers/console diff --git a/content/guides/authentication/best-practices.md b/content/guides/authentication/best-practices.md index 210b0c51c..de12a8a05 100644 --- a/content/guides/authentication/best-practices.md +++ b/content/guides/authentication/best-practices.md @@ -84,5 +84,5 @@ enhancements. Developer Tokens should only be used for development or testing purposes and never in production. -[downscope]: g://authentication/tokens/downscope/ -[revoke]: g://authentication/tokens/revoke/ +[downscope]: g://authentication/tokens/downscope +[revoke]: g://authentication/tokens/revoke diff --git a/content/guides/authentication/client-credentials/index.md b/content/guides/authentication/client-credentials/index.md index 23e66fa77..842d1a043 100644 --- a/content/guides/authentication/client-credentials/index.md +++ b/content/guides/authentication/client-credentials/index.md @@ -80,7 +80,7 @@ This error indicates either: - the client ID and client secret passed are incorrect or are not for the same application, -- the `box_subject_id` cannot be used based on the selected [application access][aa]. +- the `box_subject_id` cannot be used based on the selected [application access][aa]. @@ -105,8 +105,8 @@ Once you make changes to the app settings, don't forget to [reauthorize][reauth] [devconsole]: https://app.box.com/developers/console -[accesstoken]: e://post-oauth2-token/ -[sa]: page://platform/user-types/#service-account/ +[accesstoken]: e://post-oauth2-token +[sa]: page://platform/user-types/#service-account [auth]: g://authorization [aa]: g://authentication/client-credentials/client-credentials-setup/#application-access [reauth]: g://authorization/custom-app-approval#re-authorization-on-changes diff --git a/content/guides/authentication/oauth2/without-sdk.md b/content/guides/authentication/oauth2/without-sdk.md index 14d08e39f..c05bda81e 100644 --- a/content/guides/authentication/oauth2/without-sdk.md +++ b/content/guides/authentication/oauth2/without-sdk.md @@ -318,11 +318,11 @@ To learn how to use an Access Token visit our guide on [Making API calls][apic]. -[auth]: e://get-authorize/ +[auth]: e://get-authorize [ci]: e://get-authorize/#param-client_id [re]: e://get-authorize/#param-redirect_uri [co]: e://get-authorize/#param-response_type [st]: e://get-authorize/#param-state [thirty]: g://api-calls/permissions-and-errors/expiration -[at]: e://post-oauth2-token/ -[apic]: g://api-calls/ +[at]: e://post-oauth2-token +[apic]: g://api-calls diff --git a/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md b/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md index 14d52b8c3..8fac3d20a 100644 --- a/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md +++ b/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md @@ -20,7 +20,7 @@ Endpoints related to metadata extraction are currently a beta feature offered su With Box AI API, you can extract metadata from the provided file -and get the result in the form of key-value pairs. +and get the result in the form of key-value pairs. As input, you can either create a structure using the `fields` parameter, or use an already defined metadata template. To learn more about creating templates, see [Creating metadata templates in the Admin Console][templates-console] or use the [metadata template API][templates-api]. @@ -114,7 +114,7 @@ You can use either `fields` or `metadata_template` to specify your structure, bu ### Use `fields` parameter -The `fields` parameter allows you to specify the data you want to extract. Each `fields` object has a subset of parameters you can use to add more information about the searched data. +The `fields` parameter allows you to specify the data you want to extract. Each `fields` object has a subset of parameters you can use to add more information about the searched data. For example, you can add the field type, description, or even a prompt with some additional context. ```bash @@ -216,5 +216,5 @@ The response lists the fields included in the metadata template and their values [templates-console]: https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates [templates-api]: g://metadata/templates/create [overrides]: g://box-ai/ai-agents/ai-agent-overrides -[changelog]: https://developer.box.com/changelog/ +[changelog]: page://changelog [blog]: https://medium.com/box-developer-blog \ No newline at end of file diff --git a/content/guides/box-relay/index.md b/content/guides/box-relay/index.md index c4796b843..edf380ff6 100644 --- a/content/guides/box-relay/index.md +++ b/content/guides/box-relay/index.md @@ -5,13 +5,13 @@ rank: 223 # Box Relay [Box Relay][boxrelay] is a workflow automation application that enables Box -power users to automate and accelerate business processes centered -around content. Currently, there are two API [endpoints][workflow] developers -can use with more planned to be released in the future. Both were created to -work directly with [manual start flows][manualstart]. +power users to automate and accelerate business processes centered +around content. Currently, there are two API [endpoints][workflow] developers +can use with more planned to be released in the future. Both were created to +work directly with [manual start flows][manualstart]. - For more information on how to use these endpoints, refer to our [blog][blog] + For more information on how to use these endpoints, refer to our [blog][blog] post. @@ -38,7 +38,7 @@ Please see our [rate limit guide][ratelimit] for more information. Due to the feature parity, it may be useful to familiarize yourself with [Box Relay functionality using the Box web app][webapp] before leveraging the -API. As with all API endpoints, we recommend testing via +API. As with all API endpoints, we recommend testing via [developer sandbox environment][sandbox] to eliminate the risk of impacting production content. @@ -53,7 +53,7 @@ production content. [relay]: g://api-calls/permissions-and-errors/scopes/#manage-box-relay [boxrelay]: https://support.box.com/hc/en-us/articles/360044196213-Introducing-Box-Relay -[workflow]: https://developer.box.com/reference/resources/workflow/ +[workflow]: resource://workflow [manualstart]: https://support.box.com/hc/en-us/articles/360044628853-Creating-and-Running-a-Manual-Start-Workflow [blog]: https://medium.com/box-developer-blog/manual-start-workflow-api-box-relay-4f8d0f51b7a4 diff --git a/content/guides/box-sign/create-sign-request.md b/content/guides/box-sign/create-sign-request.md index a3f771390..4415f9bd0 100644 --- a/content/guides/box-sign/create-sign-request.md +++ b/content/guides/box-sign/create-sign-request.md @@ -187,7 +187,7 @@ Encountering an error status requires creating a new sign request to retry. ![Status diagram](images/status.png) -[upload]: e://post-files-content/ +[upload]: e://post-files-content [documents]: g://representations/supported-file-types/#documents [presentations]: g://representations/supported-file-types/#presentations [uploads]: g://uploads/direct diff --git a/content/guides/cli/cli-docs/jwt-cli.md b/content/guides/cli/cli-docs/jwt-cli.md index dc93ecba4..25c8ccde0 100644 --- a/content/guides/cli/cli-docs/jwt-cli.md +++ b/content/guides/cli/cli-docs/jwt-cli.md @@ -197,23 +197,23 @@ Notification Email: [] - You can also go to the second part of the [OAuth 2.0 Quick Start][three] for a tutorial on how to use the commands. [cli]: https://github.com/box/boxcli -[auth]: g://authentication/jwt/without-sdk/ -[at]: g://authentication/tokens/ +[auth]: g://authentication/jwt/without-sdk +[at]: g://authentication/tokens [dc]: https://account.box.com/developers/console [keypair]: g://authentication/jwt/jwt-setup/#public-and-private-key-pair -[sa]: page://platform/user-types/#service-account/ -[scopes]: g://api-calls/permissions-and-errors/scopes/ -[ag]: g://authorization/custom-app-approval/ +[sa]: page://platform/user-types/#service-account +[scopes]: g://api-calls/permissions-and-errors/scopes +[ag]: g://authorization/custom-app-approval [blogpost]: https://medium.com/box-developer-blog/box-api-understanding-security-9fcad7b1d72e -[scopes]: g://api-calls/permissions-and-errors/scopes/ +[scopes]: g://api-calls/permissions-and-errors/scopes [aa]: g://authentication/jwt/jwt-setup/#application-access -[three]: g://cli/quick-start/build-commands-help/ -[four]: g://cli/quick-start/options-and-bulk-commands/ +[three]: g://cli/quick-start/build-commands-help +[four]: g://cli/quick-start/options-and-bulk-commands [cache]: https://github.com/box/boxcli/blob/master/docs/configure.md#box-configureenvironmentsupdate-name [ac]: https://github.com/box/boxcli/blob/master/docs/autocomplete.md [commands]: https://github.com/box/boxcli#command-topics -[qs]: g://cli/quick-start/ +[qs]: g://cli/quick-start diff --git a/content/guides/cli/index.md b/content/guides/cli/index.md index ac93744eb..fa29b04db 100644 --- a/content/guides/cli/index.md +++ b/content/guides/cli/index.md @@ -57,7 +57,7 @@ advanced CLI user. [cli-autocomplete]: https://github.com/box/boxcli/blob/main/docs/autocomplete.md [cli-switch]: https://github.com/box/boxcli/blob/main/docs/configure.md#box-configureenvironmentsswitch-user-userid [cli-add-config]: https://github.com/box/boxcli/blob/main/docs/configure.md#box-configureenvironmentsadd-path -[qs]: g://cli/quick-start/ +[qs]: g://cli/quick-start [cache]: https://github.com/box/boxcli/blob/main/docs/configure.md#box-configureenvironmentsupdate-name [jwt]: g://authentication/jwt [jwt-page]: g://cli/cli-docs/jwt-cli diff --git a/content/guides/cli/quick-start/0-index.md b/content/guides/cli/quick-start/0-index.md index 241f1a4ee..edbe4a98b 100644 --- a/content/guides/cli/quick-start/0-index.md +++ b/content/guides/cli/quick-start/0-index.md @@ -36,9 +36,9 @@ This guide will take you through the following steps. [commands]: https://github.com/box/boxcli#command-topics -[one]: g://cli/quick-start/create-oauth-app/ -[two]: g://cli/quick-start/install-and-configure/ -[three]: g://cli/quick-start/build-commands-help/ -[four]: g://cli/quick-start/options-and-bulk-commands/ -[five]: g://cli/quick-start/powershell-script-templates/ -[six]: g://cli/quick-start/next-steps/ +[one]: g://cli/quick-start/create-oauth-app +[two]: g://cli/quick-start/install-and-configure +[three]: g://cli/quick-start/build-commands-help +[four]: g://cli/quick-start/options-and-bulk-commands +[five]: g://cli/quick-start/powershell-script-templates +[six]: g://cli/quick-start/next-steps diff --git a/content/guides/cli/quick-start/1-create-oauth-app.md b/content/guides/cli/quick-start/1-create-oauth-app.md index f03db6ed2..02d085bb7 100644 --- a/content/guides/cli/quick-start/1-create-oauth-app.md +++ b/content/guides/cli/quick-start/1-create-oauth-app.md @@ -115,4 +115,4 @@ extra steps to set up. [devconsole]: https://cloud.app.box.com/developers/console [signup]: https://account.box.com/signup/n/developer -[scopes]: https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/ +[scopes]: g://api-calls/permissions-and-errors/scopes diff --git a/content/guides/cli/quick-start/2-install-and-configure.md b/content/guides/cli/quick-start/2-install-and-configure.md index 2d6bb8f7c..24b65191e 100644 --- a/content/guides/cli/quick-start/2-install-and-configure.md +++ b/content/guides/cli/quick-start/2-install-and-configure.md @@ -122,7 +122,7 @@ Notification Email: [] [cli]: https://github.com/box/boxcli -[auth]: g://authentication/jwt/without-sdk/ -[sa]: page://platform/user-types/#service-account/ -[at]: g://authentication/tokens/ +[auth]: g://authentication/jwt/without-sdk +[sa]: page://platform/user-types/#service-account +[at]: g://authentication/tokens [dc]: https://app.box.com/developers/console diff --git a/content/guides/cli/quick-start/4-options-and-bulk-commands.md b/content/guides/cli/quick-start/4-options-and-bulk-commands.md index 70f753c7b..e02f820f3 100644 --- a/content/guides/cli/quick-start/4-options-and-bulk-commands.md +++ b/content/guides/cli/quick-start/4-options-and-bulk-commands.md @@ -90,6 +90,6 @@ For more details on bulk commands read [this document][bulk]. [github]: https://github.com/box/boxcli#command-topics [df]: https://github.com/box/boxcli/blob/master/docs/folders.md#box-foldersdelete-id -[asuser]: g://authentication/jwt/as-user/ +[asuser]: g://authentication/jwt/as-user [csv]: https://github.com/box/boxcli/blob/main/docs/Bulk%20actions/folders/folders-create.csv [bulk]: g://cli/cli-docs/bulk-commands diff --git a/content/guides/cli/quick-start/5-powershell-script-templates.md b/content/guides/cli/quick-start/5-powershell-script-templates.md index b4bf33833..3de2e6a23 100644 --- a/content/guides/cli/quick-start/5-powershell-script-templates.md +++ b/content/guides/cli/quick-start/5-powershell-script-templates.md @@ -308,7 +308,7 @@ Make sure to explore our other [sample scripts][samples] for more use cases. [script-1]: https://github.com/box/boxcli/tree/main/examples/User%20Creation%20&%20Provisioning [jwt-cli]: g://cli/cli-docs/jwt-cli [pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2 -[step 1]: g://cli/quick-start/create-oauth-app/ +[step 1]: g://cli/quick-start/create-oauth-app [console]: https://app.box.com/developers/console [auth]: g://authentication/oauth2/oauth2-setup [samples]: g://cli/scripts diff --git a/content/guides/cli/quick-start/6-next-steps.md b/content/guides/cli/quick-start/6-next-steps.md index e69ce9385..b92662e73 100644 --- a/content/guides/cli/quick-start/6-next-steps.md +++ b/content/guides/cli/quick-start/6-next-steps.md @@ -22,12 +22,12 @@ To take the next step, the following resources are recommended: 3. Review [autocomplete][ac] settings. 4. Review all of the [CLI sample scripts][sample-scripts]. -[one]: g://cli/quick-start/create-oauth-app/ -[two]: g://cli/quick-start/install-and-configure/ -[three]: g://cli/quick-start/build-commands-help/ -[four]: g://cli/quick-start/options-and-bulk-commands/ -[five]: g://cli/quick-start/powershell-script-templates/ +[one]: g://cli/quick-start/create-oauth-app +[two]: g://cli/quick-start/install-and-configure +[three]: g://cli/quick-start/build-commands-help +[four]: g://cli/quick-start/options-and-bulk-commands +[five]: g://cli/quick-start/powershell-script-templates [cache]: https://github.com/box/boxcli/blob/master/docs/configure.md#box-configureenvironmentsupdate-name [ac]: https://github.com/box/boxcli/blob/master/docs/autocomplete.md [commands]: https://github.com/box/boxcli#command-topics -[sample-scripts]: https://developer.box.com/guides/cli/scripts/ +[sample-scripts]: g://cli/scripts diff --git a/content/guides/cli/scripts/deprovision-users.md b/content/guides/cli/scripts/deprovision-users.md index bd45b6035..d5c93feda 100644 --- a/content/guides/cli/scripts/deprovision-users.md +++ b/content/guides/cli/scripts/deprovision-users.md @@ -170,7 +170,7 @@ You have access to these log files: [scripts]: https://github.com/box/boxcli/tree/main/examples [pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2 -[quickstart]: g://cli/quick-start/create-oauth-app/ +[quickstart]: g://cli/quick-start/create-oauth-app [console]: https://app.box.com/developers/console [auth]: g://authentication/oauth2/oauth2-setup [examples]:https://github.com/box/boxcli/tree/main/examples/User%20Deprovisioning diff --git a/content/guides/cli/scripts/index.md b/content/guides/cli/scripts/index.md index 5bbaa25b3..4e565bdf5 100644 --- a/content/guides/cli/scripts/index.md +++ b/content/guides/cli/scripts/index.md @@ -39,6 +39,6 @@ get that done. [4]: g://cli/scripts/report-inactive-users [5]: g://cli/scripts/metadata-extraction [6]: g://cli/scripts/user-zones-mass-update -[quickstart]: g://cli/quick-start/create-oauth-app/ +[quickstart]: g://cli/quick-start/create-oauth-app [7]: https://support.box.com/hc/en-us/articles/360043694174-Understanding-Administrator-and-Co-Administrator-Permissions [8]: g://cli/scripts/slack-integration-mappings \ No newline at end of file diff --git a/content/guides/cli/scripts/manage-groups-collaborations.md b/content/guides/cli/scripts/manage-groups-collaborations.md index c67b023fe..e1f93050d 100644 --- a/content/guides/cli/scripts/manage-groups-collaborations.md +++ b/content/guides/cli/scripts/manage-groups-collaborations.md @@ -170,6 +170,6 @@ You have access to these log files: [examples]: https://github.com/box/boxcli/tree/main/examples [pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2 -[quickstart]: g://cli/quick-start/create-oauth-app/ +[quickstart]: g://cli/quick-start/create-oauth-app [console]: https://app.box.com/developers/console [auth]: g://authentication/oauth2/oauth2-setup \ No newline at end of file diff --git a/content/guides/cli/scripts/metadata-extraction.md b/content/guides/cli/scripts/metadata-extraction.md index 707ad583f..47de34ff6 100644 --- a/content/guides/cli/scripts/metadata-extraction.md +++ b/content/guides/cli/scripts/metadata-extraction.md @@ -116,7 +116,7 @@ You have access to these log files: [scripts]: https://github.com/box/boxcli/tree/main/examples [pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2 -[quickstart]: g://cli/quick-start/create-oauth-app/ +[quickstart]: g://cli/quick-start/create-oauth-app [console]: https://app.box.com/developers/console [auth]: g://authentication/oauth2/oauth2-setup [examples]:https://github.com/box/boxcli/tree/main/examples/Metadata%20Extraction \ No newline at end of file diff --git a/content/guides/cli/scripts/report-inactive-users.md b/content/guides/cli/scripts/report-inactive-users.md index 1863090eb..5ce9035be 100644 --- a/content/guides/cli/scripts/report-inactive-users.md +++ b/content/guides/cli/scripts/report-inactive-users.md @@ -128,8 +128,8 @@ You have access to these log files: [scripts]: https://github.com/box/boxcli/tree/main/examples [pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2 -[quickstart]: g://cli/quick-start/create-oauth-app/ -[boxevents]: https://developer.box.com/reference/resources/event/ +[quickstart]: g://cli/quick-start/create-oauth-app +[boxevents]: resource://event [deprovisionscript]: g://cli/scripts/deprovision-users [console]: https://app.box.com/developers/console [auth]: g://authentication/oauth2/oauth2-setup diff --git a/content/guides/cli/scripts/slack-integration-mappings.md b/content/guides/cli/scripts/slack-integration-mappings.md index 3198a8adf..e4192b08b 100644 --- a/content/guides/cli/scripts/slack-integration-mappings.md +++ b/content/guides/cli/scripts/slack-integration-mappings.md @@ -140,7 +140,7 @@ Logs are stored in a `logs` folder located in the main folder. You have access t This project is a collection of open source examples and should not be treated as an officially supported product. Use at your own risk and as a source of example how to use Box CLI. [pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2 -[oauth-guide]: https://developer.box.com/guides/cli/quick-start/ +[oauth-guide]: g://cli/quick-start [install-slack]: https://support.box.com/hc/en-us/articles/360044195313-Installing-and-Using-the-Box-for-Slack-Integration [content-layer]: https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack [1]: https://github.com/box/boxcli/tree/main/examples/Integration%20Mappings \ No newline at end of file diff --git a/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md b/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md index e01bd1b71..aaa017bb7 100644 --- a/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md +++ b/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md @@ -48,7 +48,7 @@ collaborators to files and folders in Box. Once the application is created it will still need to be approved by an enterprise admin before you will be able to make calls to the Box APIs. - Follow [this guide](g://authorization/custom-app-approval/) to have the + Follow [this guide](g://authorization/custom-app-approval) to have the application approved in your enterprise. @@ -76,7 +76,7 @@ collaborators to files and folders in Box. enterprise admin before you will be able to make calls to any of the Box APIs that need any of the new permissions. - Follow [this guide](g://authorization/custom-app-approval/) to have the + Follow [this guide](g://authorization/custom-app-approval) to have the application approved in your enterprise. diff --git a/content/guides/embed/box-view/create-preview.md b/content/guides/embed/box-view/create-preview.md index 14357e803..b754b2948 100644 --- a/content/guides/embed/box-view/create-preview.md +++ b/content/guides/embed/box-view/create-preview.md @@ -118,7 +118,7 @@ attribute set to generated embed URL. ## Customized Previewer (UI Elements) To leverage advanced preview customization and event handling capabilities, use -the Box [UI Preview Element](guide://embed/ui-elements/preview/). +the Box [UI Preview Element](guide://embed/ui-elements/preview). To set up the Preview Element, start by installing the required components. diff --git a/content/guides/embed/box-view/faq.md b/content/guides/embed/box-view/faq.md index 6553a5733..513bb7bcf 100644 --- a/content/guides/embed/box-view/faq.md +++ b/content/guides/embed/box-view/faq.md @@ -65,7 +65,7 @@ the subdomain (`https://*.domain.com`). See the **How can I replace the Box logo that shows up on preview?** See this guide for information on customizing the logo within a -[Preview UI Element](g://embed/ui-elements/logo/). +[Preview UI Element](g://embed/ui-elements/logo). [file_types]: https://support.box.com/hc/en-us/articles/360043695794-Viewing-Different-File-Types-Supported-in-Box-Content-Preview diff --git a/content/guides/embed/box-view/setup.md b/content/guides/embed/box-view/setup.md index 53933fca8..073e8cfc8 100644 --- a/content/guides/embed/box-view/setup.md +++ b/content/guides/embed/box-view/setup.md @@ -30,7 +30,7 @@ to begin making API requests to Box. App Token apps need to be authorized by the Box admin, otherwise you will receive permission errors when making API requests. To go through app - authorization, follow [this guide](guide://authorization/custom-app-approval/). + authorization, follow [this guide](guide://authorization/custom-app-approval). ## Generate Access Token diff --git a/content/guides/embed/box-view/upload-file.md b/content/guides/embed/box-view/upload-file.md index 8d91b8578..502506464 100644 --- a/content/guides/embed/box-view/upload-file.md +++ b/content/guides/embed/box-view/upload-file.md @@ -18,7 +18,7 @@ long as the original file is stored in Box. ## Uploading a File -To upload a file using the [Box SDKs](pages://sdks-and-tools/) or directly with +To upload a file using the [Box SDKs](pages://sdks-and-tools) or directly with the APIs, you need to use the client ID and App Token that are generated during [application setup](guide://embed/box-view/setup) to authenticate your application. diff --git a/content/guides/embed/ui-elements/open-with.md b/content/guides/embed/ui-elements/open-with.md index e5b408881..b106fd7d7 100644 --- a/content/guides/embed/ui-elements/open-with.md +++ b/content/guides/embed/ui-elements/open-with.md @@ -146,7 +146,7 @@ curl -X GET \ To add an app integration to a valid app user, three pieces of information are required: -- A valid [Service Account](page://platform/user-types/#service-account/) Access Token. +- A valid [Service Account](page://platform/user-types/#service-account) Access Token. - The ID of the app user to be assigned the integration - The ID of the app integration to assign to the user @@ -401,4 +401,4 @@ using `openWith.addListener('execute', callback)` and [safari]: https://support.box.com/hc/en-us/articles/360043697334-Installing-Box-Tools -[service-account]: page://platform/user-types/#service-account/ +[service-account]: page://platform/user-types/#service-account diff --git a/content/guides/events/event-triggers/shield-alert-events.md b/content/guides/events/event-triggers/shield-alert-events.md index c66940677..c92d1a7b3 100644 --- a/content/guides/events/event-triggers/shield-alert-events.md +++ b/content/guides/events/event-triggers/shield-alert-events.md @@ -345,4 +345,4 @@ The `additional_details` payload will provide the following details: [smartaccess]: https://support.box.com/hc/en-us/articles/360044196353-Using-Smart-Access [monitoringmode]: https://support.box.com/hc/en-us/articles/360044196353 -[events]: g://events/enterprise-events/for-enterprise/ +[events]: g://events/enterprise-events/for-enterprise diff --git a/content/guides/events/event-triggers/shield-smart-access-events.md b/content/guides/events/event-triggers/shield-smart-access-events.md index 860328edc..d95e74949 100644 --- a/content/guides/events/event-triggers/shield-smart-access-events.md +++ b/content/guides/events/event-triggers/shield-smart-access-events.md @@ -468,4 +468,4 @@ The `additional_details` payload will provide the following details: [smartaccess]: https://support.box.com/hc/en-us/articles/7711416297747-About-Smart-Access [monitoringmode]: https://support.box.com/hc/en-us/articles/14596333776403-Shield-Access-Policy-Settings -[events]: g://events/enterprise-events/for-enterprise/ +[events]: g://events/enterprise-events/for-enterprise diff --git a/content/guides/file-requests/1-template.md b/content/guides/file-requests/1-template.md index d8689ba5e..39f689ec7 100644 --- a/content/guides/file-requests/1-template.md +++ b/content/guides/file-requests/1-template.md @@ -27,7 +27,7 @@ A folder can be created through the Box web or mobile interface, or through the When using server-side JWT authentication, we recommend creating folder that is owned by the application's -[Service Account](page://platform/user-types/#service-account/). This way, +[Service Account](page://platform/user-types/#service-account). This way, the folder can't be accidentally deleted by a regular Box user. diff --git a/content/guides/folders/single/delete-lock.md b/content/guides/folders/single/delete-lock.md index 5b0589b6a..558260faf 100644 --- a/content/guides/folders/single/delete-lock.md +++ b/content/guides/folders/single/delete-lock.md @@ -29,6 +29,6 @@ To remove a lock applied to a folder in Box, call the To delete a folder lock you must supply the folder lock ID to the API. A folder lock ID is supplied in the response when - [creating a folder lock](g://folders/single/create-lock/), or - when [listing locks](g://folders/single/get-locks/) on a given folder. + [creating a folder lock](g://folders/single/create-lock), or + when [listing locks](g://folders/single/get-locks) on a given folder. \ No newline at end of file diff --git a/content/guides/getting-started/first-application.md b/content/guides/getting-started/first-application.md index d60876957..819c539f6 100644 --- a/content/guides/getting-started/first-application.md +++ b/content/guides/getting-started/first-application.md @@ -89,5 +89,5 @@ You can also use [Box CLI tool][box-cli] if you prefer to use the terminal. [integrations]: https://cloud.app.box.com/integrations [dev-token]: g://authentication/tokens/developer-tokens/#create-developer-token [postman-collection]: g://tooling/postman -[api-ref]: https://developer.box.com/reference/ +[api-ref]: page://reference [box-cli]: https://github.com/box/boxcli diff --git a/content/guides/getting-started/index.md b/content/guides/getting-started/index.md index 2e0ae4e71..67079f8ae 100644 --- a/content/guides/getting-started/index.md +++ b/content/guides/getting-started/index.md @@ -41,16 +41,16 @@ If you have any questions, checkout our [forum][forum-link]. [learn]: page://platform -[box-platform-101]: p://platform/box-platform-101 -[use-case]: p://platform/use-cases -[user-types]: p://platform/user-types -[application-types]: p://platform/application-types -[authentication]: p://platform/authentication-methods -[support]: p://platform/support -[tooling]: p://platform/tools +[box-platform-101]: page://platform/box-platform-101 +[use-case]: page://platform/use-cases +[user-types]: page://platform/user-types +[application-types]: page://platform/application-types +[authentication]: page://platform/authentication-methods +[support]: page://platform/support +[tooling]: page://platform/tools [box-app]: g://getting-started/first-application -[endpoints]: https://developer.box.com/reference/ -[cv]: p://platform/appendix/locating-values +[endpoints]: page://reference +[cv]: page://platform/appendix/locating-values [publish-app]: g://getting-started/publish-app [forum-link]: https://forum.box.com \ No newline at end of file diff --git a/content/guides/integration-mappings/index.md b/content/guides/integration-mappings/index.md index 5f0365122..04e594cbf 100644 --- a/content/guides/integration-mappings/index.md +++ b/content/guides/integration-mappings/index.md @@ -18,5 +18,5 @@ is stored in Box. This feature currently only supports [Box as Content layer for Slack][2]. -[1]: r://integration-mappings/ +[1]: r://integration-mappings [2]: https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack \ No newline at end of file diff --git a/content/guides/metadata/1-quick-start/0-index.md b/content/guides/metadata/1-quick-start/0-index.md index 4280250f7..192f363cc 100644 --- a/content/guides/metadata/1-quick-start/0-index.md +++ b/content/guides/metadata/1-quick-start/0-index.md @@ -20,12 +20,12 @@ additional information to files and folders. This guide will take you through the following steps. -1. [List all templates](g://metadata/quick-start/list-all/) available to you. -2. [Create a custom metadata template](g://metadata/quick-start/create-template/) to hold data specific to your enterprise. -3. [Apply a custom metadata template](g://metadata/quick-start/create-instance/) to a file, allowing you to assign custom data to a file. -4. [Update metadata instance](g://metadata/quick-start/update-instance/) on a file, allowing you to change the data assigned to a file. -5. [Update a metadata template](g://metadata/quick-start/update-template/) and change the data applied to all instances of this template. -6. [Create a query to find files by metadata](g://metadata/quick-start/create-query/) and change the data applied to all instances of this template. +1. [List all templates](g://metadata/quick-start/list-all) available to you. +2. [Create a custom metadata template](g://metadata/quick-start/create-template) to hold data specific to your enterprise. +3. [Apply a custom metadata template](g://metadata/quick-start/create-instance) to a file, allowing you to assign custom data to a file. +4. [Update metadata instance](g://metadata/quick-start/update-instance) on a file, allowing you to change the data assigned to a file. +5. [Update a metadata template](g://metadata/quick-start/update-template) and change the data applied to all instances of this template. +6. [Create a query to find files by metadata](g://metadata/quick-start/create-query) and change the data applied to all instances of this template. I am ready to get started diff --git a/content/guides/metadata/1-quick-start/7-next-steps.md b/content/guides/metadata/1-quick-start/7-next-steps.md index 7a2d490b7..cf990b5b9 100644 --- a/content/guides/metadata/1-quick-start/7-next-steps.md +++ b/content/guides/metadata/1-quick-start/7-next-steps.md @@ -8,12 +8,12 @@ hide_step_number: true You've reached the end of this Quick Start guide. By now you should have taken the following steps. -1. [Listed all templates](g://metadata/quick-start/list-all/) available to you. -2. [Created a custom metadata template](g://metadata/quick-start/create-template/) to hold data specific to your enterprise. -3. [Applied a custom metadata template](g://metadata/quick-start/create-instance/) to a file, allowing you to assign custom data to a file. -4. [Updated a metadata instance](g://metadata/quick-start/update-instance/) on a file, allowing you to change the data assigned to a file. -5. [Updated a metadata template](g://metadata/quick-start/update-template/) and changed the data applied to all instances of this template. -6. [Queried for files and folders](g://metadata/quick-start/create-query/) by matching the values in the metadata instances attached to them. +1. [Listed all templates](g://metadata/quick-start/list-all) available to you. +2. [Created a custom metadata template](g://metadata/quick-start/create-template) to hold data specific to your enterprise. +3. [Applied a custom metadata template](g://metadata/quick-start/create-instance) to a file, allowing you to assign custom data to a file. +4. [Updated a metadata instance](g://metadata/quick-start/update-instance) on a file, allowing you to change the data assigned to a file. +5. [Updated a metadata template](g://metadata/quick-start/update-template) and changed the data applied to all instances of this template. +6. [Queried for files and folders](g://metadata/quick-start/create-query) by matching the values in the metadata instances attached to them. ## Next Steps diff --git a/content/guides/mobile/ios/quick-start/0-index.md b/content/guides/mobile/ios/quick-start/0-index.md index 172b59e59..da5b3b3d6 100644 --- a/content/guides/mobile/ios/quick-start/0-index.md +++ b/content/guides/mobile/ios/quick-start/0-index.md @@ -26,10 +26,10 @@ required: This guide will take you through the following steps. -1. [Create a new iOS app](g://mobile/ios/quick-start/create-ios-app/) in Xcode. -2. [Install the iOS SDK](g://mobile/ios/quick-start/install-ios-sdk/) into your project. -3. [Configure a Box App](g://mobile/ios/quick-start/configure-box-app/) so that the iOS SDK can access the Box API. -4. [Make an API call](g://mobile/ios/quick-start/make-api-call/) to the Box API with the iOS SDK. +1. [Create a new iOS app](g://mobile/ios/quick-start/create-ios-app) in Xcode. +2. [Install the iOS SDK](g://mobile/ios/quick-start/install-ios-sdk) into your project. +3. [Configure a Box App](g://mobile/ios/quick-start/configure-box-app) so that the iOS SDK can access the Box API. +4. [Make an API call](g://mobile/ios/quick-start/make-api-call) to the Box API with the iOS SDK. I am ready to get started diff --git a/content/guides/mobile/ios/quick-start/4-make-api-call.md b/content/guides/mobile/ios/quick-start/4-make-api-call.md index 161d95481..1cc4386cb 100644 --- a/content/guides/mobile/ios/quick-start/4-make-api-call.md +++ b/content/guides/mobile/ios/quick-start/4-make-api-call.md @@ -17,7 +17,7 @@ a request to Box to fetch the name of the currently authenticated user. delegation and non-blocking actions. -## Create a button +## Create a button Within your Swift application in Xcode, load `ContentView.swift`. At the top of the file you will see a `struct` for `ContentView`, within which is a basic @@ -56,7 +56,7 @@ details from Box. When a user clicks the button, we want to fetch the user's details. To achieve this we need to do two things, add the import for the **Box iOS SDK** and add -the button action to make the call. +the button action to make the call. At the top of the `ContentView.swift` file, add `import BoxSDK` with the other import statement. @@ -85,13 +85,13 @@ client.users.getCurrent(fields:["name", "login"]) { (result: Result If you run this code an hour or more after you created the developer token in the last step, you will need to revoke and generate a new developer token using the same method in the - [previous step](g://mobile/ios/quick-start/configure-box-app/) as the + [previous step](g://mobile/ios/quick-start/configure-box-app) as the developer token will only persist for 60 minutes. @@ -103,7 +103,7 @@ with the last line showing the user print statement that we specified. ```bash ◁ Status code: 200: no error -◁ Headers: +◁ Headers: ◁ Cache-Control, Value: no-cache, no-store ◁ BOX-REQUEST-ID, Value: 1c55151238444132eca16b4c2346d005 ◁ Transfer-Encoding, Value: Identity diff --git a/content/guides/mobile/ios/quick-start/5-next-steps.md b/content/guides/mobile/ios/quick-start/5-next-steps.md index 3a0200298..9767b09f4 100644 --- a/content/guides/mobile/ios/quick-start/5-next-steps.md +++ b/content/guides/mobile/ios/quick-start/5-next-steps.md @@ -8,17 +8,17 @@ hide_step_number: true You've reached the end of this Quick Start guide. By now you should have taken the following steps. -1. [Created a new iOS app](g://mobile/ios/quick-start/create-ios-app/) in Xcode. -2. [Installed the iOS SDK](g://mobile/ios/quick-start/install-ios-sdk/) into your project. -3. [Configured a Box App](g://mobile/ios/quick-start/configure-box-app/) so that the iOS SDK can access the Box API. -4. [Made your first API call](g://mobile/ios/quick-start/make-api-call/) to the Box API with the iOS SDK. +1. [Created a new iOS app](g://mobile/ios/quick-start/create-ios-app) in Xcode. +2. [Installed the iOS SDK](g://mobile/ios/quick-start/install-ios-sdk) into your project. +3. [Configured a Box App](g://mobile/ios/quick-start/configure-box-app) so that the iOS SDK can access the Box API. +4. [Made your first API call](g://mobile/ios/quick-start/make-api-call) to the Box API with the iOS SDK. ## Next things to do To take the next step with your application, the following resources are recommended. -* [Token Downscoping](g://authentication/tokens/downscope/): In this quick start guide you used a developer token to make your first call. To implement a scalable solution you should have a server-side solution to generate downscoped tokens to replace that implementation. +* [Token Downscoping](g://authentication/tokens/downscope): In this quick start guide you used a developer token to make your first call. To implement a scalable solution you should have a server-side solution to generate downscoped tokens to replace that implementation. * [Official JWT sample application][sample-jwt]: Bundled with the iOS SDK, this sample application will get you started quickly with a properly structured Box JWT application, which doesn't require user login. * [Official OAuth 2 sample application][sample-oauth]: Bundled with the iOS SDK, this sample application will get you started quickly with a properly structured Box OAuth 2 application, which requires user login. diff --git a/content/guides/search/1-indexing.md b/content/guides/search/1-indexing.md index 4062d3b1c..6c2c08d66 100644 --- a/content/guides/search/1-indexing.md +++ b/content/guides/search/1-indexing.md @@ -132,7 +132,7 @@ Searching the trash is available via the API by using the -[support]: p://support +[support]: page://support [keysafe]: https://www.box.com/security/keysafe diff --git a/content/guides/search/index.md b/content/guides/search/index.md index 88599ff6b..5ea28dcb6 100644 --- a/content/guides/search/index.md +++ b/content/guides/search/index.md @@ -93,5 +93,5 @@ for relevance to a human user. [mdq]: g://metadata/queries [mdq_api]: e://post_metadata_queries_execute_read [search]: e://get_search -[support]: p://support +[support]: page://support [keysafe]: https://www.box.com/security/keysafe \ No newline at end of file diff --git a/content/guides/search/quick-start/0-index.md b/content/guides/search/quick-start/0-index.md index eec0812f0..575726eb3 100644 --- a/content/guides/search/quick-start/0-index.md +++ b/content/guides/search/quick-start/0-index.md @@ -38,7 +38,7 @@ This guide will take you through the following steps. I am ready to get started -[stepone]: g://search/quick-start/create-metadata-template/ -[steptwo]: g://search/quick-start/locate-template-info/ -[stepthree]: g://search/quick-start/apply-template-to-file/ -[stepfour]: g://search/quick-start/metadata-query-api/ +[stepone]: g://search/quick-start/create-metadata-template +[steptwo]: g://search/quick-start/locate-template-info +[stepthree]: g://search/quick-start/apply-template-to-file +[stepfour]: g://search/quick-start/metadata-query-api diff --git a/content/guides/search/quick-start/1-create-metadata-template.md b/content/guides/search/quick-start/1-create-metadata-template.md index a0e19603d..0844ed293 100644 --- a/content/guides/search/quick-start/1-create-metadata-template.md +++ b/content/guides/search/quick-start/1-create-metadata-template.md @@ -11,7 +11,7 @@ created that you would like to use you can skip to the next step. ## Admin Console -To create a template via the Admin Console, navigate to: +To create a template via the Admin Console, navigate to: **Admin Console** > **Content** Tab > **Metadata** > **Create New** @@ -21,11 +21,11 @@ To create a template via the Admin Console, navigate to: The metadata feature is reserved for Business Plus accounts and above. To - upgrade your account, please contact your Box account team. + upgrade your account, please contact your Box account team. Once you select **Create New**, you are brought to a form used to create a new -template, which is shown below. Select a **Dropdown-Single Select** format. +template, which is shown below. Select a **Dropdown-Single Select** format. Selecting a Dropdown-Multi Select format will change the structure of you query @@ -39,19 +39,19 @@ later on in this quick-start. ## API Creating a metadata template via the API requires an [Access Token][at] -associated with a Box Admin or Co-Admin with permission to +associated with a Box Admin or Co-Admin with permission to **create and edit metadata templates for your company**. If you are not sure -who your token is associated with, make an API call to the +who your token is associated with, make an API call to the [get current user endpoint][current-user]. The easiest way to obtain a token meeting these requirements is to log in as an Admin or Co-Admin, pull up the -application in the [Developer Console][dc], and click -**Generate Developer Token** under the **Configuration** tab. +application in the [Developer Console][dc], and click +**Generate Developer Token** under the **Configuration** tab. [Developer tokens][dt] are always be associated with the user logged into the Developer Console when the button is clicked. Using [Postman][postman] and the [Box Postman Collection][post-collab], below is an example of what an API call looks like to create the same metadata template -created above using the Admin Console. +created above using the Admin Console. ![Create Template API Call](./images/create-call.png) @@ -69,9 +69,9 @@ information in the next step. I created a metadata template -[at]: g://authentication/tokens/ -[current-user]: e://get-users-me/ +[at]: g://authentication/tokens +[current-user]: e://get-users-me [dc]: https://account.box.com/developers/console -[dt]: g://authentication/tokens/developer-tokens/ +[dt]: g://authentication/tokens/developer-tokens [postman]: https://postman.com/ -[post-collab]: g://tooling/postman/ +[post-collab]: g://tooling/postman diff --git a/content/guides/search/quick-start/2-locate-template-info.md b/content/guides/search/quick-start/2-locate-template-info.md index c7fcc8e7e..f48371622 100644 --- a/content/guides/search/quick-start/2-locate-template-info.md +++ b/content/guides/search/quick-start/2-locate-template-info.md @@ -6,22 +6,22 @@ hide_in_page_nav: true # Locate Information about a Metadata Template - If you created your metadata template using the API and have the successful - response on hand, you can skip this step. + If you created your metadata template using the API and have the successful + response on hand, you can skip this step. -If you created your metadata template via the Admin Console, you will need +If you created your metadata template via the Admin Console, you will need obtain an [Access Token][at] for an Admin or Co-Admin with permission to **Create and edit metadata templates for your company**. As mentioned in step 1, the easiest way to obtain a token meeting these requirements is to log in as an Admin or Co-Admin, pull up the application in the [Developer Console][dc], and click **Generate Developer Token** under the -**Configuration** tab. +**Configuration** tab. Use this token to make an API call to the [list all metadata templates for enterprise endpoint][metadata-list], as shown below. You should be able to find information about your template in the -response. Specifically, note the `scope` and `templateKey`. +response. Specifically, note the `scope` and `templateKey`. ![List All Templates](./images/list-all-templates.png) @@ -29,6 +29,6 @@ response. Specifically, note the `scope` and `templateKey`. I obtained the details about my template -[at]: g://authentication/tokens/ +[at]: g://authentication/tokens [dc]: https://account.box.com/developers/console [metadata-list]: e://get-metadata-templates-enterprise/ \ No newline at end of file diff --git a/content/guides/search/quick-start/5-next-steps.md b/content/guides/search/quick-start/5-next-steps.md index ebc361c53..8002417b4 100644 --- a/content/guides/search/quick-start/5-next-steps.md +++ b/content/guides/search/quick-start/5-next-steps.md @@ -29,14 +29,14 @@ Our SDKs that support the metadata query API: * [Java SDK][java] * [Node][node] -[stepone]: g://search/quick-start/create-metadata-template/ -[steptwo]: g://search/quick-start/apply-template-to-file/ -[stepthree]: g://search/quick-start/locate-template-info/ -[stepfour]: g://search/quick-start/metadata-query-api/ -[mq]:e://post-metadata-queries-execute-read/ -[mqg]: g://metadata/queries/ -[ce]: g://metadata/queries/errors/ -[lims]: g://metadata/queries/limitations/ +[stepone]: g://search/quick-start/create-metadata-template +[steptwo]: g://search/quick-start/apply-template-to-file +[stepthree]: g://search/quick-start/locate-template-info +[stepfour]: g://search/quick-start/metadata-query-api +[mq]: e://post-metadata-queries-execute-read +[mqg]: g://metadata/queries +[ce]: g://metadata/queries/errors +[lims]: g://metadata/queries/limitations [node]: https://github.com/box/box-node-sdk/blob/3fcc0d8bbd1ca11f1a3a78d741e4572718af53f0/docs/metadata.md#query [python]: https://github.com/box/box-python-sdk/blob/main/docs/usage/search.md#metadata-query [ios]: https://github.com/box/box-ios-sdk/blob/c5ff8396e28c31fcf3c433f1b9e8f2f0d7a0e0db/docs/usage/search.md#metadata-search diff --git a/content/guides/security/index.md b/content/guides/security/index.md index 639252c8f..c4d528307 100644 --- a/content/guides/security/index.md +++ b/content/guides/security/index.md @@ -173,10 +173,10 @@ require enablement. [revoked]: e://post-oauth2-revoke [rt]: g://authentication/tokens/refresh [gettoken]: e://post-oauth2-token -[exchange]: e://reference/post-oauth2-token--refresh/ +[exchange]: e://post-oauth2-token--refresh [coadminperm]: https://support.box.com/hc/en-us/articles/360044194393-Granting-And-Modifying-Co-Admin-Permissions -[reference]: https://developer.box.com/reference/ +[reference]: page://reference [dc]: https://app.box.com/developers/console [scopes]: g://api-calls/permissions-and-errors/scopes diff --git a/content/guides/sso-identities-and-app-users/1-connect-identities.md b/content/guides/sso-identities-and-app-users/1-connect-identities.md index 5cb13e272..4926e9b58 100644 --- a/content/guides/sso-identities-and-app-users/1-connect-identities.md +++ b/content/guides/sso-identities-and-app-users/1-connect-identities.md @@ -84,7 +84,7 @@ accounts over email, for a number of reasons: Using the `login` field of a user object to create an account association is viable under a few conditions: -* Only the [managed users](getting-started://authentication/user-types/#managed-users/) type is being used, not [app users](page://platform/user-types/#app-user). +* Only the [managed users](page://platform/user-types/#managed-users) type is being used, not [app users](page://platform/user-types/#app-user). * All email addresses and Box account creation requests are managed by your enterprise, meaning that users cannot independently create Box accounts with those email addresses. diff --git a/content/guides/sso-identities-and-app-users/3-find-app-user.md b/content/guides/sso-identities-and-app-users/3-find-app-user.md index 75b572811..02ac4bf42 100644 --- a/content/guides/sso-identities-and-app-users/3-find-app-user.md +++ b/content/guides/sso-identities-and-app-users/3-find-app-user.md @@ -12,8 +12,8 @@ first step that should be taken is to see if that user already exists from a previous login attempt where a Box user record was already created. If a Box user is found you should -[create a user access token](guide://authentication/jwt/user-access-tokens/), -or make [as user calls](guide://authentication/jwt/as-user/), to access Box +[create a user access token](guide://authentication/jwt/user-access-tokens), +or make [as user calls](guide://authentication/jwt/as-user), to access Box APIs as that user. If a Box user is not found you should create a new user with an association to diff --git a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/0-index.md b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/0-index.md index 458a0f9eb..7c93d6ca6 100644 --- a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/0-index.md +++ b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/0-index.md @@ -57,9 +57,9 @@ stating `Hello {{USERNAME}}` will now be output to the browser. [okta]: https://www.okta.com/ [okta-dev]: https://developer.okta.com/ -[step1]: g://sso-identities-and-app-users/connect-okta-to-app-users/scaffold-application-code/ -[step2]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta/ -[step3]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-box/ -[step4]: g://sso-identities-and-app-users/connect-okta-to-app-users/logging-into-app/ -[step5]: g://sso-identities-and-app-users/connect-okta-to-app-users/find-or-create-box-users/ -[step6]: g://sso-identities-and-app-users/connect-okta-to-app-users/run-the-app/ +[step1]: g://sso-identities-and-app-users/connect-okta-to-app-users/scaffold-application-code +[step2]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta +[step3]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-box +[step4]: g://sso-identities-and-app-users/connect-okta-to-app-users/logging-into-app +[step5]: g://sso-identities-and-app-users/connect-okta-to-app-users/find-or-create-box-users +[step6]: g://sso-identities-and-app-users/connect-okta-to-app-users/run-the-app diff --git a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md index 583b59548..96f20c631 100644 --- a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md +++ b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md @@ -49,7 +49,7 @@ create users that are associated with the Okta user account. enterprise admin before you will be able to make calls to the Box APIs. - Follow [this guide](g://authorization/custom-app-approval/) to have the + Follow [this guide](g://authorization/custom-app-approval) to have the application approved in your enterprise. diff --git a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md index aa58d5207..2d3c02cca 100644 --- a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md +++ b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md @@ -380,7 +380,7 @@ application. Once an associated Box user is found for the Okta user we're going to generate an access token specifically -[scoped for that user](g://authentication/jwt/user-access-tokens/) to make Box +[scoped for that user](g://authentication/jwt/user-access-tokens) to make Box API calls, then make a call to get the current user to ensure that everything is working and that we have a valid user access token. diff --git a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/6-run-the-app.md b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/6-run-the-app.md index c316ecee2..a7a868fc1 100644 --- a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/6-run-the-app.md +++ b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/6-run-the-app.md @@ -22,7 +22,7 @@ we'll be testing out the user sign in flow, you'll see the Okta login. Sign in with the credentials for the Okta user you created in the last section -of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta/). +of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta). Once signed in, you will see a message stating `New user created: {{USERNAME}}` output to the browser. @@ -45,7 +45,7 @@ we'll be testing out the user sign in flow, you'll see the Okta login. Sign in with the credentials for the Okta user you created in the last section -of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta/). +of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta). Once signed in, you will see a message stating `New User Created: {{USERNAME}}` output to the browser. @@ -68,7 +68,7 @@ we'll be testing out the user sign in flow, you'll see the Okta login. Sign in with the credentials for the Okta user you created in the last section -of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta/). +of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta). Once signed in, you will see a message stating `New user created: {{USERNAME}}` output to the browser. @@ -92,7 +92,7 @@ displayed. Once clicked, the Okta login will be automatically loaded. Sign in with the credentials for the Okta user you created in the last section -of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta/). +of [step 2](g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta). Once signed in, you will see a message in the debug console stating `New user created: {{USERNAME}}` output to the browser. @@ -125,13 +125,13 @@ We recommend the following resource for anyone who wants to learn more about more advanced capabilities that may be attached into the user creation and access process. -* [User provisioning](g://users/provision/) best practices for advanced user folder architecture setup. -* [User deprovisioning](g://users/deprovision/) best practices cleaning up inactive users and transferring user content to another account. -* [Uploading content](g://uploads/) into Box, including running preflight checks and large file (chunked) uploading. +* [User provisioning](g://users/provision) best practices for advanced user folder architecture setup. +* [User deprovisioning](g://users/deprovision) best practices cleaning up inactive users and transferring user content to another account. +* [Uploading content](g://uploads) into Box, including running preflight checks and large file (chunked) uploading. -[step1]: g://sso-identities-and-app-users/connect-okta-to-app-users/scaffold-application-code/ -[step2]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta/ -[step3]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-box/ -[step4]: g://sso-identities-and-app-users/connect-okta-to-app-users/logging-into-app/ -[step5]: g://sso-identities-and-app-users/connect-okta-to-app-users/find-or-create-box-users/ -[step6]: g://sso-identities-and-app-users/connect-okta-to-app-users/run-the-app/ +[step1]: g://sso-identities-and-app-users/connect-okta-to-app-users/scaffold-application-code +[step2]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-okta +[step3]: g://sso-identities-and-app-users/connect-okta-to-app-users/configure-box +[step4]: g://sso-identities-and-app-users/connect-okta-to-app-users/logging-into-app +[step5]: g://sso-identities-and-app-users/connect-okta-to-app-users/find-or-create-box-users +[step6]: g://sso-identities-and-app-users/connect-okta-to-app-users/run-the-app diff --git a/content/guides/tooling/postman/quick-start/0-index.md b/content/guides/tooling/postman/quick-start/0-index.md index f3bfd06a9..6de604dfe 100644 --- a/content/guides/tooling/postman/quick-start/0-index.md +++ b/content/guides/tooling/postman/quick-start/0-index.md @@ -21,11 +21,11 @@ requests. This guide will take you through the following steps. -1. [Install Postman](g://tooling/postman/quick-start/install-postman/) on your device. -2. [Configure a Box App](g://tooling/postman/quick-start/configure-box-app/) so that Postman can access the Box API. -3. [Log in](g://tooling/postman/quick-start/log-in-to-box/) to the Box App to get the right API credentials. -4. [Fork Box's Postman collection](g://tooling/postman/quick-start/load-postman-collection/) into Postman. -5. [Make a first API call](g://tooling/postman/quick-start/make-api-call/) to the Box API with Postman. +1. [Install Postman](g://tooling/postman/quick-start/install-postman) on your device. +2. [Configure a Box App](g://tooling/postman/quick-start/configure-box-app) so that Postman can access the Box API. +3. [Log in](g://tooling/postman/quick-start/log-in-to-box) to the Box App to get the right API credentials. +4. [Fork Box's Postman collection](g://tooling/postman/quick-start/load-postman-collection) into Postman. +5. [Make a first API call](g://tooling/postman/quick-start/make-api-call) to the Box API with Postman. I am ready to get started diff --git a/content/guides/tooling/postman/quick-start/2-configure-box-app.md b/content/guides/tooling/postman/quick-start/2-configure-box-app.md index d5c85002a..11665e48a 100644 --- a/content/guides/tooling/postman/quick-start/2-configure-box-app.md +++ b/content/guides/tooling/postman/quick-start/2-configure-box-app.md @@ -120,4 +120,4 @@ extra steps to set up. [devconsole]: https://cloud.app.box.com/developers/console [signup]: https://account.box.com/signup/n/developer -[scopes]: https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/ +[scopes]: g://api-calls/permissions-and-errors/scopes diff --git a/content/guides/tooling/postman/quick-start/6-next-steps.md b/content/guides/tooling/postman/quick-start/6-next-steps.md index cdd5f61e6..81a817f16 100644 --- a/content/guides/tooling/postman/quick-start/6-next-steps.md +++ b/content/guides/tooling/postman/quick-start/6-next-steps.md @@ -8,11 +8,11 @@ hide_step_number: true You've reached the end of this Quick Start guide. By now you should have taken the following steps. -1. [Installed Postman](g://tooling/postman/quick-start/install-postman/) on your device. -2. [Configured a Box App](g://tooling/postman/quick-start/configure-box-app/) in order to be able to authenticate a Postman App for accessing Box. -3. [Logged in](g://tooling/postman/quick-start/log-in-to-box/) to the Box App to get the right API credentials. -4. [Loaded Box's Postman collection](g://tooling/postman/quick-start/load-postman-collection/) into Postman, and with it all the credentials needed to make API calls. -5. [Made your first API call](g://tooling/postman/quick-start/make-api-call/) to the Box API with Postman. +1. [Installed Postman](g://tooling/postman/quick-start/install-postman) on your device. +2. [Configured a Box App](g://tooling/postman/quick-start/configure-box-app) in order to be able to authenticate a Postman App for accessing Box. +3. [Logged in](g://tooling/postman/quick-start/log-in-to-box) to the Box App to get the right API credentials. +4. [Loaded Box's Postman collection](g://tooling/postman/quick-start/load-postman-collection) into Postman, and with it all the credentials needed to make API calls. +5. [Made your first API call](g://tooling/postman/quick-start/make-api-call) to the Box API with Postman. ## Next things to do diff --git a/content/guides/users/create-app-user.md b/content/guides/users/create-app-user.md index 6f26c5d48..442facb02 100644 --- a/content/guides/users/create-app-user.md +++ b/content/guides/users/create-app-user.md @@ -16,7 +16,7 @@ alias_paths: [] # Create App User App Users are programmatic user accounts that may only be created by apps that -are using [JWT authentication](g://authentication/jwt/jwt-setup/). +are using [JWT authentication](g://authentication/jwt/jwt-setup). They are designed to allow for users, groups, or processes to be represented behind the scenes in an application without the need for the user to have a Box account to log in. diff --git a/content/guides/users/provision/architecture.md b/content/guides/users/provision/architecture.md index eb91b6ee6..cada93235 100644 --- a/content/guides/users/provision/architecture.md +++ b/content/guides/users/provision/architecture.md @@ -458,4 +458,4 @@ namespace BoxPlayground { -[sa]:page://platform/user-types/#service-account \ No newline at end of file +[sa]: page://platform/user-types/#service-account \ No newline at end of file diff --git a/content/guides/users/provision/index.md b/content/guides/users/provision/index.md index b74ef6177..b62a35e63 100644 --- a/content/guides/users/provision/index.md +++ b/content/guides/users/provision/index.md @@ -39,4 +39,4 @@ provisioning a user's account, creating a general folder and file structure that everyone will have on first login, using groups to control access to shared files and folders for users. -[managed]:page://platform/user-types/#managed-users +[managed]: page://platform/user-types/#managed-users diff --git a/content/guides/webhooks/v2/create-v2.md b/content/guides/webhooks/v2/create-v2.md index 5a6847325..45cd3dfaf 100644 --- a/content/guides/webhooks/v2/create-v2.md +++ b/content/guides/webhooks/v2/create-v2.md @@ -100,5 +100,5 @@ You can find a list of available triggers [in this guide][4]. [2]: g://authorization [3]: e://post_webhooks [4]: g://webhooks/triggers -[sa]:page://platform/user-types/#service-account +[sa]: page://platform/user-types/#service-account [console]: https://app.box.com/developers/console diff --git a/content/pages/platform/appendix/architecture-patterns.md b/content/pages/platform/appendix/architecture-patterns.md index dbcaa3359..f68ac0901 100644 --- a/content/pages/platform/appendix/architecture-patterns.md +++ b/content/pages/platform/appendix/architecture-patterns.md @@ -60,7 +60,7 @@ be processed by any machine learning service. Once it is processed, information is [saved back to the file as metadata][metadata]. This metadata can then be used in another process or for future reference. -[usermodel]:page://platform/appendix/user-models +[usermodel]: page://platform/appendix/user-models [auth]: g://authentication [apptype]: g://applications/app-types/select [events]: e://resources/event diff --git a/content/pages/platform/appendix/index.md b/content/pages/platform/appendix/index.md index c09ce1b23..9329835bd 100644 --- a/content/pages/platform/appendix/index.md +++ b/content/pages/platform/appendix/index.md @@ -14,7 +14,7 @@ pinpoint you to a solution if you are having an issue. - [Locating Common Values][common_values]: This page goes over how to find pieces of information like user IDs. - [Branding Guidelines][branding]: This page lists out various things to keep in mind if you plan to use the Box brand for your project -[arch_patterns]:page://platform/appendix/architecture-patterns/ -[user_models]:page://platform/appendix//user-models/ -[common_values]:page://platform/appendix/locating-values/ -[branding]:page://platform/appendix/branding-guidelines/ \ No newline at end of file +[arch_patterns]: page://platform/appendix/architecture-patterns +[user_models]: page://platform/appendix//user-models +[common_values]: page://platform/appendix/locating-values +[branding]: page://platform/appendix/branding-guidelines/ \ No newline at end of file diff --git a/content/pages/platform/application-types.md b/content/pages/platform/application-types.md index d9890100d..bb2c5a291 100644 --- a/content/pages/platform/application-types.md +++ b/content/pages/platform/application-types.md @@ -67,8 +67,8 @@ sections in the Integrations, and they can also be unpublished if necessary. Next step -[custom_app]: g://applications/app-types/custom-apps/ -[limited_app]: g://applications/app-types/limited-access-apps/ -[skills]: g://applications/app-types/custom-skills/ -[web_app]: g://applications/web-app-integrations/ +[custom_app]: g://applications/app-types/custom-apps +[limited_app]: g://applications/app-types/limited-access-apps +[skills]: g://applications/app-types/custom-skills +[web_app]: g://applications/web-app-integrations [integrations]: g://applications/integrations/ \ No newline at end of file diff --git a/content/pages/platform/authentication-methods.md b/content/pages/platform/authentication-methods.md index f95be6e4b..661282723 100644 --- a/content/pages/platform/authentication-methods.md +++ b/content/pages/platform/authentication-methods.md @@ -175,17 +175,17 @@ together, see our [security guide][security]. Next step -[oauth]: g://authentication/oauth2/ -[jwt]: g://authentication/jwt/ -[ata]: g://authentication/app-token/ -[ccg]: g://authentication/client-credentials/ +[oauth]: g://authentication/oauth2 +[jwt]: g://authentication/jwt +[ata]: g://authentication/app-token +[ccg]: g://authentication/client-credentials [skill]: g://skills/handle/payload/#access-tokens -[app_ep]: g://authentication/app-token/endpoints/ -[scopes]: g://api-calls/permissions-and-errors/scopes/ +[app_ep]: g://authentication/app-token/endpoints +[scopes]: g://api-calls/permissions-and-errors/scopes [at]: g://authentication/tokens [security]: g://security -[reference]: https://developer.box.com/reference +[reference]: page://reference [python_oauth]: https://github.com/box-community/box-python-oauth-template [python_ccg]: https://medium.com/box-developer-blog/box-python-next-gen-sdk-getting-started-with-ccg-81be0abc82d9 [node_jwt]: https://medium.com/box-developer-blog/authenticate-box-node-js-sdk-with-jwt-47fdd3aeec50 diff --git a/content/pages/platform/box-glossary.md b/content/pages/platform/box-glossary.md index 4f318266b..72d96a749 100644 --- a/content/pages/platform/box-glossary.md +++ b/content/pages/platform/box-glossary.md @@ -72,22 +72,22 @@ to find out what a term means, this is your one stop page. Next step -[app user]:page://platform/user-types/#app-user +[app user]: page://platform/user-types/#app-user [CLI]: https://github.com/box/boxcli [collaborations]: g://collaborations [embed]: g://embed/box-embed -[ui-elements]: g://embed/ui-elements/ +[ui-elements]: g://embed/ui-elements [cascade-policy]: https://support.box.com/hc/en-us/articles/360044195873-Cascading-metadata-in-folders [content-manager]: https://support.box.com/hc/en-us/articles/360043698294-Managing-Files-And-Folders-From-The-Admin-Console [co-admin]: https://support.box.com/hc/en-us/articles/360043694174-Understanding-Administrator-and-Co-Administrator-Permissions [info-barriers]: https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers -[event]: r://event/ +[event]: r://event [event-stream]: https://support.box.com/hc/en-us/articles/8391393127955-Using-the-Enterprise-Event-Stream [group-admin]: https://support.box.com/hc/en-us/articles/360043694174-Understanding-Administrator-and-Co-Administrator-Permissions [managed-users]: https://support.box.com/hc/en-us/articles/360044194353-Understanding-User-Management [shared-link]: https://support.box.com/hc/en-us/articles/360043697094-Creating-Shared-Links -[sdk]: https://developer.box.com/sdks-and-tools/ -[code-catalog]: https://developer.box.com/sample-code/ +[sdk]: page://sdks-and-tools +[code-catalog]: page://sample-code [relay]: https://support.box.com/hc/en-us/articles/360044196213 [bve]: https://support.box.com/hc/en-us/articles/4401823156883-Box-Verified-Enterprise [report]: https://support.box.com/hc/en-us/articles/360043696534-Running-Reports @@ -100,4 +100,4 @@ to find out what a term means, this is your one stop page. [custom-app]: g://applications/app-types/custom-apps [webhook]: g://webhooks [limited-app]: g://applications/app-types/limited-access-apps -[service-account]:page://platform/user-types/#service-account +[service-account]: page://platform/user-types/#service-account diff --git a/content/pages/platform/box-platform-101.md b/content/pages/platform/box-platform-101.md index e9bccf1ff..7bf525e06 100644 --- a/content/pages/platform/box-platform-101.md +++ b/content/pages/platform/box-platform-101.md @@ -64,7 +64,7 @@ The [Box Developer Console][dc] is an interactive interface that provides developers with tools and resources for managing their applications integrated with Box. It allows for the creation, configuration, and monitoring of apps, offering insights and control over how these apps interact with the Box -platform. +platform. ![Box Developer Console](images/developer_console.png) @@ -121,12 +121,12 @@ to successfully make an API call to Box. [box]: https://www.box.com [platform]: https://www.box.com/platform -[apptypes]: g://applications/app-types/select/ -[authmethods]: g://authentication/select/ -[api]: https://developer.box.com/reference/ +[apptypes]: g://applications/app-types/select +[authmethods]: g://authentication/select +[api]: page://reference [change]: page://changelog [dc]: https://app.box.com/developers/console -[at]: g://authentication/tokens/ +[at]: g://authentication/tokens [ut]: https://support.box.com/hc/en-us/articles/4636533822483-Box-User-Types diff --git a/content/pages/platform/index.md b/content/pages/platform/index.md index e4e0fdcc4..5e135be89 100644 --- a/content/pages/platform/index.md +++ b/content/pages/platform/index.md @@ -5,7 +5,7 @@ rank: 0 # Learn Box Platform -If you are new to Box, **start here**! +If you are new to Box, **start here**! In the following pages, you'll learn how all the Box Platform concepts and components work together to help you create an application quickly. @@ -21,7 +21,7 @@ on everything Box Platform. --> ## Learn Sections These pages go into more depth on each topic. Checkout each one and become -a Box Platform expert. +a Box Platform expert. - [Box Platform 101][platform101] - [Use Cases][usecases] @@ -35,10 +35,10 @@ a Box Platform expert. Get Started -[platform101]:page://platform/box-platform-101 -[usecases]:page://platform/use-cases -[usertypes]:page://platform/user-types -[apptypes]:page://platform/application-types -[authtypes]:page://platform/authentication-methods -[support]:page://platform/support -[tools]:page://platform/tools \ No newline at end of file +[platform101]: page://platform/box-platform-101 +[usecases]: page://platform/use-cases +[usertypes]: page://platform/user-types +[apptypes]: page://platform/application-types +[authtypes]: page://platform/authentication-methods +[support]: page://platform/support +[tools]: page://platform/tools \ No newline at end of file diff --git a/content/pages/platform/start-creating.md b/content/pages/platform/start-creating.md index 67ff2b541..ee60a86b3 100644 --- a/content/pages/platform/start-creating.md +++ b/content/pages/platform/start-creating.md @@ -22,7 +22,7 @@ the following: - [Errors][errors]: This page lists out all the error codes you can receive [devconsole]: https://cloud.app.box.com/developers/console -[arch_patterns]:page://platform/appendix/architecture-patterns/ -[user_models]:page://platform/appendix//user-models/ -[common_values]:page://platform/appendix/locating-values/ -[errors]: g://api-calls/permissions-and-errors/common-errors/ \ No newline at end of file +[arch_patterns]: page://platform/appendix/architecture-patterns +[user_models]: page://platform/appendix//user-models +[common_values]: page://platform/appendix/locating-values +[errors]: g://api-calls/permissions-and-errors/common-errors \ No newline at end of file diff --git a/content/pages/platform/support.md b/content/pages/platform/support.md index b8c633bf2..257e549bd 100644 --- a/content/pages/platform/support.md +++ b/content/pages/platform/support.md @@ -44,7 +44,7 @@ updates, as well as new blogs. You can follow at [Box Platform][twitter]. Next step -[samples]: g://cli/scripts/ +[samples]: g://cli/scripts [forum]: https://community.box.com/ [medium]: https://medium.com/box-developer-blog diff --git a/content/pages/platform/tools.md b/content/pages/platform/tools.md index f70c888b2..974054f4e 100644 --- a/content/pages/platform/tools.md +++ b/content/pages/platform/tools.md @@ -55,10 +55,10 @@ the YouTube video below. Next step -[samples]: g://cli/scripts/ -[sdk]: page://sdks-and-tools/ -[file]: e://get-files-id/ -[tooling]: g://tooling/ +[samples]: g://cli/scripts +[sdk]: page://sdks-and-tools +[file]: e://get-files-id +[tooling]: g://tooling [sample_code]: https://developer.box.com/sample-code/ [postman]: https://www.postman.com/boxdev diff --git a/content/pages/platform/user-types.md b/content/pages/platform/user-types.md index b804f1ea4..0378dbd06 100644 --- a/content/pages/platform/user-types.md +++ b/content/pages/platform/user-types.md @@ -293,13 +293,13 @@ would need to turn on this switch. [dc]: https://app.box.com/developers/console -[auth]: g://authorization/custom-app-approval/ -[scopes]: g://api-calls/permissions-and-errors/scopes/ -[collabapi]: e://post-collaborations/ -[getuser]: e://get-users-me/ -[updateuser]: e://put-users-id/ +[auth]: g://authorization/custom-app-approval +[scopes]: g://api-calls/permissions-and-errors/scopes +[collabapi]: e://post-collaborations +[getuser]: e://get-users-me +[updateuser]: e://put-users-id [createuser]: e://post-users -[events]: e://get-events/ +[events]: e://get-events [cm]: https://support.box.com/hc/en-us/articles/360044197333-Using-the-Content-Manager [uag-tab]: https://support.box.com/hc/en-us/articles/360043695714-Admin-Console-Guide diff --git a/content/pages/sdks-and-tools/index.md b/content/pages/sdks-and-tools/index.md index 2fc27217d..b6c41ae68 100644 --- a/content/pages/sdks-and-tools/index.md +++ b/content/pages/sdks-and-tools/index.md @@ -152,7 +152,7 @@ preview files on Box. | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | iOS | [Browse SDK][iosbrowsesdk], [Share SDK][iossharesdk], [Preview SDK][iospreviewsdk] | | Android | [Browse SDK](https://github.com/box/box-android-browse-sdk), [Share SDK](https://github.com/box/box-android-share-sdk), [Preview SDK](https://github.com/box/box-android-preview-sdk) | -| Javascript | [Box UI Elements](guide://embed/ui-elements/) | +| Javascript | [Box UI Elements](g://embed/ui-elements) | ## Unofficial & Community Tools diff --git a/content/pages/sign/10-quick-start/10-api-basics.md b/content/pages/sign/10-quick-start/10-api-basics.md index 15c589e38..3a517d99f 100644 --- a/content/pages/sign/10-quick-start/10-api-basics.md +++ b/content/pages/sign/10-quick-start/10-api-basics.md @@ -7,9 +7,9 @@ rank: 1 ## Sign API -The Sign request endpoint is used to create and manage signature requests. -You can create, resend, and cancel signature requests. -You can also list all signature requests and get details +The Sign request endpoint is used to create and manage signature requests. +You can create, resend, and cancel signature requests. +You can also list all signature requests and get details of a specific signature request. The endpoint is `https://{api.box.com}/2.0/sign_requests`. @@ -23,7 +23,7 @@ The following table lists the operations that you can perform on this endpoint. | POST | `/sign_requests/:id/resend` | Resend a signature request. | | POST | `/sign_requests/:id/cancel` | Cancel a signature request. | -For full details on the request and response parameters, see the [Sign +For full details on the request and response parameters, see the [Sign request API reference][sign-api-reference]. ## Sign templates API @@ -32,7 +32,7 @@ The Sign templates endpoint is used to list and get details of a template. -You can not create, edit, or delete templates using the API. These templates +You can not create, edit, or delete templates using the API. These templates are exclusively managed in the Box web application. @@ -45,8 +45,8 @@ The following table lists the operations that you can perform on this endpoint. | GET | `/sign_templates` | List all templates. | | GET | `/sign_templates/:id` | Get details of a specific template. | -For a full details on the request and response parameters, see the [Sign +For a full details on the request and response parameters, see the [Sign template request API reference][sign-api-template-ref]. -[sign-api-reference]:https://developer.box.com/reference/resources/sign-request/ -[sign-api-template-ref]:https://developer.box.com/reference/resources/sign-template/ \ No newline at end of file +[sign-api-reference]: resource://sign-request +[sign-api-template-ref]: resource://sign-template \ No newline at end of file diff --git a/content/pages/sign/10-quick-start/20-your-first-request.md b/content/pages/sign/10-quick-start/20-your-first-request.md index 28af46563..2572eb1c3 100644 --- a/content/pages/sign/10-quick-start/20-your-first-request.md +++ b/content/pages/sign/10-quick-start/20-your-first-request.md @@ -206,5 +206,5 @@ Be sure to check the [request options][request-options], and the information. -[request-options]:page://sign/request-options -[technical-use-cases]:page://sign/technical-use-cases \ No newline at end of file +[request-options]: page://sign/request-options +[technical-use-cases]: page://sign/technical-use-cases \ No newline at end of file diff --git a/content/pages/sign/10-quick-start/index.md b/content/pages/sign/10-quick-start/index.md index a8293b7a2..a41090652 100644 --- a/content/pages/sign/10-quick-start/index.md +++ b/content/pages/sign/10-quick-start/index.md @@ -5,18 +5,18 @@ rank: 0 # Quick start -Get a sense of how the [Box Sign API][api-basics] is structured and how to +Get a sense of how the [Box Sign API][api-basics] is structured and how to create your first signature request. -The Sign API does not follow the traditional CRUD model. You can create, -resend, and cancel signature requests. You can also list all signature requests +The Sign API does not follow the traditional CRUD model. You can create, +resend, and cancel signature requests. You can also list all signature requests and get details of a specific signature request. -Sign Templates API is read-only. You can list all templates and get details of +Sign Templates API is read-only. You can list all templates and get details of a specific template. -Once you get a sense of the API, you can create +Once you get a sense of the API, you can create [your first signature request][quick-start]. -[api-basics]:page://sign/quick-start/api-basics -[quick-start]:page://sign/quick-start/your-first-request +[api-basics]: page://sign/quick-start/api-basics +[quick-start]: page://sign/quick-start/your-first-request diff --git a/content/pages/sign/20-technical-use-cases/10-sign-unstructured-docs.md b/content/pages/sign/20-technical-use-cases/10-sign-unstructured-docs.md index bd3013c7c..f54e1b550 100644 --- a/content/pages/sign/20-technical-use-cases/10-sign-unstructured-docs.md +++ b/content/pages/sign/20-technical-use-cases/10-sign-unstructured-docs.md @@ -180,5 +180,5 @@ the signed document are stored in the destination folder. ![Log and signed document](images/sign-pdf-signed-docs.png) -[sign-templates]:page://sign/technical-use-cases/sign-template -[sign-structured-docs]:page://sign/technical-use-cases/sign-structured-docs \ No newline at end of file +[sign-templates]: page://sign/technical-use-cases/sign-template +[sign-structured-docs]: page://sign/technical-use-cases/sign-structured-docs \ No newline at end of file diff --git a/content/pages/sign/20-technical-use-cases/20-sign-template.md b/content/pages/sign/20-technical-use-cases/20-sign-template.md index 5f0f07496..68779e806 100644 --- a/content/pages/sign/20-technical-use-cases/20-sign-template.md +++ b/content/pages/sign/20-technical-use-cases/20-sign-template.md @@ -615,5 +615,5 @@ signature tags that can be used by the Box Sign engine. Take a look at our [Structured Docs][structured-docs] section for more information. [template]: https://support.box.com/hc/en-us/sections/21356768117651-Templates -[request-options]:page://sign/request-options -[structured-docs]:page://sign/technical-use-cases/sign-structured-docs \ No newline at end of file +[request-options]: page://sign/request-options +[structured-docs]: page://sign/technical-use-cases/sign-structured-docs \ No newline at end of file diff --git a/content/pages/sign/20-technical-use-cases/index.md b/content/pages/sign/20-technical-use-cases/index.md index 169b8dc4e..947fe099b 100644 --- a/content/pages/sign/20-technical-use-cases/index.md +++ b/content/pages/sign/20-technical-use-cases/index.md @@ -5,30 +5,30 @@ rank: 0 # Technical use cases -In your application you will be signing different documents from many sources. -How can your application process such documents in order for them to be +In your application you will be signing different documents from many sources. +How can your application process such documents in order for them to be recognized by the Box Sign service? -A signature request can have multiple requirements, or inputs, beyond the -traditional signature, such as name, date, and initials. These inputs -are called signature properties. The Box Sign service needs to know where to +A signature request can have multiple requirements, or inputs, beyond the +traditional signature, such as name, date, and initials. These inputs +are called signature properties. The Box Sign service needs to know where to place these inputs in the document, and how to recognize them. -The first step is to consider if the document has the necessary information for +The first step is to consider if the document has the necessary information for the Box Sign service to recognize the signature properties. -If not, then the [document is unstructured][unstructured-docs], and should be -prepared before sending the signature request. This is called document +If not, then the [document is unstructured][unstructured-docs], and should be +prepared before sending the signature request. This is called document preparation, and is an extra step automatically created by the Box Sign service. -There are two other types of documents that already have the necessary +There are two other types of documents that already have the necessary information for the Box Sign service to recognize the signature properties. -The [sign templates][sign-templates], managed in the Box application, and the -[structured documents][sign-structured-docs], which are dynamically generated -documents, containing specific tags representing the signature properties. +The [sign templates][sign-templates], managed in the Box application, and the +[structured documents][sign-structured-docs], which are dynamically generated +documents, containing specific tags representing the signature properties. Signing unstructured docs -[unstructured-docs]:page://sign/technical-use-cases/sign-unstructured-docs -[sign-templates]:page://sign/technical-use-cases/sign-template -[sign-structured-docs]:page://sign/technical-use-cases/sign-structured-docs \ No newline at end of file +[unstructured-docs]: page://sign/technical-use-cases/sign-unstructured-docs +[sign-templates]: page://sign/technical-use-cases/sign-template +[sign-structured-docs]: page://sign/technical-use-cases/sign-structured-docs \ No newline at end of file diff --git a/content/pages/sign/30-request-options/60-custom-email.md b/content/pages/sign/30-request-options/60-custom-email.md index bb9254267..c7e2db078 100644 --- a/content/pages/sign/30-request-options/60-custom-email.md +++ b/content/pages/sign/30-request-options/60-custom-email.md @@ -251,4 +251,4 @@ Simple sign request: 22a990ce-4e24-463b-b2f4-124820fe161a-defddc79c946 You can now take the embedded URLs and use your own notification process or embed the signature client within your own app. -[embed]:guide://box-sign/embedded-sign-client +[embed]: g://box-sign/embedded-sign-client diff --git a/content/pages/sign/index.md b/content/pages/sign/index.md index 80f7a0a75..61047e501 100644 --- a/content/pages/sign/index.md +++ b/content/pages/sign/index.md @@ -42,9 +42,9 @@ your users. --> Let's get started! [sign]: https://www.box.com/esignature -[quick-start]:page://sign/quick-start -[request-options]:page://sign/request-options -[technical-use-cases]:page://sign/technical-use-cases +[quick-start]: page://sign/quick-start +[request-options]: page://sign/request-options +[technical-use-cases]: page://sign/technical-use-cases ``` +## Internal links + +You can link internal pages using `page://` (`p://`), `guide://` (`g://`), `endpoint://` (`e://`) or `resource://` (`r://`) prefixes: + +* Using `page://` or `p://` you can link all internal pages. + + For example + `page://changelog` will be resolved to `https:///changelog` + where domain is a domain of a page on which the link is clicked. E.g. it can navigate to `https://developer.box.com/changelog` or `https://ja.developer.box.com/changelog` + +* Using or `guide://` or `g://` prefix you can link guides. For example + ``` + g://api-calls/permissions-and-errors/rate-limits + ``` + will be changed to + ``` + https:///guides/api-calls/permissions-and-errors/rate-limits + ``` +* Using `endpoint://` or `e://` you can link API reference pages. For instance + ``` + e://post_users#param-language + ``` + will become + ``` + https:///reference/post_users#param-language + ``` + + * Using `resource://` or `r://` you can link resource pages: + ``` + resource://user + ``` + will become + ``` + https:///reference/resources/user + ``` + +> **Important note** +> +> Links staring with one of these prefixes should not end with `/` + + ## Localize links Any links that do not use the `g://`, `e://` structure or otherwise need to use diff --git a/src/markdown/LinkValidator/index.js b/src/markdown/LinkValidator/index.js index dbf97e14e..18e62d1a2 100644 --- a/src/markdown/LinkValidator/index.js +++ b/src/markdown/LinkValidator/index.js @@ -11,7 +11,7 @@ const LOCAL_REFERENCE_REGEX = new RegExp(/\[.*\]\[([\w\-_]+)\]/, 'mg') // checks for convenience links, e.g. guide://foo/bar const GUIDE_OR_PAGE_LINKS = new RegExp(/(guide|guides|g|page|pages|[^a-z]p):\/\/([a-z-_0-9.\/]*)/, 'ig') -const PAGE_LINKS_INGORE = ['page://reference', 'pages://reference', 'p://reference'] +const PAGE_LINKS_INGORE = ['page://reference', 'pages://reference', 'p://reference', 'page://sample-code'] class LinkValidator { constructor(source, allFiles) {