Skip to content

Commit

Permalink
docs: Fix API reference links (box/box-codegen#638) (#321)
Browse files Browse the repository at this point in the history
  • Loading branch information
box-sdk-build authored Jan 9, 2025
1 parent 220134e commit 88c63c5
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "a2387ff", "specHash": "4ccce13", "version": "0.5.0" }
{ "engineHash": "ab51050", "specHash": "4ccce13", "version": "0.5.0" }
6 changes: 3 additions & 3 deletions docs/Authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Box API calls.
This operation is performed by calling function `requestAccessToken`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-oauth-2-token/).
[API Reference](https://developer.box.com/reference/post-oauth2-token/).

*Currently we don't have an example for calling `requestAccessToken` in integration tests*

Expand Down Expand Up @@ -84,7 +84,7 @@ Refresh an Access Token using its client ID, secret, and refresh token.
This operation is performed by calling function `refreshAccessToken`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-oauth-2-token-refresh/).
[API Reference](https://developer.box.com/reference/post-oauth2-token--refresh/).

*Currently we don't have an example for calling `refreshAccessToken` in integration tests*

Expand Down Expand Up @@ -113,7 +113,7 @@ that has been previously authenticated.
This operation is performed by calling function `revokeAccessToken`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-oauth-2-revoke/).
[API Reference](https://developer.box.com/reference/post-oauth2-revoke/).

*Currently we don't have an example for calling `revokeAccessToken` in integration tests*

Expand Down
8 changes: 4 additions & 4 deletions docs/Classifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ URL explicitly, for example
This operation is performed by calling function `getClassificationTemplate`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema/).
[API Reference](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema/).

<!-- sample get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema -->
```
Expand Down Expand Up @@ -52,7 +52,7 @@ URL explicitly, for example
This operation is performed by calling function `addClassification`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema-add/).
[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--add/).

<!-- sample put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#add -->
```
Expand Down Expand Up @@ -88,7 +88,7 @@ URL explicitly, for example
This operation is performed by calling function `updateClassification`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema-update/).
[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--update/).

<!-- sample put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#update -->
```
Expand Down Expand Up @@ -125,7 +125,7 @@ classifications.
This operation is performed by calling function `createClassificationTemplate`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-metadata-templates-schema-classifications/).
[API Reference](https://developer.box.com/reference/post-metadata-templates-schema--classifications/).

*Currently we don't have an example for calling `createClassificationTemplate` in integration tests*

Expand Down
8 changes: 4 additions & 4 deletions docs/FileClassifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ URL explicitly, for example
This operation is performed by calling function `getClassificationOnFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample get_files_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down Expand Up @@ -55,7 +55,7 @@ URL explicitly, for example
This operation is performed by calling function `addClassificationToFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample post_files_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down Expand Up @@ -91,7 +91,7 @@ defined for the enterprise will be accepted.
This operation is performed by calling function `updateClassificationOnFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample put_files_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down Expand Up @@ -126,7 +126,7 @@ URL explicitly, for example
This operation is performed by calling function `deleteClassificationFromFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/delete-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample delete_files_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down
8 changes: 4 additions & 4 deletions docs/FolderClassifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ URL explicitly, for example
This operation is performed by calling function `getClassificationOnFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/get-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample get_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down Expand Up @@ -55,7 +55,7 @@ URL explicitly, for example
This operation is performed by calling function `addClassificationToFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/post-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample post_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down Expand Up @@ -91,7 +91,7 @@ defined for the enterprise will be accepted.
This operation is performed by calling function `updateClassificationOnFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/put-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample put_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down Expand Up @@ -126,7 +126,7 @@ URL explicitly, for example
This operation is performed by calling function `deleteClassificationFromFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/delete-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/).
[API Reference](https://developer.box.com/reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/).

<!-- sample delete_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo -->
```
Expand Down
8 changes: 4 additions & 4 deletions docs/SharedLinksFiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Gets the information for a shared link on a file.
This operation is performed by calling function `getSharedLinkForFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-files-id-get-shared-link/).
[API Reference](https://developer.box.com/reference/get-files-id--get-shared-link/).

<!-- sample get_files_id#get_shared_link -->
```
Expand Down Expand Up @@ -85,7 +85,7 @@ Adds a shared link to a file.
This operation is performed by calling function `addShareLinkToFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-files-id-add-shared-link/).
[API Reference](https://developer.box.com/reference/put-files-id--add-shared-link/).

<!-- sample put_files_id#add_shared_link -->
```
Expand Down Expand Up @@ -119,7 +119,7 @@ Updates a shared link on a file.
This operation is performed by calling function `updateSharedLinkOnFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-files-id-update-shared-link/).
[API Reference](https://developer.box.com/reference/put-files-id--update-shared-link/).

<!-- sample put_files_id#update_shared_link -->
```
Expand Down Expand Up @@ -153,7 +153,7 @@ Removes a shared link from a file.
This operation is performed by calling function `removeSharedLinkFromFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-files-id-remove-shared-link/).
[API Reference](https://developer.box.com/reference/put-files-id--remove-shared-link/).

*Currently we don't have an example for calling `removeSharedLinkFromFile` in integration tests*

Expand Down
10 changes: 5 additions & 5 deletions docs/SharedLinksFolders.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ shared folder when only given a shared link.
This operation is performed by calling function `findFolderForSharedLink`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-shared-items-folders/).
[API Reference](https://developer.box.com/reference/get-shared-items--folders/).

<!-- sample get_shared_items#folders -->
```
Expand Down Expand Up @@ -50,7 +50,7 @@ Gets the information for a shared link on a folder.
This operation is performed by calling function `getSharedLinkForFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-folders-id-get-shared-link/).
[API Reference](https://developer.box.com/reference/get-folders-id--get-shared-link/).

<!-- sample get_folders_id#get_shared_link -->
```
Expand Down Expand Up @@ -82,7 +82,7 @@ Adds a shared link to a folder.
This operation is performed by calling function `addShareLinkToFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-folders-id-add-shared-link/).
[API Reference](https://developer.box.com/reference/put-folders-id--add-shared-link/).

<!-- sample put_folders_id#add_shared_link -->
```
Expand Down Expand Up @@ -116,7 +116,7 @@ Updates a shared link on a folder.
This operation is performed by calling function `updateSharedLinkOnFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-folders-id-update-shared-link/).
[API Reference](https://developer.box.com/reference/put-folders-id--update-shared-link/).

<!-- sample put_folders_id#update_shared_link -->
```
Expand Down Expand Up @@ -150,7 +150,7 @@ Removes a shared link from a folder.
This operation is performed by calling function `removeSharedLinkFromFolder`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-folders-id-remove-shared-link/).
[API Reference](https://developer.box.com/reference/put-folders-id--remove-shared-link/).

*Currently we don't have an example for calling `removeSharedLinkFromFolder` in integration tests*

Expand Down
10 changes: 5 additions & 5 deletions docs/SharedLinksWebLinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ shared web link when only given a shared link.
This operation is performed by calling function `findWebLinkForSharedLink`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-shared-items-web-links/).
[API Reference](https://developer.box.com/reference/get-shared-items--web-links/).

<!-- sample get_shared_items#web_links -->
```
Expand Down Expand Up @@ -50,7 +50,7 @@ Gets the information for a shared link on a web link.
This operation is performed by calling function `getSharedLinkForWebLink`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-web-links-id-get-shared-link/).
[API Reference](https://developer.box.com/reference/get-web-links-id--get-shared-link/).

<!-- sample get_web_links_id#get_shared_link -->
```
Expand Down Expand Up @@ -82,7 +82,7 @@ Adds a shared link to a web link.
This operation is performed by calling function `addShareLinkToWebLink`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-web-links-id-add-shared-link/).
[API Reference](https://developer.box.com/reference/put-web-links-id--add-shared-link/).

<!-- sample put_web_links_id#add_shared_link -->
```
Expand Down Expand Up @@ -116,7 +116,7 @@ Updates a shared link on a web link.
This operation is performed by calling function `updateSharedLinkOnWebLink`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-web-links-id-update-shared-link/).
[API Reference](https://developer.box.com/reference/put-web-links-id--update-shared-link/).

<!-- sample put_web_links_id#update_shared_link -->
```
Expand Down Expand Up @@ -150,7 +150,7 @@ Removes a shared link from a web link.
This operation is performed by calling function `removeSharedLinkFromWebLink`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-web-links-id-remove-shared-link/).
[API Reference](https://developer.box.com/reference/put-web-links-id--remove-shared-link/).

*Currently we don't have an example for calling `removeSharedLinkFromWebLink` in integration tests*

Expand Down
8 changes: 4 additions & 4 deletions docs/Skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ List the Box Skills metadata cards that are attached to a file.
This operation is performed by calling function `getBoxSkillCardsOnFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/get-files-id-metadata-global-box-skills-cards/).
[API Reference](https://developer.box.com/reference/get-files-id-metadata-global-boxSkillsCards/).

*Currently we don't have an example for calling `getBoxSkillCardsOnFile` in integration tests*

Expand Down Expand Up @@ -43,7 +43,7 @@ Applies one or more Box Skills metadata cards to a file.
This operation is performed by calling function `createBoxSkillCardsOnFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/post-files-id-metadata-global-box-skills-cards/).
[API Reference](https://developer.box.com/reference/post-files-id-metadata-global-boxSkillsCards/).

*Currently we don't have an example for calling `createBoxSkillCardsOnFile` in integration tests*

Expand Down Expand Up @@ -72,7 +72,7 @@ Updates one or more Box Skills metadata cards to a file.
This operation is performed by calling function `updateBoxSkillCardsOnFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/put-files-id-metadata-global-box-skills-cards/).
[API Reference](https://developer.box.com/reference/put-files-id-metadata-global-boxSkillsCards/).

*Currently we don't have an example for calling `updateBoxSkillCardsOnFile` in integration tests*

Expand Down Expand Up @@ -101,7 +101,7 @@ Removes any Box Skills cards metadata from a file.
This operation is performed by calling function `deleteBoxSkillCardsFromFile`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/delete-files-id-metadata-global-box-skills-cards/).
[API Reference](https://developer.box.com/reference/delete-files-id-metadata-global-boxSkillsCards/).

*Currently we don't have an example for calling `deleteBoxSkillCardsFromFile` in integration tests*

Expand Down

0 comments on commit 88c63c5

Please sign in to comment.