From dd488b5890916734c54d4ad713070c9b528f7eac Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 13 Nov 2023 11:06:58 +0100
Subject: [PATCH] docs: add docs about new Package Descriptor retrieval RESTapi
 endpoint [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 d00b5718c8040e179567460492a602e045ff26f6)

Co-authored-by: Mattia Dal Ben <mattdibi@users.noreply.github.com>
---
 docs/references/rest-apis/rest-deploy-api.md | 36 ++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/docs/references/rest-apis/rest-deploy-api.md b/docs/references/rest-apis/rest-deploy-api.md
index f6c63214d42..d71d9f70496 100644
--- 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
+}
+```