Skip to content

Commit b93df54

Browse files
claudiosanchesclaudiosanches
committed
Updated download ID description
Closes woocommerce#130
1 parent faf2d4e commit b93df54

File tree

6 files changed

+117
-117
lines changed

6 files changed

+117
-117
lines changed

‎source/includes/v2/_products.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ This section lists all API that can be used to create, edit or otherwise manipul
115115

116116
| Attribute | Type | Description |
117117
| --------- | ------ | ------------------------------------------------------------------- |
118-
| `id` | string | File ID (file md5 hash) <i class="label label-info">read-only</i> |
118+
| `id` | string | File ID (File ID) <i class="label label-info">read-only</i> |
119119
| `name` | string | File name |
120120
| `file` | string | File URL. In write-mode you can use this property to send new files |
121121

‎source/includes/v3/_products.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ This section lists all API endpoints that can be used to create, edit or otherwi
125125

126126
| Attribute | Type | Description |
127127
| --------- | ------ | ------------------------------------------------------------------- |
128-
| `id` | string | File ID (file md5 hash) <i class="label label-info">read-only</i> |
128+
| `id` | string | File ID (File ID) <i class="label label-info">read-only</i> |
129129
| `name` | string | File name |
130130
| `file` | string | File URL. In write-mode you can use this property to send new files |
131131

‎source/includes/wp-api-v1/_products.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The products API allows you to create, view, update, and delete individual, or a
44

55
## Product properties ##
66

7-
| Attribute | Type | Description |
7+
| Attribute | Type | Description |
88
|----------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
99
| `id` | integer | Unique identifier for the resource. <i class="label label-info">read-only</i> |
1010
| `name` | string | Product name. |
@@ -70,39 +70,39 @@ The products API allows you to create, view, update, and delete individual, or a
7070

7171
### Download properties ###
7272

73-
| Attribute | Type | Description |
73+
| Attribute | Type | Description |
7474
|-----------|--------|----------------------------------------------------------------------|
75-
| `id` | string | File MD5 hash. <i class="label label-info">read-only</i> |
75+
| `id` | string | File ID. |
7676
| `name` | string | File name. |
7777
| `file` | string | File URL. In write-mode you can use this property to send new files. |
7878

7979
### Dimension properties ###
8080

81-
| Attribute | Type | Description |
81+
| Attribute | Type | Description |
8282
|-----------|--------|-----------------------------------|
8383
| `length` | string | Product length in decimal format. |
8484
| `width` | string | Product width in decimal format. |
8585
| `height` | string | Product height in decimal format. |
8686

8787
### Category properties ###
8888

89-
| Attribute | Type | Description |
89+
| Attribute | Type | Description |
9090
|-----------|---------|----------------------------------------------------------|
9191
| `id` | integer | Category ID. |
9292
| `name` | string | Category name. <i class="label label-info">read-only</i> |
9393
| `slug` | string | Category slug. <i class="label label-info">read-only</i> |
9494

9595
### Tag properties ###
9696

97-
| Attribute | Type | Description |
98-
|-----------|---------|----------------------------------------------------------|
97+
| Attribute | Type | Description |
98+
|-----------|---------|-----------------------------------------------------|
9999
| `id` | integer | Tag ID. |
100100
| `name` | string | Tag name. <i class="label label-info">read-only</i> |
101101
| `slug` | string | Tag slug. <i class="label label-info">read-only</i> |
102102

103103
### Image properties ###
104104

105-
| Attribute | Type | Description |
105+
| Attribute | Type | Description |
106106
|-----------------|-----------|---------------------------------------------------------------------------------------------------------|
107107
| `id` | integer | Image ID (attachment ID). In write-mode used to attach pre-existing images. |
108108
| `date_created` | date-time | The date the image was created, in the site's timezone. <i class="label label-info">read-only</i> |
@@ -114,7 +114,7 @@ The products API allows you to create, view, update, and delete individual, or a
114114

115115
### Attribute properties ###
116116

117-
| Attribute | Type | Description |
117+
| Attribute | Type | Description |
118118
|-------------|---------|-------------------------------------------------------------------------------------------------------------------|
119119
| `id` | integer | Attribute ID (required if is a global attribute). |
120120
| `name` | string | Attribute name (required if is a non-global attribute). |
@@ -125,15 +125,15 @@ The products API allows you to create, view, update, and delete individual, or a
125125

126126
### Default attribute properties ###
127127

128-
| Attribute | Type | Description |
128+
| Attribute | Type | Description |
129129
|-----------|---------|---------------------------------------------------------|
130130
| `id` | integer | Attribute ID (required if is a global attribute). |
131131
| `name` | string | Attribute name (required if is a non-global attribute). |
132132
| `option` | string | Selected attribute term name. |
133133

134134
### Variation properties ###
135135

136-
| Attribute | Type | Description |
136+
| Attribute | Type | Description |
137137
|----------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
138138
| `id` | integer | Variation ID. <i class="label label-info">read-only</i> |
139139
| `date_created` | date-time | The date the variation was created, in the site's timezone. <i class="label label-info">read-only</i> |
@@ -170,7 +170,7 @@ The products API allows you to create, view, update, and delete individual, or a
170170

171171
### Variation attribute properties ###
172172

173-
| Attribute | Type | Description |
173+
| Attribute | Type | Description |
174174
|-----------|---------|---------------------------------------------------------|
175175
| `id` | integer | Attribute ID (required if is a global attribute). |
176176
| `name` | string | Attribute name (required if is a non-global attribute). |
@@ -1889,7 +1889,7 @@ woocommerce.get("products").parsed_response
18891889

18901890
#### Available parameters ####
18911891

1892-
| Parameter | Type | Description |
1892+
| Parameter | Type | Description |
18931893
|------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------|
18941894
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. |
18951895
| `page` | integer | Current page of the collection. |
@@ -2236,7 +2236,7 @@ woocommerce.delete("products/162", force: true).parsed_response
22362236

22372237
#### Available parameters ####
22382238

2239-
| Parameter | Type | Description |
2239+
| Parameter | Type | Description |
22402240
|-----------|--------|---------------------------------------------------------------------------|
22412241
| `force` | string | Use `true` whether to permanently delete the product, Default is `false`. |
22422242

@@ -3343,7 +3343,7 @@ woocommerce.get("products/162/reviews/9").parsed_response
33433343

33443344
### Product review properties ###
33453345

3346-
| Attribute | Type | Description |
3346+
| Attribute | Type | Description |
33473347
|----------------|---------|----------------------------------------------------------------------------------------------------|
33483348
| `id` | integer | Unique identifier for the resource. <i class="label label-info">read-only</i> |
33493349
| `date_created` | string | The date the review was created, in the site's timezone. <i class="label label-info">read-only</i> |

‎source/includes/wp-api-v2/_index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -6307,7 +6307,7 @@ woocommerce.get("").parsed_response
63076307
"type": "object",
63086308
"properties": {
63096309
"id": {
6310-
"description": "File MD5 hash.",
6310+
"description": "File ID.",
63116311
"type": "string",
63126312
"context": [
63136313
"view",
@@ -6908,7 +6908,7 @@ woocommerce.get("").parsed_response
69086908
"type": "object",
69096909
"properties": {
69106910
"id": {
6911-
"description": "File MD5 hash.",
6911+
"description": "File ID.",
69126912
"type": "string",
69136913
"context": [
69146914
"view",
@@ -7487,7 +7487,7 @@ woocommerce.get("").parsed_response
74877487
"type": "object",
74887488
"properties": {
74897489
"id": {
7490-
"description": "File MD5 hash.",
7490+
"description": "File ID.",
74917491
"type": "string",
74927492
"context": [
74937493
"view",
@@ -8215,7 +8215,7 @@ woocommerce.get("").parsed_response
82158215
"type": "object",
82168216
"properties": {
82178217
"id": {
8218-
"description": "File MD5 hash.",
8218+
"description": "File ID.",
82198219
"type": "string",
82208220
"context": [
82218221
"view",
@@ -8513,7 +8513,7 @@ woocommerce.get("").parsed_response
85138513
"type": "object",
85148514
"properties": {
85158515
"id": {
8516-
"description": "File MD5 hash.",
8516+
"description": "File ID.",
85178517
"type": "string",
85188518
"context": [
85198519
"view",
@@ -8794,7 +8794,7 @@ woocommerce.get("").parsed_response
87948794
"type": "object",
87958795
"properties": {
87968796
"id": {
8797-
"description": "File MD5 hash.",
8797+
"description": "File ID.",
87988798
"type": "string",
87998799
"context": [
88008800
"view",

0 commit comments

Comments
 (0)