box / developer.box.com

Box Developer Documentation - Content & Configuration

Box Developer Documentation

This project contain the guides, pages, and microcopy for the Box Developer Documentation.

Visit developer.box.com for more details on the Box API Platform.

Development & Contribution

Please follow the contribution guidelines when contributing to the source of this project.

1. Installation & setup
2. Notes for Box employees
3. The project structure and frontmatter
4. Adding a new guide
5. Adding a new page
6. Adding a new quick start guide
7. Adding microcopy
8. Contributing a pull request
9. Markdown styleguide
10. Updating dependencies

Usage & License

Copyright 2020 Box, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

developer.box.com's Issues

Where is skill API/SDK link ?

Is it this ? link
Why there's no mention about how to obtain it elsewhere on Box document ?

Minor style issue with sub-bullets

On this page:
https://developer.box.com/en/guides/api-calls/permissions-and-errors/rate-limits/
there are four bullets under Search.

But on this page:
https://github.com/box/developer.box.com/blob/master/content/guides/api-calls/permissions-and-errors/rate-limits.md
it appears the there should be two main bullets, with the third and fourth being sub-bullets.

I didn't know what changes to make to the MD file to get the rendering to change, so I'm submitting it as an issue.

Does not provide URL in PHP

When using https://github.com/box-community/samples-docs-authenticate-with-jwt-api with PHP, trying to get the URL does not work. The response only provides the details/properties of the file. If the "direct link" setting is set on Box then you can see those parameters in the response, but it is not the same "https://dl.boxcloud.com..." link that gets generated with the SDK (node.js).

Replace use of whitelist with allowlist and blacklist with denylist

I am reading and working with Box API and I have noticed that they refer to blocklist as blacklist and allowlist as whitelist.

Considering a lot of argumentations, besides that those words are racists and we can't even use it as a verb.

Some discussions: https://twitter.com/dhh/status/1032050325513940992.

I think that Box could also follow the good exemples and replace theses terms.

Also:

Regardless of origin, allow/deny are simply clearer terms that does not require tracing the history of black/white as representations of that meaning. We can simply use the meaning directly.

Originally posted by @dhh in rails/rails#33677 (comment)

ContentUploader provided with ContentExplorer does not call requestInterceptor option

This screen shot shows the get request form the explorer view transforming the url to the needed proxy. When utilizing the requestInterceptor option.

But when utilizing the uploader. The requestInterceptor does not seem to get called. The url remains the "api.box.com", and the proxy server never receives the request.

Angular Application utilizing the cdn url import for the content-explorer
"dependencies": { "@angular/animations": "~12.0.5", "@angular/cdk": "^12.0.5", "@angular/common": "~12.0.5", "@angular/compiler": "~12.0.5", "@angular/core": "~12.0.5", "@angular/fire": "^6.1.5", "@angular/flex-layout": "^12.0.0-beta.34", "@angular/forms": "~12.0.5", "@angular/material": "^12.0.5", "@angular/platform-browser": "~12.0.5", "@angular/platform-browser-dynamic": "~12.0.5", "@angular/router": "~12.0.5", "@ng-web-apis/common": "^1.9.0", "@ng-web-apis/geolocation": "^1.0.4", "@ngxs-labs/firestore-plugin": "^0.1.30", "@ngxs/form-plugin": "^3.7.2", "@ngxs/router-plugin": "^3.7.2", "@ngxs/storage-plugin": "^3.7.2", "@ngxs/store": "^3.7.2", "@sentry/angular": "^6.7.2", "@sentry/tracing": "^6.7.2", "@turf/bbox": "^6.4.0", "firebase": "^8.6.8", "immer": "^9.0.3", "lodash": "^4.17.21", "moment": "^2.29.1", "ngx-sub-form": "^5.1.2", "rxfire": "^4.0.0", "rxjs": "~7.1.0", "tslib": "^2.3.0", "txml": "^4.0.1", "zone.js": "~0.11.4" }, "devDependencies": { "@angular-devkit/build-angular": "^12.0.5", "@angular/cli": "~12.0.5", "@angular/compiler-cli": "~12.0.5", "@angular/language-service": "^12.0.5", "@ngxs/devtools-plugin": "^3.7.2", "@ngxs/logger-plugin": "^3.7.2", "@semantic-release/changelog": "^5.0.1", "@semantic-release/git": "^9.0.0", "@turf/turf": "^6.4.0", "@types/google-apps-script": "^1.0.34", "@types/jasmine": "~3.7.7", "@types/jasminewd2": "~2.0.9", "@types/lodash": "^4.14.170", "@types/node": "^15.12.4", "codelyzer": "^6.0.2", "firebase-tools": "^9.14.0", "fuzzy": "^0.1.3", "inquirer": "^8.1.1", "inquirer-autocomplete-prompt": "^1.4.0", "jasmine-core": "~3.7.1", "jasmine-spec-reporter": "~7.0.0", "karma": "~6.3.4", "karma-chrome-launcher": "~3.1.0", "karma-coverage-istanbul-reporter": "~3.0.3", "karma-jasmine": "~4.0.1", "karma-jasmine-html-reporter": "^1.6.0", "open": "^8.2.1", "protractor": "~7.0.0", "ts-node": "~10.0.0", "tslint": "~6.1.3", "typescript": "~4.2.4" }

Adding Scrollbar on Left navigation popup will make it easy to see all contents

Hello,
Adding a scrollbar at the left navigation on Documentation page for JWT auth page and probably all other pages.
It Will make it easy for users to see all content.

The left pane pops up when we click on the menu option(3 horizontal lines) on the left of Guides

note:If zoom of browser is more than 100%

Chrome app SDK link 404s

Chrome app SDK link at the bottom of https://github.com/box/developer.box.com/blob/main/content/pages/sdks-and-tools/index.md 404s

with-sdk.md Warning block escapes hyperlink markdown

The "User types" hyperlink markdown appears to be escaped on this guide:
https://developer.box.com/guides/authentication/jwt/with-sdk/

I took a look at the .md file and nothing seems egregious, so I'm not sure why it's being escaped. If there's an easy fix, I'm happy to put up the PR!

<Message warning>
  # Service Accounts

  At this point the application is authenticated as an application user, not as
  a managed or app user. Head over to our guide on [User
  Types][g://authentication/user-types] to learn more about the different types
  of users.
</Message>

media download using MediaLibrary contain same name for all media.

When I download a media using box responded URL then a downloaded file gets download with the filename. If MediaLibrary process the same URL them it contains as download.png/jpeg. Is there any to send encoded filename along with media URL?

Replace @stoplight/json-schema-resolver

It seems @stoplight/json-schema-resolver has been deprecated. We should look at replacing it with https://github.com/APIDevTools/json-schema-ref-parser

Gap?

Are these gaps expected on the examples?

Directory to Box drive is an empty symlink

I'm sorry if it is not a right place for the issue.

Some of our customers use Box drive to store data. So we need to work with paths to Box drive. We use c++ boost filesystem library to process paths. The boost library considers path to Box: C:\Users\User\Box as an empty symlink, which is wrong. So we unable to work work with paths to Box.

Could there be any workaround or changes from your side?
We've already filled an issue to boost on github:
boostorg/filesystem#187.

Unfortunately there is no inclination for the issue to be fixed from the boost side.
Could it be some advice from your side?

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.