Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix natural language linting errors #356

Merged
merged 3 commits into from
Aug 20, 2024
Merged

Fix natural language linting errors #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52f85f6
Fix natural language linting errors
keharper Aug 20, 2024
394261c
Adding backticks to REST routes
keharper Aug 20, 2024
3b750a3
Edit textlint config
dshevtsov Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ threatening, offensive, or harmful.

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
representing a project or community include using an official project email
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
reported by contacting the project team at `[email protected]`. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
2 changes: 1 addition & 1 deletion .github/linters/.textlintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"rules": {
"terminology": {
"severity" : "warning",
"skip": ["Strong"],
"exclude": [
"back[- ]end(\\w*)",
"bug[- ]fix(es)?",
Expand All @@ -26,7 +27,6 @@
["bug-?fixes", "bug fixes"],
["indices\\b", "indexes"],
"macOS",
"ReadMe",
["smart[- ]phone(s)?", "smartphone$1"],
["spell[- ]?check(er|ing)", "spelling checker$1"],
"UNIX",
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,6 @@ The website in the public directory was generated for the Adobe Commerce with B2
npx apollo-cli download-schema $ENDPOINT_URL --output schema.json
```

where `$ENDPOINT_URL` is a placeholder for a URL's endpoint.
where `$ENDPOINT_URL` is a placeholder for the endpoint of a URL.

For more information about SpectaQL, refer to <https://github.com/anvilco/spectaql>.
2 changes: 1 addition & 1 deletion src/pages/graphql/schema/checkout/mutations/create-payment-order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Attribute | Data Type | Description
`location` | PaymentLocation! | The origin location for that payment request. The possible values are
PRODUCT_DETAIL, MINICART, CART, CHECKOUT, ADMIN
`methodCode` | String! | The code for the selected payment method
`paymentSource` | String! | The payment source for the payment method. The possible values are credit card (cc), PayPal (paypal), and Apple Pay (applepay)
`paymentSource` | String! | The payment source for the payment method. The possible values are credit card (`cc`), PayPal (`paypal`), and Apple Pay (`applepay`)
`vaultIntent` | Boolean | Indicates whether the payment information should be vaulted. This attribute is only applicable to the `hosted_fields` payment method. The default value is `false`

## Output attributes
Expand Down
2 changes: 1 addition & 1 deletion src/pages/graphql/schema/checkout/queries/get-payment-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ Attribute | Data Type | Description
`sort_order` | String | The relative order the payment method is displayed on the checkout page.
`title` | String! | The display name of the payment method.

The possible values for `payment_source` are credit card (cc), PayPal (paypal), Google Pay (googlepay), and Apple Pay (applepay) depending on the payment method.
The possible values for `payment_source` are credit card (`cc`), PayPal (`paypal`), Google Pay (`googlepay`), and Apple Pay (`applepay`), depending on the payment method.

The `GooglePayConfig` payment method configuration also has a `button_styles` object containing the following attributes:

Expand Down
2 changes: 1 addition & 1 deletion src/pages/graphql/schema/products/queries/url-resolver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The [`urlResolver`](https://developer.adobe.com/commerce/webapi/graphql-api/inde

## Example usage

### Query the URL's information
### Query information about the URL

The following query returns information about the URL containing `joust-duffle-bag.html`.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/graphql/schema/store/queries/country.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The [`country`](https://developer.adobe.com/commerce/webapi/graphql-api/index.ht

## Example usage

The following query uses a two-letter abbreviation for the country ID (id: "AU"), which returns information about Australia.
The following query uses a two-letter abbreviation for the country ID (`id: "AU"`), which returns information about Australia.

**Request:**

Expand Down
4 changes: 2 additions & 2 deletions src/pages/graphql/tutorials/checkout/create-cart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The customer created in the previous step does not have an active cart. The foll
```

In the subsequent tutorial steps, the unique shopping cart identifier `pXVxnNg4PFcK1lD60O5evqF7f4SkiRR1` will be listed as `{ CART_ID }`.
Copy the value of the id attribute. Use this value in subsequent steps wherever the { CART_ID } variable is specified.
Copy the value of the `id` attribute. Use this value in subsequent steps wherever the { CART_ID } variable is specified.

## Create a guest cart

Expand Down Expand Up @@ -76,7 +76,7 @@ mutation {
```

In the subsequent tutorial steps, the unique shopping cart identifier `A7jCcOmUjjCh7MxDIzu1SeqdqETqEa5h` will be listed as `{ CART_ID }`.
Copy the value of the id attribute. Use this value in subsequent steps wherever the { CART_ID } variable is specified.
Copy the value of the `id` attribute. Use this value in subsequent steps wherever the { CART_ID } variable is specified.

## Verify this step

Expand Down
2 changes: 1 addition & 1 deletion src/pages/graphql/usage/security-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To override these default values, create a custom module and provide a new value

In GraphQL, you can limit the maximum page size allowed. For information about how to enable and configure this feature, as well as additional arguments that are applicable to web APIs in general, see [API security](../../get-started/api-security.md).

## GraphQl module configuration
## `GraphQl` module configuration

The `GraphQl/etc/di.xml` file contains two arguments that can be overridden to enhance security and prevent performance bottlenecks:

Expand Down
6 changes: 3 additions & 3 deletions src/pages/rest/b2b/company-structures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ GET /V1/team/

Name | Description | Format | Requirements
--- | --- | --- | ---
id | System-generated team ID | integer | Not applicable for create operations.
name | The displayed name of the team | string | Required to create or update a team.
description | An optional description of the team. | string | Optional
`id` | System-generated team ID | integer | Not applicable for create operations.
`name` | The displayed name of the team | string | Required to create or update a team.
`description` | An optional description of the team. | string | Optional

### Create a team

Expand Down
152 changes: 76 additions & 76 deletions src/pages/rest/use-rest/anonymous-api-security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,37 +18,37 @@ The following table lists the APIs that are no longer available to an anonymous

| Product | Module | API | Action |
| --- | --- | --- | --- |
| Open Source | Catalog | /V1/products | GET |
| Open Source | Catalog | /V1/products/:sku | GET |
| Open Source | Catalog | /V1/products/attributes/:attributeCode | GET |
| Open Source | Catalog | /V1/products/types | GET |
| Open Source | Catalog | /V1/products/attribute-sets/sets/list | GET |
| Open Source | Catalog | /V1/products/attribute-sets/:attributeSetId | GET |
| Open Source | Catalog | /V1/products/attribute-sets/:attributeSetId/attributes | GET |
| Open Source | Catalog | /V1/products/attribute-sets/groups/list | GET |
| Open Source | Catalog | /V1/products/attributes/:attributeCode/options | GET |
| Open Source | Catalog | /V1/products/media/types/:attributeSetName | GET |
| Open Source | Catalog | /V1/products/:sku/media/:entryId | GET |
| Open Source | Catalog | /V1/products/:sku/media | GET |
| Open Source | Catalog | /V1/products/:sku/group-prices/:customerGroupId/tiers | GET |
| Open Source | Catalog | /V1/categories/:categoryId | GET |
| Open Source | Catalog | /V1/categories | GET |
| Open Source | Catalog | /V1/products/:sku/options | GET |
| Open Source | Catalog | /V1/products/:sku/options/:optionId | GET |
| Open Source | Catalog | /V1/products/links/types | GET |
| Open Source | Catalog | /V1/products/links/:type/attributes | GET |
| Open Source | Catalog | /V1/products/:sku/links/:type | GET |
| Open Source | Catalog | /V1/categories/:categoryId/products | GET |
| Open Source | CatalogInventory | /V1/stockStatuses/:productSku | GET |
| Open Source | Cms | /V1/cmsPage/:pageId | GET |
| Open Source | Cms | /V1/cmsBlock/:blockId | GET |
| Open Source | ConfigurableProduct | /V1/configurable-products/:sku/children | GET |
| Open Source | ConfigurableProduct | /V1/configurable-products/:sku/options/:id | GET |
| Open Source | ConfigurableProduct | /V1/configurable-products/:sku/options/all | GET |
| Open Source | Store | /V1/store/storeViews | GET |
| Open Source | Store | /V1/store/storeGroups | GET |
| Open Source | Store | /V1/store/websites | GET |
| Open Source | Store | /V1/store/storeConfigs | GET |
| Open Source | Catalog | `/V1/products` | GET |
| Open Source | Catalog | `/V1/products/:sku` | GET |
| Open Source | Catalog | `/V1/products/attributes/:attributeCode` | GET |
| Open Source | Catalog | `/V1/products/types` | GET |
| Open Source | Catalog | `/V1/products/attribute-sets/sets/list` | GET |
| Open Source | Catalog | `/V1/products/attribute-sets/:attributeSetId` | GET |
| Open Source | Catalog | `/V1/products/attribute-sets/:attributeSetId/attributes` | GET |
| Open Source | Catalog | `/V1/products/attribute-sets/groups/list` | GET |
| Open Source | Catalog | `/V1/products/attributes/:attributeCode/options` | GET |
| Open Source | Catalog | `/V1/products/media/types/:attributeSetName` | GET |
| Open Source | Catalog | `/V1/products/:sku/media/:entryId` | GET |
| Open Source | Catalog | `/V1/products/:sku/media` | GET |
| Open Source | Catalog | `/V1/products/:sku/group-prices/:customerGroupId/tiers` | GET |
| Open Source | Catalog | `/V1/categories/:categoryId` | GET |
| Open Source | Catalog | `/V1/categories` | GET |
| Open Source | Catalog | `/V1/products/:sku/options` | GET |
| Open Source | Catalog | `/V1/products/:sku/options/:optionId` | GET |
| Open Source | Catalog | `/V1/products/links/types` | GET |
| Open Source | Catalog | `/V1/products/links/:type/attributes` | GET |
| Open Source | Catalog | `/V1/products/:sku/links/:type` | GET |
| Open Source | Catalog | `/V1/categories/:categoryId/products` | GET |
| Open Source | CatalogInventory | `/V1/stockStatuses/:productSku` | GET |
| Open Source | Cms | `/V1/cmsPage/:pageId` | GET |
| Open Source | Cms | `/V1/cmsBlock/:blockId` | GET |
| Open Source | ConfigurableProduct | `/V1/configurable-products/:sku/children` | GET |
| Open Source | ConfigurableProduct | `/V1/configurable-products/:sku/options/:id` | GET |
| Open Source | ConfigurableProduct | `/V1/configurable-products/:sku/options/all` | GET |
| Open Source | Store | `/V1/store/storeViews` | GET |
| Open Source | Store | `/V1/store/storeGroups` | GET |
| Open Source | Store | `/V1/store/websites` | GET |
| Open Source | Store | `/V1/store/storeConfigs` | GET |

<InlineAlert variant="warning" slots="text"/>

Expand All @@ -65,48 +65,48 @@ The following APIs remain accessible to anonymous users. Most of these must rema

| Product | Module | API | Action |
| --- | --- | --- | --- |
| Open Source | Catalog | /V1/products-render-info | GET |
| Open Source | Checkout | /V1/guest-carts/:cartId/payment-information | POST |
| Open Source | Checkout | /V1/guest-carts/:cartId/payment-information | GET |
| Open Source | Checkout | /V1/guest-carts/:cartId/set-payment-information | POST |
| Open Source | Checkout | /V1/guest-carts/:cartId/shipping-information | POST |
| Open Source | Checkout | /V1/guest-carts/:cartId/totals-information | POST |
| Open Source | Customer | /V1/customers | POST |
| Open Source | Customer | /V1/customers/:customerId/password/resetLinkToken/:resetPasswordLinkToken | GET |
| Open Source | Customer | /V1/customers/password | PUT |
| Open Source | Customer | /V1/customers/resetPassword | POST |
| Open Source | Customer | /V1/customers/isEmailAvailable | POST |
| Open Source | Directory | /V1/directory/countries | GET |
| Open Source | Directory | /V1/directory/countries/:countryId | GET |
| Open Source | Directory | /V1/directory/currency | GET |
| Open Source | GiftMessage | /V1/guest-carts/:cartId/gift-message | GET |
| Open Source | GiftMessage | /V1/guest-carts/:cartId/gift-message | POST |
| Open Source | GiftMessage | /V1/guest-carts/:cartId/gift-message/:itemId | GET |
| Open Source | GiftMessage | /V1/guest-carts/:cartId/gift-message/:itemId | POST |
| Open Source | Integration | /V1/integration/admin/token | POST |
| Open Source | Integration | /V1/integration/customer/token | POST |
| Open Source | Quote | /V1/guest-carts/:cartId/billing-address | GET |
| Open Source | Quote | /V1/guest-carts/:cartId/billing-address | POST |
| Open Source | Quote | /V1/guest-carts/:cartId/items | GET |
| Open Source | Quote | /V1/guest-carts/:cartId/items | POST |
| Open Source | Quote | /V1/guest-carts/:cartId/items/:itemId | PUT |
| Open Source | Quote | /V1/guest-carts/:cartId/items/:itemId | DELETE |
| Open Source | Quote | /V1/guest-carts | POST |
| Open Source | Quote | /V1/guest-carts/:cartId/order | PUT |
| Open Source | Quote | /V1/guest-carts/:cartId | GET |
| Open Source | Quote | /V1/guest-carts/:cartId/collect-totals | PUT |
| Open Source | Quote | /V1/guest-carts/:cartId/totals | GET |
| Open Source | Quote | /V1/guest-carts/:cartId/coupons | GET |
| Open Source | Quote | /V1/guest-carts/:cartId/coupons/:couponCode | PUT |
| Open Source | Quote | /V1/guest-carts/:cartId/coupons | DELETE |
| Open Source | Quote | /V1/guest-carts/:cartId/selected-payment-method | GET |
| Open Source | Quote | /V1/guest-carts/:cartId/selected-payment-method | PUT |
| Open Source | Quote | /V1/guest-carts/:cartId/payment-methods | GET |
| Open Source | Quote | /V1/guest-carts/:cartId/estimate-shipping-methods | POST |
| Open Source | Quote | /V1/guest-carts/:cartId/shipping-methods | GET |
| Open Source | Search | /V1/search | GET |
| Commerce | GiftCardAccount | /V1/carts/guest-carts/:cartId/giftCards/:giftCardCode | DELETE |
| Commerce | GiftCardAccount | /V1/carts/guest-carts/:cartId/giftCards | POST |
| Commerce | GiftCardAccount | /V1/carts/guest-carts/:cartId/checkGiftCard/:giftCardCode | GET |
| Commerce | GiftRegistry | /V1/guest-giftregistry/:cartId/estimate-shipping-methods | POST |
| Commerce | WorldPay | /V1/worldpay-guest-carts/:cartId/payment-information | POST
| Open Source | Catalog | `/V1/products-render-info` | GET |
| Open Source | Checkout | `/V1/guest-carts/:cartId/payment-information` | POST |
| Open Source | Checkout | `/V1/guest-carts/:cartId/payment-information` | GET |
| Open Source | Checkout | `/V1/guest-carts/:cartId/set-payment-information` | POST |
| Open Source | Checkout | `/V1/guest-carts/:cartId/shipping-information` | POST |
| Open Source | Checkout | `/V1/guest-carts/:cartId/totals-information` | POST |
| Open Source | Customer | `/V1/customers` | POST |
| Open Source | Customer | `/V1/customers/:customerId/password/resetLinkToken/:resetPasswordLinkToken` | GET |
| Open Source | Customer | `/V1/customers/password` | PUT |
| Open Source | Customer | `/V1/customers/resetPassword` | POST |
| Open Source | Customer | `/V1/customers/isEmailAvailable` | POST |
| Open Source | Directory | `/V1/directory/countries` | GET |
| Open Source | Directory | `/V1/directory/countries/:countryId` | GET |
| Open Source | Directory | `/V1/directory/currency` | GET |
| Open Source | GiftMessage | `/V1/guest-carts/:cartId/gift-message` | GET |
| Open Source | GiftMessage | `/V1/guest-carts/:cartId/gift-message` | POST |
| Open Source | GiftMessage | `/V1/guest-carts/:cartId/gift-message/:itemId` | GET |
| Open Source | GiftMessage | `/V1/guest-carts/:cartId/gift-message/:itemId` | POST |
| Open Source | Integration | `/V1/integration/admin/token` | POST |
| Open Source | Integration | `/V1/integration/customer/token` | POST |
| Open Source | Quote | `/V1/guest-carts/:cartId/billing-address` | GET |
| Open Source | Quote | `/V1/guest-carts/:cartId/billing-address` | POST |
| Open Source | Quote | `/V1/guest-carts/:cartId/items` | GET |
| Open Source | Quote | `/V1/guest-carts/:cartId/items` | POST |
| Open Source | Quote | `/V1/guest-carts/:cartId/items/:itemId` | PUT |
| Open Source | Quote | `/V1/guest-carts/:cartId/items/:itemId` | DELETE |
| Open Source | Quote | `/V1/guest-carts` | POST |
| Open Source | Quote | `/V1/guest-carts/:cartId/order` | PUT |
| Open Source | Quote | `/V1/guest-carts/:cartId` | GET |
| Open Source | Quote | `/V1/guest-carts/:cartId/collect-totals` | PUT |
| Open Source | Quote | `/V1/guest-carts/:cartId/totals` | GET |
| Open Source | Quote | `/V1/guest-carts/:cartId/coupons` | GET |
| Open Source | Quote | `/V1/guest-carts/:cartId/coupons/:couponCode` | PUT |
| Open Source | Quote | `/V1/guest-carts/:cartId/coupons` | DELETE |
| Open Source | Quote | `/V1/guest-carts/:cartId/selected-payment-method` | GET |
| Open Source | Quote | `/V1/guest-carts/:cartId/selected-payment-method` | PUT |
| Open Source | Quote | `/V1/guest-carts/:cartId/payment-methods` | GET |
| Open Source | Quote | `/V1/guest-carts/:cartId/estimate-shipping-methods` | POST |
| Open Source | Quote | `/V1/guest-carts/:cartId/shipping-methods` | GET |
| Open Source | Search | `/V1/search` | GET |
| Commerce | GiftCardAccount | `/V1/carts/guest-carts/:cartId/giftCards/:giftCardCode` | DELETE |
| Commerce | GiftCardAccount | `/V1/carts/guest-carts/:cartId/giftCards` | POST |
| Commerce | GiftCardAccount | `/V1/carts/guest-carts/:cartId/checkGiftCard/:giftCardCode` | GET |
| Commerce | GiftRegistry | `/V1/guest-giftregistry/:cartId/estimate-shipping-methods` | POST |
| Commerce | WorldPay | `/V1/worldpay-guest-carts/:cartId/payment-information` | POST
Loading