This repository has been archived by the owner on Jan 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Sarah Riehl
authored
Dec 27, 2023
1 parent
83029d0
commit dcf4840
Showing
1 changed file
with
4 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,9 @@ | ||
# BigCommerce API Specifications | ||
|
||
This repo contains the OpenAPI Specifications (OAS) and JSON schema that form the human-readable [BigCommerce REST API Reference](https://developer.bigcommerce.com/docs/api). | ||
**As of December 27, 2023, you can find all the public BigCommerce DevDocs at [https://github.com/bigcommerce/docs](https://github.com/bigcommerce/docs)!** | ||
|
||
As of August 22, 2022, all API specification files are in OAS 3+ format. We also made significant changes to this repo in March 2023. Please update your fork to ensure you're working with the newest source files. | ||
This repository is archived and read only. The final commit has been tagged. | ||
|
||
## Contributing | ||
If you maintain API clients, the new [bigcommerce/docs](https://github.com/bigcommerce/docs) repo is now your source for the most up-to-date API specifications. | ||
|
||
If you're interested in contributing, see [CONTRIBUTING.md](CONTRIBUTING.md). | ||
|
||
## Directory structure | ||
|
||
```shell | ||
. | ||
├── .github/ # github config | ||
└── workflows/ # workflows to lint pull requests, etc. | ||
├── .idea/ # directory ignored by git - use for yourself | ||
├── models/ # yml schema for various objects | ||
├── email_templates/ # email template schemas | ||
├── webhooks/ # webhooks schemas | ||
└── json2schema.py # script to convert json to yml | ||
├── reference/ # openapi specification files | ||
├── catalog/ # catalog OAS API reference | ||
├── payments/ # payments OAS API reference | ||
└── ... # other OAS API reference | ||
├── .eslintrc.json # config for MDX linter | ||
├── .gitignore # gitignore | ||
├── .spectral.yaml # config for OAS linter | ||
├── CONTRIBUTING # guidelines for contribution | ||
├── package-lock.json | ||
├── package.json | ||
├── pull_request_template.md # template for most pull requests | ||
└── README | ||
``` | ||
This consolidation lets the BigCommerce DX team offer a more streamlined developer experience. [issues](https://github.com/bigcommerce/docs/issues), [discussions](https://github.com/bigcommerce/docs/discussions), and [pull requests](https://github.com/bigcommerce/docs/pulls) at [bigcommerce/docs](https://github.com/bigcommerce/docs)! |