Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 68bbdb0

Browse files
dewimagentokeharper
authored andcommitted
Update users.md (#5915)
* Update users.md * Update users.md * Update filters.md
1 parent e8db3a7 commit 68bbdb0

File tree

2 files changed

+30
-31
lines changed

2 files changed

+30
-31
lines changed

marketplace/eqp/v1/filtering.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ If a field is listed as filterable, it is also sortable. To sort, pass in the `s
2424

2525
|Field|Type|Description|
2626
|-----|----|-----------|
27-
|sort|string|Comma-separated list of field names to sort by. Fields may be prefixed with '-' to sort in descending order, or '+' for ascending.|
27+
|sort|string|Comma-separated list of field names to sort by. Fields may be prefixed with `-` to sort in descending order, or `+` for ascending.|
2828

2929
For example, to sort all versions of all packages, M2 packages first, then M1,
3030
grouped alphabetically by name, with newest packages first:
3131

32-
```HTTP
32+
```http
3333
GET /rest/v1/products/packages/?sort=-platform,+name,-version
3434
```
3535

@@ -40,14 +40,14 @@ You can use multiple response fields as filters in batch GET requests.
4040
For example, to get a package with the submission_id "12345", one way is
4141
to call the single-object convenience endpoint, without using filters:
4242

43-
```HTTP
43+
```http
4444
GET /rest/v1/products/packages/12345/
4545
```
4646

4747
Or alternatively, call the batch endpoint to return a list and filter it by `submission_id`,
4848
so that the list contains only one item:
4949

50-
```HTTP
50+
```http
5151
GET /rest/v1/products/packages/?submission_id=12345
5252
```
5353

marketplace/eqp/v1/users.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@ curl -X GET \
4040
```json
4141
{
4242
"mage_id": "MAG123456789",
43-
"first_name": "Chuck",
44-
"last_name": "Norris",
45-
"email": "cnorris@example.com",
46-
"screen_name": "ninjachuck",
43+
"first_name": "John",
44+
"last_name": "Smith",
45+
"email": "jsmith@example.com",
46+
"screen_name": "Agent Smith",
4747
"has_completed_profile": true,
4848
"has_accepted_tos": true,
4949
"profile_image_artifact": {
5050
"file_upload_id": "uuid-001-234567-123.461",
51-
"filename": "chuck.png",
52-
"content_type": "image.png",
53-
"url": "https://static-mp.magento.com/user/68/f3/68f360d3516f594fc957c4179ed4a7a872911f07/pub/d9/c2/d9c23dd795a5faaab603b6b5965eca8a6d9430f2/chuck.png",
51+
"filename": "portrait.png",
52+
"content_type": "image/png",
53+
"url": "https://static-mp.magento.com/user/68/f3/68f360d3516f594fc957c4179ed4a7a872911f07/pub/d9/c2/d9c23dd795a5faaab603b6b5965eca8a6d9430f2/portrait.png",
5454
"size": 1234,
5555
"file_hash": "d5db29cd03a2ed055086cef9c31c252b4587ffff",
5656
"malware_status": "pass"
@@ -59,12 +59,12 @@ curl -X GET \
5959
"tos_accepted_version": "1.0",
6060
"tos_accepted_date": "2017-11-16 01:23:45",
6161
"is_company": false,
62-
"vendor_name": "chucknorris",
62+
"vendor_name": "johnsmith",
6363
"partner_level": 4,
6464
"locale": "en-US",
6565
"timezone": "UTC",
6666
"payment_type": 1,
67-
"payment_info": {"paypal_email" : "cnorris@example.com"},
67+
"payment_info": {"paypal_email" : "jsmith@example.com"},
6868
"taxpayer_type": 2,
6969
"tax_review_status": 3,
7070
"tax_withhold_percent": 0.00,
@@ -74,12 +74,12 @@ curl -X GET \
7474
"support_share_percent": 0,
7575

7676
"personal_profile": {
77-
"bio": "Sets ants on fire using a magnifying glass. At night.",
77+
"bio": "Writes extensions that pass review first time. Blindfolded.",
7878
"last_logged_in": "2017-09-30 8:09:10",
7979
"created_at": "2016-02-29 14:04:59",
8080
"modified_at": "2017-11-16 01:23:45",
8181
"social_media_info": {
82-
"twitter": "@chucknorrismagento",
82+
"twitter": "@magento",
8383
"stackexchange_url": "",
8484
"facebook_url": "",
8585
"linkedin_url": "",
@@ -88,7 +88,7 @@ curl -X GET \
8888
"addresses": [
8989
{
9090
"address_key": 1,
91-
"address_line_1": "123 Lonestar Way",
91+
"address_line_1": "123 Magento Way",
9292
"state": "Texas",
9393
"country": "USA",
9494
"postal_code": "77777",
@@ -100,15 +100,15 @@ curl -X GET \
100100
},
101101

102102
"company_profile": {
103-
"name": "Ninja Norris Inc.",
104-
"bio": "Ninja Extension Builder.",
103+
"name": "Agent Smith Inc.",
104+
"bio": "Vendors of bespoke Magento Extensions.",
105105
"website_url": "https://www.example.com/",
106-
"primary_email": "cnorris@example.com",
106+
"primary_email": "jsmith@example.com",
107107
"support_email": "[email protected]",
108108
"created_at": "2016-02-29 14:04:59",
109109
"modified_at": "2017-09-30 01:23:45",
110110
"social_media_info": {
111-
"twitter": "@chucknorrismagento",
111+
"twitter": "@magento",
112112
"stackexchange_url": "",
113113
"facebook_url": "",
114114
"linkedin_url": "",
@@ -117,7 +117,7 @@ curl -X GET \
117117
"addresses": [
118118
{
119119
"address_key": 1,
120-
"address_line_1": "123 Lonestar Way",
120+
"address_line_1": "123 Magento Way",
121121
"state": "Texas",
122122
"country": "USA",
123123
"postal_code": "77777",
@@ -145,21 +145,21 @@ curl -X GET \
145145
```json
146146
{
147147
"mage_id": "MAG123456789",
148-
"first_name": "Chuck",
149-
"last_name": "Norris",
150-
"email": "cnorris@example.com",
151-
"screen_name": "ninjachuck",
148+
"first_name": "John",
149+
"last_name": "Smith",
150+
"email": "jsmith@example.com",
151+
"screen_name": "Agent Smith",
152152
"has_completed_profile": true,
153153
"has_accepted_tos": true,
154154
"profile_image_artifact": {
155155
"file_upload_id": "uuid-001-234567-123.461",
156-
"filename": "chuck.png",
156+
"filename": "portrait.png",
157157
"content_type": "image.png",
158-
"url": "https://static-mp.magento.com/user/68/f3/68f360d3516f594fc957c4179ed4a7a872911f07/pub/d9/c2/d9c23dd795a5faaab603b6b5965eca8a6d9430f2/chuck.png",
158+
"url": "https://static-mp.magento.com/user/68/f3/68f360d3516f594fc957c4179ed4a7a872911f07/pub/d9/c2/d9c23dd795a5faaab603b6b5965eca8a6d9430f2/portrait.png",
159159
"size": 1234,
160160
"file_hash": "d5db29cd03a2ed055086cef9c31c252b4587ffff",
161161
"malware_status": "pass"
162-
},
162+
}
163163
}
164164
```
165165

@@ -173,7 +173,7 @@ The following example shows a request to update the personal profile bio field:
173173
{
174174
"action" : "publish",
175175
"personal_profile" : {
176-
"bio" : "I can make a fire by rubbing two ice cubes."
176+
"bio" : "My extensions have won Nobel Prizes in both literature and physics."
177177
}
178178
}
179179
```
@@ -190,7 +190,7 @@ The `action` field specifies which update operation to perform:
190190
curl -X PUT \
191191
-H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
192192
-H 'Content-Type: application/json' \
193-
-d '{ 'action: "publish", "personal_profile" : { "bio" : "I can make a fire by rubbing two ice cubes." } }' \
193+
-d '{ "action" : "publish", "personal_profile" : { "bio" : "My extensions have won Nobel Prizes in both literature and physics." } }' \
194194
https://developer-api.magento.com/rest/v1/users/MAG123456789
195195
```
196196

@@ -221,7 +221,6 @@ The following table lists available query parameters, all of which are optional:
221221
|-----------|--------|----------|----------------------------------------|
222222
| type | string | no | Type of keys requested:<br>`m1` &mdash; Magento 1 product keys<br>`m2` &mdash; Magento 2 composer repo keys<br>`all` &mdash; Both M1 and M2 keys (default)
223223
| label | string | no | The url encoded value of the key label; only valid for `m2` type.|
224-
{:.style="table-layout: auto;"}
225224

226225
The following example shows the request/response body for retrieving keys without any query parameters:
227226

0 commit comments

Comments
 (0)