Upgrade 5.1.2 to 5.2.0

Install or upgrade initial design recipes, profiles and baselines after installation

Use this procedure after installation to load the platform’s initial design recipes, profiles and baselines into the Designer. The operation is performed through the Designer Backend Swagger UI.

Before you begin

• You need administrator access. Only admins may call this API.
• The Designer Backend must be reachable at k5-designer.<cluster-domain>/backend/swagger/ (replace <cluster-domain> with your cluster’s domain).

Steps

1. Open the API in Swagger

   In your browser, open the Designer Backend Swagger UI and go to Admin / User Settings APIs → Project Baselines → initialImport.

   Full path pattern:

   k5-designer.<cluster-domain>/backend/swagger/?urls.primaryName=Admin%2FUser+Settings+APIs#/Project%20Baselines/initialImport

2. Click Authorize and sign in with credentials that have admin rights.

3. After you are authenticated, you can call the endpoint from Swagger.

4. Click Try it out.

5. Click Execute without uploading a ZIP file (leave the file field empty) to install the default design recipes, system baselines and profiles.

6. What gets updated

   The API imports all initial design recipes, profiles and baselines.

   Type	Existing item	Result
   Design recipe	Same id and version	Replaced by the latest definition from this import
   Profile, Baseline	Same id and version, status DRAFT	Replaced by the latest definition from this import
   Profile, Baseline	Same id and version, status DEPRECATED or PUBLISHED	Not overridden

7. Confirm the response

   A successful run returns JSON that lists what was uploaded and what was skipped. The exact ids and versions depend on your release; the shape of the response is illustrated below.

{
  "designRecipesUploaded": [
    {
      "id": "default-recipe",
      "version": "1.0.0",
      "name": "Default design recipe"
    }
  ],
  "designRecipesNotUploaded": [],
  "profilesUploaded": [
    {
      "id": "a1-principles-standards-profile",
      "version": "1.0.0",
      "name": "Architecture Principles, Standards & Policies"
    },
    {
      "id": "a3-risks-techdebt-health-profile",
      "version": "1.0.0",
      "name": "Risks, Tech Debt & Health"
    },
    {
      "id": "basic-collaboration-profile",
      "version": "1.0.0",
      "name": "Basic Collaboration"
    },
    {
      "id": "basic-shapes-profile",
      "version": "1.0.0",
      "name": "Basic Shapes"
    },
    {
      "id": "c4-profile",
      "version": "1.0.0",
      "name": "C4 Model"
    },
    {
      "id": "ddd-profile",
      "version": "1.0.0",
      "name": "Domain-Driven Design"
    },
    {
      "id": "event-storming",
      "version": "1.0.0",
      "name": "Event Storming"
    },
    {
      "id": "implementation-profile",
      "version": "1.0.0",
      "name": "Implementation Design"
    },
    {
      "id": "k5-oml-system",
      "version": "1.0.0",
      "name": "Basic System Definitions"
    }
  ],
  "profilesNotUploaded": [],
  "baselinesUploaded": [
    {
      "id": "architecture",
      "version": "1.0.1",
      "name": "Architecture and Design  "
    },
    {
      "id": "java-basic-springboot",
      "version": "1.0.1",
      "name": "Basic Service Java"
    },
    {
      "id": "java-ddd-springboot",
      "version": "1.0.2",
      "name": "Domain Service Java"
    },
    {
      "id": "java-int-springboot",
      "version": "1.0.1",
      "name": "Integration Service Java"
    },
    {
      "id": "node-bff-nestjs",
      "version": "1.0.1",
      "name": "Backend for Frontend Node (NestJS)"
    },
    {
      "id": "node-int-nestjs",
      "version": "1.0.1",
      "name": "Integration Service   Node (NestJS)"
    }
  ],
  "baselinesNotUploaded": []
}