-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into DEVDOCS-5797-pci
- Loading branch information
Showing
801 changed files
with
130,904 additions
and
28,536 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 |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| name: "\U0001F41E\U0001F4DD Bug report" | ||
| about: You've identified a bug in our docs. | ||
| title: "[x] is not working when I [y]" | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| We really appreciate the help making our docs better. Every issue helps! | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
|
|
||
| Please link to a repo that can be used to reproduce this issue, if possible. It'll help fix the bug faster. | ||
|
|
||
| **Expected behavior** | ||
| A clear and concise description of the bug you've identified. | ||
|
|
||
| **Screenshots** | ||
| If applicable, add screenshots to help explain the bug you've identified. | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. |
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 |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Have questions? | ||
| url: https://developer.bigcommerce.com/docs/build | ||
| about: | ||
| Explore the dev docs. | ||
| - name: Feature request | ||
| url: https://github.com/bigcommerce/docs/discussions/new?category=ideas-feature-requests | ||
| about: | ||
| Join us in Discussions to share your idea on improving our docs. Thanks for your contribution! | ||
| - name: Need help with our docs? | ||
| url: https://support.bigcommerce.com/s/contact | ||
| about: | ||
| To report an outage or greater platform issue, contact our Technical Support team. If you're a partner, please do so via your Partner Portal. | ||
| - name: 💙 Join the BigCommerceDevs community | ||
| url: https://developer.bigcommerce.com/community | ||
| about: Connect with other devs building on BigCommerce! | ||
|
|
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
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
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
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
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,93 +1,44 @@ | ||
| extends: spectral:oas | ||
| rules: | ||
| info-contact: off | ||
| oas3-unused-component: off | ||
| oas2-unused-definition: off | ||
| except: | ||
| 'reference/tax_provider.yml': | ||
| - oas3-schema | ||
| 'reference/carts.v3.yml': | ||
| - oas2-oneOf | ||
| - oas2-valid-schema-example | ||
| - operation-tag-defined | ||
| 'reference/catalog.v3.yml': | ||
| - oas2-operation-security-defined | ||
| - oas3-schema | ||
| - oas2-schema | ||
| - oas2-valid-media-example | ||
| - oas2-valid-schema-example | ||
| 'reference/channels.v3.yml': | ||
| - oas3-schema | ||
| - oas3-valid-media-example | ||
| 'reference/current_customer.yml': | ||
| - operation-success-response | ||
| 'reference/custom-template-associations.v3.yml': | ||
| - openapi-tags | ||
| - operation-tag-defined | ||
| 'reference/customer_login.yml': | ||
| - operation-success-response | ||
| 'reference/email_templates.v3.yml': | ||
| - oas3-schema | ||
| 'reference/geography.v2.yml': | ||
| - oas2-valid-media-example | ||
| 'reference/orders.v2.oas2.yml': | ||
| - oas3-valid-schema-example | ||
| - oas3-valid-media-example | ||
| - oas3-schema | ||
| 'reference/orders.v3.yml': | ||
| - oas2-valid-schema-example | ||
| - oas2-valid-media-example | ||
| - oas2-anyOf | ||
| 'reference/settings.v3.yml': | ||
| - oas3-valid-media-example | ||
| 'reference/sites.v3.yml': | ||
| - oas2-valid-media-example | ||
| 'reference/store_information.v2.yml': | ||
| - oas2-valid-media-example | ||
| - oas2-valid-schema-example | ||
| 'reference/themes.v3.yml': | ||
| - oas3-schema | ||
| 'reference/webhooks.v3.yml': | ||
| - oas3-valid-media-example | ||
| 'carts.v3.yml': | ||
| - oas2-oneOf | ||
| - oas2-valid-schema-example | ||
| 'catalog.v3.yml': | ||
| - oas2-operation-security-defined | ||
| - oas3-schema | ||
| - oas2-schema | ||
| - oas2-valid-media-example | ||
| - oas2-valid-schema-example | ||
| 'channels.v3.yml': | ||
| - oas3-schema | ||
| - oas3-valid-media-example | ||
| 'current_customer.yml': | ||
| - operation-success-response | ||
| 'customer_login.yml': | ||
| - operation-success-response | ||
| 'email_templates.v3.yml': | ||
| - oas3-schema | ||
| 'geography.v2.yml': | ||
| - oas2-valid-media-example | ||
| 'orders.v2.oas2.yml': | ||
| - oas3-valid-schema-example | ||
| - oas3-valid-media-example | ||
| - oas3-schema | ||
| 'orders.v3.yml': | ||
| - oas2-valid-schema-example | ||
| - oas2-valid-media-example | ||
| - oas2-anyOf | ||
| 'settings.v3.yml': | ||
| - oas3-valid-media-example | ||
| 'sites.v3.yml': | ||
| - oas2-valid-media-example | ||
| 'store_information.v2.yml': | ||
| - oas2-valid-media-example | ||
| - oas2-valid-schema-example | ||
| 'themes.v3.yml': | ||
| - oas3-schema | ||
| 'webhooks.v3.yml': | ||
| - oas3-valid-media-example | ||
| 'pages.v3.yml': | ||
| - oas3-valid-media-example | ||
| - oas3-valid-schema-example | ||
| properties-type-object: | ||
| description: "type: object must have a properties sibling." | ||
| given: "$..[?(@ && @.type == 'object')]" | ||
| severity: error | ||
| # must not be resolved because $ref-defined objects shall have its type | ||
| # defined in the referenced schema, not the referencing field (and $ref | ||
| # must be the only property, anyway) | ||
| resolved: false | ||
| # type field must be defined and contain the value object | ||
| then: | ||
| - field: "properties" | ||
| function: "truthy" | ||
| items-type-array: | ||
| description: "type: array must have an items sibling." | ||
| given: "$..[?(@ && @.type == 'array')]" | ||
| severity: error | ||
| # must not be resolved because $ref-defined objects shall have its type | ||
| # defined in the referenced schema, not the referencing field (and $ref | ||
| # must be the only property, anyway) | ||
| resolved: false | ||
| # type field must be defined and contain the value object | ||
| then: | ||
| - field: "items" | ||
| function: "truthy" | ||
| type-object-properties: | ||
| description: "Objects with properties must have type: object." | ||
| given: "$..[?(@ && @.properties)]" | ||
| severity: error | ||
| # must not be resolved because $ref-defined objects shall have its type | ||
| # defined in the referenced schema, not the referencing field (and $ref | ||
| # must be the only property, anyway) | ||
| resolved: false | ||
| # type field must be defined and contain the value object | ||
| then: | ||
| - field: "type" | ||
| function: defined | ||
| - field: "type" | ||
| function: enumeration | ||
| functionOptions: | ||
| values: | ||
| - object |
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
Oops, something went wrong.