Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs about new Package Descriptor retrieval RESTapi endpoint #4955

Merged
merged 2 commits into from
Nov 13, 2023
Merged

docs: add docs about new Package Descriptor retrieval RESTapi endpoint #4955

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4011033
docs: add docs about new Package Descriptor retrieval RESTapi endpoint
mattdibi Nov 7, 2023
efdf869
docs: GET -> PUT
mattdibi Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/references/rest-apis/rest-deploy-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
```
Loading