docs: add docs about new Package Descriptor retrieval RESTapi endpoin…

…t [backport docs-release-5.4] (#4967) docs: add docs about new Package Descriptor retrieval RESTapi endpoint (#4955) * docs: add docs about new Package Descriptor retrieval RESTapi endpoint * docs: GET -> PUT (cherry picked from commit d00b571) Co-authored-by: Mattia Dal Ben <[email protected]>
eclipse-kura · Nov 13, 2023 · dd488b5 · dd488b5
1 parent e44db4a
commit dd488b5
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/docs/references/rest-apis/rest-deploy-api.md b/docs/references/rest-apis/rest-deploy-api.md
@@ -95,3 +95,39 @@ curl -X POST -k -u $USERNAME:$PASSWORD \
 "REQUEST_RECEIVED"
 ```
 
+#### Get Eclipse Marketplace Package Descriptor
+- Description: Provides the Eclipse Marketplace Package Descriptor information of the deployment package identified by URL passed in the request.
+- Method: PUT
+- API PATH: `/deploy/v2/_packageDescriptor`
+
+##### Request Body
+
+```json
+{
+  "url": "deploymentPackageUrl"
+}
+```
+
+Example:
+
+```json
+{
+  "url": "http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=5514714"
+}
+```
+
+##### Responses
+- 200 OK status
+- 400 Bad request
+
+```json
+{
+   "nodeId":"5514714",
+   "url":"https://marketplace.eclipse.org/content/ai-wire-component-eclipse-kura-5",
+   "dpUrl":"https://download.eclipse.org/kura/releases/5.3.0/org.eclipse.kura.wire.ai.component.provider-1.2.0.dp",
+   "minKuraVersion":"5.1.0",
+   "maxKuraVersion":"",
+   "currentKuraVersion":"5.4.0",
+   "isCompatible":true
+}
+```