Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Commit

Permalink
merge current main
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarah Riehl committed Dec 26, 2023
2 parents 120c614 + e8d2814 commit bcf6a19
Show file tree
Hide file tree
Showing 155 changed files with 31,300 additions and 46,385 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# These owners will be the default owners for everything in the repo. Unless a later match takes precedence, @global-owner1 and @global-owner2 will be requested for review when someone opens a pull request.

@slsriehl @bigcommerce/devdocs-codeowners @markcmurphy
@slsriehl @bigcommerce/dev-docs-team @markcmurphy

# Teams can be specified as code owners as well. Teams should
# be identified in the format @org/team-name. Teams must have
Expand Down
9 changes: 0 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE/publication_pr_template.md

This file was deleted.

7 changes: 0 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

This file was deleted.

18 changes: 18 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Deploy

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Trigger Vercel Deploy Hook
run: |
curl -X POST ${{ secrets.VERCEL_DEPLOY_HOOK_URL }}
34 changes: 0 additions & 34 deletions .stoplight.json

This file was deleted.

20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Contributing to BigCommerce's API Specifications

Thanks for showing interest in contributing!
Thanks for your interest in contributing!

## Edit
* **Edit:** Fork the repository and edit with your preferred editor (we recommend [VS Code](https://code.visualstudio.com/) or [Stoplight Studio](https://meta.stoplight.io/docs/studio)).
* **Lint:** Check for errors using [Spectral](https://stoplight.io/open-source/spectral).
* **Commit:** Write good commit messages using the guidelines in the following section

* **Edit:** Fork the repository and edit with your preferred editor. We recommend [VS Code](https://code.visualstudio.com/).
* **Lint:** Check for errors using [Spectral](https://stoplight.io/open-source/spectral) or another OAS linter.

* **Commit:** Write good commit messages using the guidelines in the following section.
* **Push** to your fork to ensure that your pull request contains the most up-to-date version of your code.

## Write descriptive commit messages
Expand All @@ -16,20 +18,18 @@ Thanks for showing interest in contributing!
* Use the imperative mood ("Fix broken link to x" not "Fixes broken link to x").

## Pull request
[What is a pull request?](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)

Internal users: Consult the repo's `internal_pr_template` to learn more about our pull request process. Then use the template to create your PR's description.
[What is a pull request?](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)

External users: Consult the repo's `external_pr_template` to learn more about our pull request process. Then use the template to create your PR's description.
Use the included `pull_request_template.md` to tell us more about the changes you propose.

## Tools

The following tools might be helpful.

| Tool | Description |
|:-----|:------------|
| [BigCommerce Stoplight Workspace](https://bigcommerce.stoplight.io/) | Our hosted documentation back end. <br> Contains editing tools for internal users.|
| [Spectral CLI](https://stoplight.io/open-source/spectral) | Node.js CLI for Stoplight's OpenAPI linter |
| [Spectral Linter for VS Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)| Stoplight's OpenAPI linter as a VS Code extension |
| [Spectral CLI](https://stoplight.io/open-source/spectral) | Node.js CLI for the Spectral OpenAPI linter |
| [Spectral Linter for VS Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)| The Spectral OpenAPI linter as a VS Code extension |
| [swagger2openapi](https://www.npmjs.com/package/swagger2openapi)| Node.js CLI for converting Swagger to OpenAPI 3.0 |
| [openapi.tools](https://openapi.tools/) | List of open-source OpenAPI tools |
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
# BigCommerce API Specifications

OpenAPI Specifications (OAS) and JSON schema used to generate the human-readable [BigCommerce API Reference](https://developer.bigcommerce.com/api-reference).
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).

<!-- theme: info -->
> #### OAS updates
> As of August 22, 2022, all API specification files are in OAS 3+ format. Please update your forks to ensure you're working with the newest source files.
>
> **Caveat:** The file that contains webhook events callback schemas, `webhooks_events.yml`, is still in Swagger 2.0 format.
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.

## Contributing

If you're interested in contributing, see [CONTRIBUTING.md](CONTRIBUTING.md).

## Directory structure

```shell
.
├── .circleci # config for circleci job that runs openapi linter
└── config.yml # - docs: https://meta.stoplight.io/docs/spectral
├── docs # markdown files
├── models # yaml schema for various objects
├── ...
└── json2schema.py # script to easily convert json data to yaml schema
├── reference # openapi specification files
├── .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 stoplight spectral openapi linter
├── .stoplight.json # Stoplight Platform edit view configuration file
├── CONTRIBUTING.md # guidelines for contribution
├── pull_request_template_CODEOWNER.md # template for codeowner dev merges
├── pull_request_template.md # template for most pull requests
└── toc.json # Stoplight Platform table of contents configuration file
├── .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
```

## Contributing

If you're interested in contributing, see [CONTRIBUTING.md](CONTRIBUTING.md).
30 changes: 0 additions & 30 deletions assets/html/graphql-explorer.html

This file was deleted.

11,865 changes: 0 additions & 11,865 deletions assets/html/graphql-playground.html

This file was deleted.

64 changes: 0 additions & 64 deletions docs/available-apis.mdx

This file was deleted.

Loading

0 comments on commit bcf6a19

Please sign in to comment.