How-to Guides

Update descriptions with Markdown

Use the existing Markdown documentation stored in a code repository to populate the descriptions of your IcePanel model objects and connections. This can be automatically updated as part of a build pipeline.

Prerequisites

$export ICEPANEL_API_KEY='your-api-key'
$export ICEPANEL_ORGANIZATION_ID='your-organization-id'

Steps

1

Get your landscape

Get all landscapes in your organization and select a landscape ID:

GET
/v1/organizations/:organizationId/landscapes
1curl https://api.icepanel.io/v1/organizations/organizationId/landscapes \
2     -H "X-API-Key: <apiKey>"
Try it

Note the id of the landscape:

$export ICEPANEL_LANDSCAPE_ID='your-landscape-id'
2

Find the object to update

List all model objects in a landscape:

GET
/v1/landscapes/:landscapeId/versions/:versionId/model/objects
1curl https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/model/objects \
2     -H "X-API-Key: <apiKey>"
Try it

Note the id of the object you want to update.

3

Update the description

Patch the model object with your Markdown description. Replace modelObjectId with the object’s id.

PATCH
/v1/landscapes/:landscapeId/versions/:versionId/model/objects/:modelObjectId
1curl -X PATCH https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/model/objects/modelObjectId \
2     -H "X-API-Key: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
Try it