### Install mkdocs-techdocs-core

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_10_documentation

Install the specific version of mkdocs-techdocs-core required for compatibility with Witboost. Use pip for installation.

```bash
pip install mkdocs-techdocs-core==1.3.2
```

--------------------------------

### Install Witboost CLI on macOS using Homebrew

Source: https://docs.witboost.com/docs/cli/installation

Install the Witboost CLI on macOS using Homebrew. Set your Homebrew GitLab API token and tap the Witboost infrastructure repository before installing.

```bash
export HOMEBREW_GITLAB_API_TOKEN=<deploy_token>
brew tap witboost/witboost-infra https://gitlab.com/AgileFactory/Witboost.Mesh/iac/witboost.mesh.infrastructure.witboostcli.homebrew-tap.git
brew install witboost
```

--------------------------------

### Builder Documentation index.md Example

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_10_documentation

Example content for the index.md file in the /docs folder for Builder documentation. Includes sections for Architecture and Development Guidelines.

```markdown
# Technical Documentation  
  
This is the technical documentation for developers.  
  
## Architecture  
  
Detailed architecture overview...  
  
## Development Guidelines  
  
Guidelines for contributing to this component...  


```

--------------------------------

### Install or Upgrade Witboost Helm Chart

Source: https://docs.witboost.com/docs/p11_installation/p7_installation

Install or upgrade the Witboost Helm chart using 'helm upgrade --install'. Specify the release name, namespace, values file, and chart version.

```bash
helm upgrade --install --atomic <release_name> witboost/witboost -n <namespace> -f <my-values.yaml> --version X.Y.Z
```

--------------------------------

### Example: Complete Entity with Both Documentation Types

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_10_documentation

This example shows a full Backstage Component definition including annotations for both technical and business documentation.

```yaml
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: customer-analytics-output-port
  title: Customer Analytics Output Port
  description: Provides customer segmentation and analytics data
  annotations:
    backstage.io/techdocs-ref: dir:.
    witboost.com/end-user-docs-ref: dir:./end-user-docs
spec:
  type: outputport
  lifecycle: production
  owner: analytics-team
  domain: marketing
```

--------------------------------

### Example Resources Response

Source: https://docs.witboost.com/openapi/wcg/perimeter-resolver-openapi.yaml

This example shows the structure of a successful response when retrieving resources. It includes a list of resources, each with an ID, display name, version, and content.

```json
{
  "resources": [
    {
      "id": "system-my-namespace-my-system",
      "displayName": "My System",
      "version": "1.0.0",
      "content": "apiVersion: v1\nkind: System\nmetadata:\n  name: my-system\n  namespace: my-namespace\n  labels:\n    app: my-app\nspec:\n  owner: team-a\n  description: Core backend system"
    },
    {
      "id": "system-my-namespace-my-system-2",
      "displayName": "My System 2",
      "version": "2.1.3",
      "content": "apiVersion: v1\nkind: System\nmetadata:\n  name: my-system-2\n  namespace: my-namespace\n  labels:\n    app: my-app-2\nspec:\n  owner: team-b\n  description: Payments processing system"
    },
    {
      "id": "system-my-namespace-my-system-3",
      "displayName": "My System 3",
      "version": "3"
    }
  ]
}
```

--------------------------------

### Example ClusterSecretStore Output

Source: https://docs.witboost.com/docs/p11_installation/p7_installation

An example of the expected output when checking the status of a ClusterSecretStore, showing its name, age, status, capabilities, and readiness.

```bash
kubectl get clustersecretstore
NAME                     AGE    STATUS   CAPABILITIES   READY
mysecretstore            296d   Valid    ReadWrite      True
```

--------------------------------

### Make Witboost CLI executable and run help

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/getting-started

After downloading the binary, make it executable and run the --help command to verify the installation.

```bash
chmod +x witboost-infra  
./witboost-infra --help  

```

--------------------------------

### Provisioning Operation ID Response

Source: https://docs.witboost.com/docs/apis/witboost/provisioning-coordinator

Example response containing the ID of a started provisioning operation.

```json
"aa53de04-f563-4bd3-9407-fb963a00d26b"
```

--------------------------------

### Example Search Request

Source: https://docs.witboost.com/docs/p3_tech/kgm/how_to_query_the_knowledge_graph

Use this GET request to search for concepts using a keyword term and limit the number of results.

```http
GET /v1/search/query?term=customer&limit=3  

```

--------------------------------

### Witboost Infra CLI Init Command Example

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/init

An example of how to run the 'witboost-infra init' command with specific version, username, and password. This demonstrates setting up the CLI with necessary credentials and version information.

```bash
./witboost-infra init --current-version "x.y.z" --registry-username git-username --registry-password your-password  

```

--------------------------------

### Initialize Witboost CLI

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/getting-started

Run the init command to start the CLI initialization process. This includes gathering registry credentials and determining Witboost versions. You will be prompted for registry username and password.

```bash
./witboost-infra init  
info: Starting CLI initialization...  
info: helm found ✓  
info: kubectl found ✓  
Registry username: git-username  
Registry password: [hidden]  
Current Witboost version (optional, press Enter to fetch from deployment): 2.5.0  
info: Latest Helm chart version: 2.7.0  
info: Fetched and Cached Product values.yaml for Current:2.5.0 and Latest:2.7.0 versions from https://gitlab.com/api/v4/projects/project-id/packages/helm/stable  
info: Rules extracted successfully, configuration files updated successfully  
info: Initialization complete. Current:2.5.0, Latest:2.7.0 and all versions between them updated in initial setup configuration  

```

--------------------------------

### Get Current Log Level Response Sample

Source: https://docs.witboost.com/api/provisioningcoordinator

Example JSON response for retrieving the current system log level.

```json
"TRACE"
```

--------------------------------

### Get Tech Adapter Response Sample

Source: https://docs.witboost.com/api/provisioningcoordinator

Example JSON response for retrieving details of a specific tech adapter by its ID.

```json
{
  "id": "urn:dmb:itm:snowflake-outputport-provisioner:0",
  "version": "0",
  "name": "Snowflake Output Port Tech Adapter",
  "description": "Provisions a Snowflake Output Port",
  "labels": [
    "technology=snowflake"
  ],
  "deployments": {
    "environments": [
      {
        "environment": "production",
        "enabled": true
      }
    ]
  }
}
```

--------------------------------

### Initialize Witboost CLI

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/migration

Initializes the Witboost CLI to understand the current version and fetch migration rules. Requires registry credentials.

```bash
./witboost-infra init --current-version "2.3.2" --registry-username "foo" --registry-password "xyz"  

```

--------------------------------

### Get AWS ECR Login Token

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/mirror-images

This command retrieves a temporary login token for AWS ECR and logs in the Docker client. Ensure you have the AWS CLI installed and configured.

```bash
aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin 123456789012.dkr.ecr.us-west-2.amazonaws.com
```

--------------------------------

### Example: Running the Witboost Infra Pull Command

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/pull

Demonstrates how to execute the `witboost-infra pull` command to update local configurations.

```bash
./witboost-infra pull  

```

--------------------------------

### Get Azure ACR Login Token

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/mirror-images

This command retrieves an access token for Azure Container Registry (ACR) using individual Microsoft Entra identity. Ensure the Azure CLI is installed and logged in.

```bash
az acr login --name myregistry --expose-token --query accessToken --output tsv
```

--------------------------------

### Witboost Configuration after Initialization

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/migration

Example of a Witboost configuration file after successful CLI initialization, showing current and available versions.

```yaml
currentVersion: 2.3.0  
availableVersions:  
  - 2.3.0  
  - 2.3.1-rc.1  
  - 2.3.1-rc.2  
  - 2.3.1  
  - 2.3.2  
  - 2.3.3  


```

--------------------------------

### Download Witboost CLI for Linux x64

Source: https://docs.witboost.com/docs/cli/installation

Use this command to download the Witboost CLI binary for Linux x64. Replace `<deploy_token>`, `<version>`, and `<download_url>` with your specific values. Ensure you have a valid deploy token.

```bash
curl --user <deploy_token> \
--output "witboost" <download_url>/<version>/witboost-linux-x64
```

--------------------------------

### Download Witboost CLI for Linux/Windows

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/getting-started

Use this command to download the Witboost CLI binary for Linux or Windows. Replace `<deploy_token>` and `<download_url>/<version>/witboost-linux-x64` with your specific values.

```bash
curl --user <deploy_token> \
--output "witboost-infra" "<download_url>/<version>/witboost-linux-x64"  

```

--------------------------------

### Request Payload Example

Source: https://docs.witboost.com/docs/apis/witboost/builder

Example of a JSON payload for an accepted request.

```json
{
  "status": "OK",
  "hookInfo": {
    "message": "The request has been accepted on the external system"
  }

}
```

--------------------------------

### Check mkdocs-techdocs-core Installation

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_10_documentation

Confirm that the 'mkdocs-techdocs-core' package is installed in your Python environment.

```bash
pip list | grep mkdocs
```

--------------------------------

### Serve Builder Documentation Locally

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_10_documentation

Run this command from the repository root to start a local development server for technical documentation. The server typically runs on port 8000.

```bash
mkdocs serve
```

--------------------------------

### Unprovision System Descriptor Example

Source: https://docs.witboost.com/openapi/techadapter/interface-specification.yml

Example of a system descriptor for unprovisioning a resource.

```yaml
descriptorKind: DATAPRODUCT_DESCRIPTOR
descriptor: "dataProductOwnerDisplayName: John Smith
projectOwner: user:john.smith_example.com
projectOwnerDisplayName: John Smith
environment: production
domain: finance
projectKind: system
kind: dataproduct
domainId: urn:dmb:dmn:finance
id: urn:dmb:dp:finance:cashflow:0
description: Data product representing operating cashflows
devGroup: teamalpha
ownerGroup: john.smith_example.com
dataProductOwner: user:john.smith_example.com
version: 0.1.0
fullyQualifiedName: Cash Flows
name: CashFlow
informationSLA: daily
maturity: Approved
useCaseTemplateId: urn:dmb:utm:dataproduct-template:0.0.0
infrastructureTemplateId: urn:dmb:itm:dataproduct-provisioner:1
billing: {}
tags: []
specific: {}
components:
  - kind: outputport
    id: urn:dmb:cmp:finance:cashflow:0:cashflow-output-port
    description: Output port exposing cashflow data
    name: CashFlow OutputPort
    fullyQualifiedName: null
    version: 0.0.0
    infrastructureTemplateId: urn:dmb:itm:output-port-provisioner:1
    useCaseTemplateId: urn:dmb:utm:output-port-template:1.0.0
    dependsOn: []
    platform: AWS
    technology: S3
    outputPortType: SQL
    creationDate: null
    startDate: null
    processDescription: null
    dataContract:
      schema:
        - name: id
          dataType: string
          tags: []
        - name: direction
          dataType: string
          tags: []
        - name: amount
          dataType: number
          description: monetary value of the cashflow
          tags: []
        - name: counterpartyId
          dataType: string
          description: identifier of the counterparty
          tags: []
      termsAndConditions: ""
      endpoint: null
      SLA:
        intervalOfChange: 2 day
        timeliness: 2 day
        upTime: 99.9%
    dataSharingAgreement:
      purpose: ""
      billing: ""
      security: ""
      intendedUsage: ""
      limitations: ""
      lifeCycle: ""
      confidentiality: ""
    tags: []
    sampleData:
      columns:
        - id
        - direction
        - amount
        - counterpartyId
      rows:
        - - CF-001
          - Incoming
          - 10000
          - cpty:12345
        - - CF-002
          - Outgoing
          - 5000
          - cpty:67890
    semanticLinking: []
    specific:
      format: Iceberg
    consumable: true
    shoppable: true
  - kind: workload
    id: urn:dmb:cmp:finance:cashflow:0:cashflow-calculation
    description: Workload that calculates cashflows from input deals
    useCaseTemplateId: urn:dmb:utm:workload-template:0.0.0
    infrastructureTemplateId: urn:dmb:itm:workload-provisioner:1
    fullyQualifiedName: CashFlow Calculation
    name: CashFlow Calculation
    technology: Spark
    version: 0.0.0
    dependsOn:
      - urn:dmb:cmp:finance:cashflow:0:storage-component
    readsFrom: []
    tags: []
    specific: {}
    consumable: false
    shopp
```

--------------------------------

### Witboost Infra CLI Init Command Usage

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/init

Displays the usage instructions and available options for the 'witboost-infra init' command. Use this to understand the command's parameters.

```bash
Usage: witboost-infra init [options]  
  
Initializes CLI setup by setting the current Witboost version and fetch its product-values.yaml from registry  
  
Options:  
--registry-username <string>  Private Helm registry username  
--registry-password <string>  Private Helm registry password  
--current-version <string>    (optional) Current Witboost version, can be skipped for automatic retrieval  
--context <string>            Kubernetes context, required if `version` is not set  
--namespace <string>          Kubernetes namespace, required if `version` is not set  
--release-name <string>       Helm release name of the Witboost deployment, required if `version` is not set  
-h, --help                    display help for command  

```

--------------------------------

### System Error Response Example

Source: https://docs.witboost.com/openapi/techadapter/interface-specification.yml

Example of a system error response from the server.

```yaml
error: "Internal server error"
userMessage: "An internal server error occurred"
moreInfo:
  problems: [ "The server encountered an internal error" ]
  solutions: [ "Please try again later" ]
```

--------------------------------

### Start Witboost Configuration Migration

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/migration

Transforms a user configuration file to a target Witboost version. Requires the CLI to be initialized and the user values file specified.

```bash
./witboost-infra transform --user-values user_values.yaml --set-target "2.3.2"  
[2025-10-03 12:21:11] info: Transform from version 2.3.0 to 2.3.2  
[2025-10-03 12:21:11] info: Writing the transformed file to: /Users/jhob.doe/.witboost/output/transformed_user_values.yaml  

```

--------------------------------

### Example Descriptor with List

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_5_templates/pickers/descriptorPicker

This is an example of a descriptor where options are defined in a list format.

```yaml
# your component/system/ontology/whatever descriptor
spec:
  # other irrelevant properties
  mesh:
    specific:
      profiles:
        - name: Premium
          description: A premium profile
        - name: Lite
          description: A lite profile

```

--------------------------------

### Example: Running `convert-hocon` Command

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/convert-hocon

Demonstrates how to execute the `convert-hocon` command, specifying the input `values.yaml` file. Ensure the `init` command has been run prior to this.

```bash
./witboost-infra convert-hocon --user-values values.yaml  

```

--------------------------------

### Install npx

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_1_custom_pages

Installs npx globally, which is used for creating new React projects.

```bash
npm install -g npx  

```

--------------------------------

### Gateway Listener Hostname Example

Source: https://docs.witboost.com/docs/p11_installation/p7_installation/IngressGatewayMigration

Example of a wildcard hostname configuration for a Gateway listener.

```yaml
*.example.com  

```

--------------------------------

### Example Usage: Basic Configuration

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_5_templates/pickers/prototypeStatusPicker

Demonstrates how to integrate the Prototype Status Picker within a 'parameters' block, defining its properties and UI field.

```yaml
parameters:  
  - title: Prototype Information  
    properties:  
      status:  
        title: Status  
        type: string  
        description: Select the current status of the prototype  
        ui:field: PrototypeStatusPicker  
        ui:options:  
          allowArbitraryValues: false  

```

--------------------------------

### Automate Configuration Migration with Witboost CLI

Source: https://docs.witboost.com/docs/p10_releases/migrations/v2.8.0

Use the Witboost Infrastructure CLI to automatically migrate your configuration file. Replace placeholders with your actual file paths.

```bash
witboost-infra transform --user-values <path_to_values.yaml> --set-target 2.8.0 --output-path <path_to_values.yaml>
```

--------------------------------

### Get LLM Configuration

Source: https://docs.witboost.com/docs/apis/witboost/witty

Get the current LLM configuration. Requires bearer authentication.

```APIDOC
## Get LLM configuration 
Get the current LLM configuration
##### Authorizations:
_bearerAuth_
### Responses
**200**
Successful response
**500**
Server error
get/witty/v1/llm/config
https://docs.witboost.com/witty/v1/llm/config
###  Response samples 
  * 200


Content type
application/json
Copy
`{
  * "provider": "string",
  * "endpoint": "string",
  * "api_key": "string",
  * "deployment": "string",
  * "api_version": "string",
  * "model": "string",
  * "custom_header": "string"

}`
```

--------------------------------

### Witboost Infra CLI Help Output

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/commands-overview

Displays the usage, options, and available commands for the witboost-infra CLI. Use this to understand the tool's capabilities and command structure.

```bash
Usage: witboost-infra [options] [command]  
  
CLI to migrate Witboost to newer versions  
  
Options:  
  -V, --version            output the version number  
  -l, --log-level <level>  set log level (default: "info")  
  -h, --help               display help for command  
  
Commands:  
  transform [options]      Transforms a values.yaml provided by the user  
  init [options]           Initializes CLI setup by setting the current Witboost version and fetch its product-values.yaml from registry  
  pull                     Pulls all available versions between current and latest version  
  mirror-images [options]  Mirrors Witboost docker images to a customer registry  
  checkdb [options]        Checks database connectivity and verifies the presence of required databases  
  convert-hocon [options]  Converts HOCON blocks in the values.yaml into pure YAML format, making them compatible with newer Witboost versions that do not support HOCON parsing  
  help [command]           display help for command  


```

--------------------------------

### Evaluate Resource using Witboost CLI

Source: https://docs.witboost.com/docs/cli/installation

Example command to evaluate a resource using the Witboost CLI. Replace placeholder values with your specific configuration, including base URLs, token, resource type, and file paths.

```bash
witboost governance evaluate \
    --witboost-base-url http://witboost.com/api \
    --base-url https://wcg.witboost.com/governance-platform \
    --token $TOKEN \
    --resource-type dataproduct \
    --env production \
    --descriptor-file ../descriptor.yaml \
    --resource-id urn:dmb:dp:sales:testdp:0 \
    --output json \
    --output-file evaluation_report.json
```

--------------------------------

### Complex Descriptor Structure Example

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_5_templates/pickers/descriptorPicker

An example of a complex, nested descriptor structure used for populating DescriptorPickers.

```yaml
spec:
  mesh:
    specific:
      profiles:
        - name: Premium
          membershipTypes:
            longTerm:
              name: Long Term
              regions:
                - name: EU
                  group: group:premium_long_eu
                - name: US
                  group: group:premium_long_us
            shortTerm:
              name: Short Term
              regions:
                - name: EU
                  group: group:premium_short_eu
                - name: US
                  group: group:premium_short_us
        - name: Lite
          membershipTypes:
            longTerm:
              name: Long Term
              regions:
                - name: EU
                  group: group:lite_long_eu
                - name: US
                  group: group:premium_long_us
            shortTerm:
              name: Short Term
              regions:
                - name: EU
                  group: group:lite_short_eu
                - name: US
                  group: group:lite_short_us
```

--------------------------------

### Provisioning Preview Response Sample

Source: https://docs.witboost.com/api/provisioningcoordinator

Example JSON response for a provisioning preview request. It details the planned operations, including component ID, target status, and action.

```json
{
  "outcome": "OK",
  "operations": [
    {
      "componentId": "my-component-1",
      "targetStatus": "DEPLOYED",
      "action": "DEPLOY",
      "reason": "REQUEST",
      "additionalReasons": [
        "REQUEST"
],
      "dependencyOf": [
        "my-component-3"
],
      "dependantOn": [
        "my-component-4"
]
}
],
  "conflictingOperations": [ ]

}
```

--------------------------------

### platform-users-service-account-unregistered Payload Example

Source: https://docs.witboost.com/docs/p3_tech/p14_events/p14_8_platform

Example payload for the 'platform-users-service-account-unregistered' event. This event is logged when a Service Account is unregistered.

```json
{
  "ref": "user:default/example_agilelab.com"
}
```

--------------------------------

### Automate Configuration Migration with Witboost Infra CLI

Source: https://docs.witboost.com/docs/p10_releases/migrations/v2.9.0

Use the Witboost Infrastructure CLI to automatically migrate your configuration file. Replace placeholders with your actual file path.

```bash
witboost-infra transform --user-values <path_to_values.yaml> --set-target 2.9.0 --output-path <path_to_values.yaml>
```

--------------------------------

### Example Resource Descriptor

Source: https://docs.witboost.com/docs/p3_tech/p11_managing_policies/p11_3_creating_a_policy

This is an example of a resource's descriptor, which is used to define selectors for governance evaluation.

```yaml
environment: production
domain: finance
kind: dataproduct
domainId: urn:dmb:dmn:finance
id: urn:dmb:dp:finance:airflow-end-to-end-test:0
description: To perform end to end testing
name: Airflow End To End Test
fullyQualifiedName: null
version: 0.2.0-SNAPSHOT-1
billing: {}
tags: []
specific:
  technology: airflow

```

--------------------------------

### Serve Marketplace Documentation Locally

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_10_documentation

Navigate to the Marketplace documentation directory and run 'mkdocs serve' to preview business-oriented documentation. This also typically uses port 8000.

```bash
cd end-user-docs
mkdocs serve
```

--------------------------------

### Original HOCON Configuration Example

Source: https://docs.witboost.com/docs/p10_releases/migrations/v2.9.0

An example of the original HOCON format for configuration overrides before conversion to YAML.

```yaml
provisioning-coordinator:
  enabled: true
  image:
    registry: <registry>
  extraEnvVars:
      - name: COORDINATOR_DB_DBNAME
        value: *provisioningCoordinatorDB
      - name: CGP_DB_DBNAME
        value: *provisioningCoordinatorDB
  configOverride: |-
      akka {
        http.parsing.max-header-value-length = 256k
        http.server.request-timeout = 120 seconds
        http.server.idle-timeout = 120 seconds
      }

```

--------------------------------

### Example ClusterIssuer Output

Source: https://docs.witboost.com/docs/p11_installation/p7_installation

An example of the expected output when checking the status of a ClusterIssuer, showing its name, readiness, and age.

```bash
kubectl get cluster Issuer
NAME                     READY   AGE
letsencrypt-production   True    2y236d
```

--------------------------------

### Example parameters.yaml for Witboost

Source: https://docs.witboost.com/docs/p3_tech/p12_catalog/p12_2_skeleton_entities

This YAML file defines parameters for a Witboost component, including lifecycle, description, and tags. It's used to configure component metadata.

```yaml
parameters:
  lifecycle: experimental
  description: A component description
  tags:
    - t1
    - t2

```

--------------------------------

### Start Template Instantiation

Source: https://docs.witboost.com/docs/data-teams/p6_advanced/p6_1_templates

Send a POST request to initiate the template instantiation process. Provide the template reference and required values. This returns a task ID for subsequent operations.

```json
{
  "templateRef": "template:default/my-output-port-template",
  "values": {
    "name": "my-output-port",
    "owner": "team-a",
    "domain": "finance"
  }
}
```

```json
{
  "templateRef": "template:default/my-output-port-template",
  "values": {
    "name": "my-output-port",
    "owner": "team-a",
    "domain": "finance"
  },
  "environmentParameters": {
    "production": {
      "region": "eu-west-1",
      "storageClass": "STANDARD"
    },
    "development": {
      "region": "us-east-1",
      "storageClass": "REDUCED_REDUNDANCY"
    }
  }
}
```

--------------------------------

### Response Payload Example (200 OK)

Source: https://docs.witboost.com/docs/apis/witboost/builder

Example of a JSON response payload for a successful operation (status 200).

```json
{
  "hookId": "34797dd1-1f25-48b0-89c7-14d2ce04a78b",
  "hookName": "RemoteRequestHook",
  "actionId": "0298b78f-4d77-45f7-a7a4-f16278144141",
  "actionName": "AccessControlAction",
  "creationAt": "2021-09-01T12:00:00Z",
  "updateAt": "2021-09-01T12:00:00Z",
  "status": "OK"

}
```

--------------------------------

### Full Entity Object Example (Domain)

Source: https://docs.witboost.com/docs/p3_tech/p3_customizations/p3_5_templates/pickers/entitySearchPicker

This is an example of the 'full' return value for a 'Domain' entity. It includes all properties of the object.

```json
{
  "apiVersion": "backstage.io/v1alpha1",
  "kind": "Domain",
  "metadata": {
    "name": "finance",
    "description": " Everything related to finance",
    "links": [
      {
        "url": "http://example.com/domain/finance",
        "title": "Finance Domain"
      }
    ]
  },
  "spec": {
    "owner": "group:datameshplatform",
    "mesh": {
      "name": "Finance"
    }
  }
}

```

--------------------------------

### Witboost CLI Help

Source: https://docs.witboost.com/docs/cli

Run this command to get details about a specific Witboost CLI command. It's useful for exploring subcommands and their options.

```bash
witboost [command] --help
```

--------------------------------

### Example of Witboost Infra Transform Command

Source: https://docs.witboost.com/docs/p11_installation/infra-cli/command-reference/transform

Demonstrates how to use the transform command with specified user values and a target version.

```bash
./witboost-infra transform --user-values values.yaml --set-target x.y.z  

```

--------------------------------

### access-token-revoked Payload Example

Source: https://docs.witboost.com/docs/p3_tech/p14_events/p14_8_platform

Example payload for the 'access-token-revoked' event. This event is logged when an Access Token has been revoked for a Service Account.

```json
{
  "uuid": "9a86fdea-611a-48ec-a315-fba72731b918"
}
```

--------------------------------

### access-token-generated Payload Example

Source: https://docs.witboost.com/docs/p3_tech/p14_events/p14_8_platform

Example payload for the 'access-token-generated' event. This event is logged when an Access Token has been generated for a Service Account.

```json
{
  "uuid": "9a86fdea-611a-48ec-a315-fba72731b918",
  "serviceAccountRef": "user:default/example_agilelab.com"
}
```