Skip to content

Commit cde305d

Browse files
Fix spelling errors
1 parent 8e6573f commit cde305d

10 files changed

+36
-26
lines changed

.github/spellcheck-wordlist.txt

+10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
ACL
22
ActionScript
3+
analytics
34
bool
5+
boolean
6+
backorders
47
Braintree
58
Browsersync
69
Captcha
@@ -10,6 +13,7 @@ CMS
1013
Cron
1114
CVE
1215
CodeQL
16+
config
1317
DevOps
1418
DDEV
1519
DNS
@@ -18,6 +22,7 @@ EAV
1822
Emmet
1923
FireGento
2024
FPC
25+
frontend
2126
Gitpod
2227
HiPay
2328
Homebrew
@@ -52,20 +57,25 @@ PHPStan
5257
PhpStorm
5358
PHPUnit
5459
PLAINTEXT
60+
programmatically
5561
RCE
5662
reCaptcha
5763
Redis
5864
RPC
5965
RSS
6066
RWD
67+
runtime
6168
SCSS
6269
SHA
70+
sku
6371
SKU
72+
SKUs
6473
SMTP
6574
SSL
6675
TinyMCE
6776
toc
6877
URI
78+
un
6979
Varien
7080
VMware
7181
WAMP

docs/content/api/jsonrpc/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The JSON-RPC adapter is implemented in `Mage_Api_Model_Server_Adapter_Jsonrpc` a
3333

3434
## Authentication
3535

36-
To use the OpenMage API, you must either authenticate with the login method to obtain a session ID and inlcude this session ID with all subsequent API calls, or use the HTTP Basic Authentication method. The HTTP Basic Authentication method allows you to skip the login step and use your API credentials directly in the request which is simpler for many use cases, but does expose your credentials in each request whereas the session ID expires and needs to be refreshed periodically.
36+
To use the OpenMage API, you must either authenticate with the login method to obtain a session ID and include this session ID with all subsequent API calls, or use the HTTP Basic Authentication method. The HTTP Basic Authentication method allows you to skip the login step and use your API credentials directly in the request which is simpler for many use cases, but does expose your credentials in each request whereas the session ID expires and needs to be refreshed periodically.
3737

3838
### Login Authentication Process
3939

docs/content/api/jsonrpc/resources/catalog_category.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Catalog Category API allows you to manage product categories in your OpenMag
66

77
## Available Methods
88

9-
### currentStore
9+
### `currentStore`
1010

1111
Sets the current store for category operations.
1212

@@ -430,7 +430,7 @@ Delete category.
430430
- `not_deleted` - Category could not be deleted
431431
- `not_exists` - Category does not exist
432432

433-
### assignedProducts
433+
### `assignedProducts`
434434

435435
Retrieve list of assigned products to category.
436436

@@ -488,7 +488,7 @@ Retrieve list of assigned products to category.
488488
}
489489
```
490490

491-
### assignProduct
491+
### `assignProduct`
492492

493493
Assign product to category.
494494

@@ -534,7 +534,7 @@ Assign product to category.
534534
- `not_exists` - Category does not exist
535535
- `product_not_exists` - Product does not exist
536536

537-
### updateProduct
537+
### `updateProduct`
538538

539539
Update product assignment.
540540

@@ -581,7 +581,7 @@ Update product assignment.
581581
- `product_not_exists` - Product does not exist
582582
- `product_not_assigned` - Product is not assigned to the category
583583

584-
### removeProduct
584+
### `removeProduct`
585585

586586
Remove product assignment from category.
587587

docs/content/api/jsonrpc/resources/catalog_product.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -477,8 +477,8 @@ Update product special price.
477477

478478
- `productId` (int|string, required) - Product ID or SKU
479479
- `specialPrice` (float, optional) - Special price
480-
- `fromDate` (string, optional) - Special price from date (format: YYYY-MM-DD)
481-
- `toDate` (string, optional) - Special price to date (format: YYYY-MM-DD)
480+
- `fromDate` (string, optional) - Special price from date (format: `YYYY-MM-DD`)
481+
- `toDate` (string, optional) - Special price to date (format: `YYYY-MM-DD`)
482482
- `store` (string|int, optional) - Store ID or code
483483

484484
**Return**:

docs/content/api/jsonrpc/resources/catalog_product_attribute.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -454,9 +454,9 @@ Get full information about attribute with list of options.
454454
}
455455
```
456456

457-
### addOption
457+
### `addOption`
458458

459-
Add option to select or multiselect attribute.
459+
Add option to select or multi-select attribute.
460460

461461
**Method Name**: `catalog_product_attribute.addOption`
462462

@@ -514,9 +514,9 @@ Add option to select or multiselect attribute.
514514
- `invalid_frontend_input` - Invalid frontend input type
515515
- `unable_to_add_option` - Unable to add option
516516

517-
### removeOption
517+
### `removeOption`
518518

519-
Remove option from select or multiselect attribute.
519+
Remove option from select or multi-select attribute.
520520

521521
**Method Name**: `catalog_product_attribute.removeOption`
522522

@@ -693,7 +693,7 @@ Remove attribute set.
693693
- `attribute_set_has_related_products` - Attribute set has related products
694694
- `remove_attribute_set_error` - Error removing attribute set
695695

696-
### attributeAdd
696+
### `attributeAdd`
697697

698698
Add attribute to attribute set.
699699

@@ -741,7 +741,7 @@ Add attribute to attribute set.
741741
- `attribute_is_already_in_set` - Attribute is already in set
742742
- `add_attribute_error` - Error adding attribute
743743

744-
### attributeRemove
744+
### `attributeRemove`
745745

746746
Remove attribute from attribute set.
747747

@@ -786,7 +786,7 @@ Remove attribute from attribute set.
786786
- `attribute_is_not_in_set` - Attribute is not in set
787787
- `remove_attribute_error` - Error removing attribute
788788

789-
### groupAdd
789+
### `groupAdd`
790790

791791
Create group within existing attribute set.
792792

@@ -829,7 +829,7 @@ Create group within existing attribute set.
829829
- `group_already_exists` - Group already exists
830830
- `group_add_error` - Error adding group
831831

832-
### groupRename
832+
### `groupRename`
833833

834834
Rename existing group.
835835

@@ -872,7 +872,7 @@ Rename existing group.
872872
- `invalid_attribute_group_id` - Invalid attribute group ID
873873
- `group_rename_error` - Error renaming group
874874

875-
### groupRemove
875+
### `groupRemove`
876876

877877
Remove group from existing attribute set.
878878

docs/content/api/jsonrpc/resources/cataloginventory_stock_item.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Update stock information for a product.
171171
- `product_not_exists` - Product does not exist
172172
- `data_invalid` - Invalid data provided
173173

174-
### multiUpdate
174+
### `multiUpdate`
175175

176176
Update stock information for multiple products in a single call.
177177

docs/content/api/jsonrpc/resources/customer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Create new customer.
185185
- `middlename` (string, optional) - Customer middle name
186186
- `prefix` (string, optional) - Name prefix
187187
- `suffix` (string, optional) - Name suffix
188-
- `dob` (string, optional) - Date of birth (format: YYYY-MM-DD)
188+
- `dob` (string, optional) - Date of birth (format: `YYYY-MM-DD`)
189189
- `taxvat` (string, optional) - Tax/VAT number
190190
- `is_subscribed` (boolean, optional) - Whether customer is subscribed to newsletter
191191
- `store_id` (int, optional) - Store ID

docs/content/api/jsonrpc/resources/sales_order_creditmemo.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ Create a new credit memo for an order.
251251
- `order_not_refundable` - Order cannot be refunded
252252
- `data_invalid` - Invalid data provided
253253

254-
### addComment
254+
### `addComment`
255255

256256
Add a comment to a credit memo.
257257

docs/content/api/jsonrpc/resources/sales_order_invoice.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ Create a new invoice for an order.
239239
- `order_not_invoiceable` - Order cannot be invoiced
240240
- `data_invalid` - Invalid data provided
241241

242-
### addComment
242+
### `addComment`
243243

244244
Add a comment to an invoice.
245245

docs/content/api/jsonrpc/resources/sales_order_shipment.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Create a new shipment for an order.
236236
- `order_not_shippable` - Order cannot be shipped
237237
- `data_invalid` - Invalid data provided
238238

239-
### addComment
239+
### `addComment`
240240

241241
Add a comment to a shipment.
242242

@@ -280,7 +280,7 @@ Add a comment to a shipment.
280280

281281
- `shipment_not_exists` - Shipment does not exist
282282

283-
### addTrack
283+
### `addTrack`
284284

285285
Add tracking information to a shipment.
286286

@@ -325,7 +325,7 @@ Add tracking information to a shipment.
325325
- `shipment_not_exists` - Shipment does not exist
326326
- `data_invalid` - Invalid data provided
327327

328-
### removeTrack
328+
### `removeTrack`
329329

330330
Remove tracking information from a shipment.
331331

@@ -368,7 +368,7 @@ Remove tracking information from a shipment.
368368
- `shipment_not_exists` - Shipment does not exist
369369
- `track_not_exists` - Tracking information does not exist
370370

371-
### sendInfo
371+
### `sendInfo`
372372

373373
Send shipment information to the customer.
374374

@@ -410,7 +410,7 @@ Send shipment information to the customer.
410410

411411
- `shipment_not_exists` - Shipment does not exist
412412

413-
### getCarriers
413+
### `getCarriers`
414414

415415
Get list of available shipping carriers.
416416

0 commit comments

Comments
 (0)