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

Commit a9f4246

Browse files
author
Mike Weis
committed
MS-8916: Update EQP API DevDocs per customer's experience
- added required field when creating a new package: "version" - added conditionally required field when creating a new package: "sku"
1 parent 7c073bd commit a9f4246

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

src/marketplace/eqp/v1/packages.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Both `POST` and `PUT` requests support a batch model where multiple packages can
108108
|shared_packages[N].artifact.sku|string|GET, POST, PUT|both|no|The shared package file|Unique file upload ID obtained from the Files API.|
109109
|shared_packages[N].artifact.version|string|GET, POST, PUT|both|no|The shared package file|Unique file upload ID obtained from the Files API.|
110110
|short_description|substring|GET, POST, PUT|marketing|yes|The short description for the package.|Short free text|
111-
|sku|substring|GET|-|yes|The SKU generated from metadata in the code artifact.|A SKU|
111+
|sku|substring|GET, POST|-|yes|The SKU generated from metadata in the code artifact. Only specified in a `POST` when creating another version of an existing extension.|A SKU|
112112
|stability|string|GET, POST, PUT|marketing|yes|The version's build stability|`stable`, `beta`|
113113
|sort|string|GET|-|no|A comma-separated list of fields to sort the list, each field prefixed by `-` for descending order, or `+` for ascending order.|See [Get package details](#get-package-details).|
114114
|submission_id|substring|GET, PUT|-|yes|A globally unique ID assigned to a package when it is submitted in a POST request. All further references to this package using GET or PUT requests can be made supplying this identifier.|A generated string|
@@ -124,7 +124,7 @@ Both `POST` and `PUT` requests support a batch model where multiple packages can
124124
|version_compatibility|array|GET, POST, PUT|technical|no|List of Magento versions that this package supports. Must match the editions in `prices`|Array of objects|
125125
|version_compatibility[N].edition|string|GET, POST, PUT|technical|no|Magento edition for the accompanying versions list|`M2`|
126126
|version_compatibility[N].versions|array|GET, POST, PUT|technical|no|List of Magento versions that this package supports in the given edition.|Array of version strings, eg ["2.3","2.4"]
127-
|version|substring|GET|-|yes|The version of this package.|`major.minor.patch`, eg `2.5.3`.|
127+
|version|substring|GET, POST|both|yes|The version of this package.|`major.minor.patch`, eg `2.5.3`.|
128128

129129
### Additional notes
130130

@@ -515,8 +515,9 @@ Send the "submit" action for the marketing content to re-publish the product.
515515
}
516516
```
517517

518-
* The *overall* value indicates where the package is in the EQP pipeline.
519-
* Additional details are provided in the two main EQP areas:
518+
* This is a read-only field.
519+
* The **overall** value indicates where the package is in the EQP pipeline.
520+
* Additional details are provided in the two main EQP areas:
520521
* **technical** - Provides the current technical status.
521522
* **marketing** - Provides the current marketing status.
522523

@@ -569,8 +570,9 @@ PUT /rest/v1/products/packages/:item_id
569570

570571
You can submit a package in either of the following ways:
571572

572-
* A single POST request with all required fields set. You must explicitly indicate that you are submitting for technical and marketing review using the `action` parameter.
573-
* A series of requests, typically in the following order:
573+
* A single POST request with all required fields set. You must explicitly indicate that you are submitting for technical and marketing review using the `action` parameter.
574+
* If this package represents a newer version to an already existing extension, then also supply the `sku` parameter.
575+
* A series of requests, typically in the following order:
574576
1. A single POST request with the minimum required fields set and `action` set to `draft` in either `technical`, `marketing`, or both. This request accepts the new package and saves it on the Developer Portal for further updates. It returns a unique `submission_id` for subsequent PUT operations.
575577
1. One or more PUT requests in which you configure the package parameters. In these requests, set `action` to `draft` in `technical`, `marketing`, or both.
576578
1. A final PUT request indicating submission for `technical`, `marketing`, or both.
@@ -613,7 +615,8 @@ The following example shows a POST request with all required parameters set for
613615
"name" : "One Click Checkout",
614616
"short_description" : "<Short description here>",
615617
"long_description" : "<Long description here>",
616-
"release_notes" : "<Release notes here>",
618+
"release_notes" : "<Release notes here>",
619+
"version" : "1.1.5",
617620
"artifact" : {
618621
"file_upload_id" : "5c11e656057b42.97931218.5"
619622
},
@@ -733,13 +736,13 @@ curl -X POST \
733736

734737
The PUT method can be used to update packages in the following states:
735738

736-
* The package is in draft mode for the technical or marketing review; or both.
737-
* The package has been rejected in either the technical or marketing review; or both.
739+
* The package is in draft mode for the technical or marketing review; or both.
740+
* The package has been rejected in either the technical or marketing review; or both.
738741
You must fix these issues and re-submit the package.
739-
* The package has been released to the Commerce Marketplace.
740-
* The package was removed from Commerce Marketplace by the developer and needs to be re-published.
741-
* The package can be recalled while in the EQP pipeline.
742-
* After a package has been released to the Commerce Marketplace, you can update marketing information only.
742+
* The package has been released to the Commerce Marketplace.
743+
* The package was removed from Commerce Marketplace by the developer and needs to be re-published.
744+
* The package can be recalled while in the EQP pipeline.
745+
* After a package has been released to the Commerce Marketplace, you can update marketing information only.
743746
Changing marketing information causes the package to be placed in marketing review.
744747
The package continues to be live on the marketplace, and after the marketing approval,
745748
the updated fields will be published to the store.
@@ -765,7 +768,7 @@ The HTTP response code will indicate success or failure.
765768

766769
#### Required parameters
767770

768-
If the **action** parameter gives a `submit` value for technical, marketing or both,
771+
If the **action** parameter gives a `submit` value for **technical**, **marketing** or both,
769772
the required parameters are listed below by their respective parallel EQP pipelines:
770773

771774
##### Technical
@@ -776,6 +779,8 @@ the required parameters are listed below by their respective parallel EQP pipeli
776779
|platform||
777780
|version_compatibility||
778781
|release_notes||
782+
|version||
783+
|sku|only valid when a previous version exists|
779784
|artifact||
780785
|documentation_artifacts|At least the `user` guide must be supplied.|
781786

@@ -796,14 +801,16 @@ the required parameters are listed below by their respective parallel EQP pipeli
796801

797802
##### Submission in several steps
798803

799-
As described earlier, a submission can also be done in several steps in draft mode, followed by the action to `submit` for technical and/or `marketing` review. In such cases, the first
804+
As described earlier, a submission can also be done in several steps in draft mode, followed by the action to `submit` for **technical** and/or **marketing** review. In such cases, the first
800805
POST request in draft mode can be done with a minimal set of parameters:
801806

802807
|Parameter|Comments|
803808
|---------|--------|
804809
|type|
805810
|platform|
806811
|name||
812+
|version||
813+
|sku|only valid when a previous version exists|
807814
|short_description||
808815
|long_description||
809816

0 commit comments

Comments
 (0)