becastha / box-openapi

OpenAPI 3.0 Specification for the Box APIs

Box OpenAPI 3.0 Specification

This repository contains the build system for the Box OpenAPI 3.0 Specification (OAS3) of the Box Platform API.

Downloads

The main branch of this repository only contains the raw source for the specification. For a combined, resolved version please have a look at the following builds.

Swagger 2.0

The older and incomplete Swagger 2.0 specification is still available on the Swagger 2.0 branch.

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 OpenAPI structure and custom attributes
4. Adding a new API resource
5. Base, mini, standard, and full API resources
6. Adding a new API endpoint
7. Contributing a pull request
8. Markdown styleguide
9. 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.