Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 4 additions & 15 deletions docs/src/concepts/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Core Concepts
description: Understand the fundamental concepts of IDP-Core - Entity Templates, Entities, Properties, Relations, and Audit tracking
description: Understand the fundamental concepts of IDP-Core - Entity Templates, Entities, Properties, and Relations
---

IDP-Core sits at the center of a flexible, runtime-configurable data model. This section explains the fundamental concepts you need to understand, including entity management and comprehensive audit tracking.
IDP-Core sits at the center of a flexible, runtime-configurable data model. This section explains the fundamental concepts you need to understand, including entity management and relationships.

## Overview

Expand Down Expand Up @@ -49,24 +49,12 @@ graph TB

Connections between entities forming a knowledge graph.

- 🌐 **[Webhooks](webhooks.md)**

---

Runtime-configurable connectors to push your data from external systems within your IDP. You can map any source in your data model in minutes.

- 🔍 **[Filtering Entities](entity-filtering.md)**

---

Query entities by attributes, property values, and relations using the filter DSL.

- 📜 **[Audit](audit.md)**

---

Track all changes over time with comprehensive revision history and user attribution.

</div>

---
Expand Down Expand Up @@ -142,4 +130,5 @@ Dive deeper into each concept:
- **[Entity Templates](entity-templates.md)** - Learn how to design your data model
- **[Properties](properties.md)** - Understand property types and validation
- **[Relations](relations.md)** - Connect your entities into a graph
- **[Webhooks](webhooks.md)** - Configure inbound integrations and security strategies
- **[Data Integration](../features/data-integration.md)** - Ingest and map data from external systems
- **[Audit](../features/audit.md)** - Track changes to entities over time
200 changes: 0 additions & 200 deletions docs/src/contributing/code/audit-implemantation.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/src/deployment/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configuration Reference
title: General Configuration
description: Complete configuration reference for IDP-Core
---

Expand Down
6 changes: 3 additions & 3 deletions docs/src/concepts/audit.md → docs/src/features/audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,6 @@ curl -s http://localhost:8084/api/v1/audit/entities/web-service/my-service | \

## Next Steps

- **[Entities](entities.md)** - Entity structure and lifecycle
- **[Properties](properties.md)** - Property types and validation
- **[Relations](relations.md)** - Entity relationships
- **[Entities](../concepts/entities.md)** - Entity structure and lifecycle
- **[Properties](../concepts/properties.md)** - Property types and validation
- **[Relations](../concepts/relations.md)** - Entity relationships
4 changes: 2 additions & 2 deletions docs/src/features/data-integration.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Data Integration
title: Overview
description: Connect to any data source through Webhooks, Kafka, or Pub/Sub with runtime-configurable mappings
status: 🕐 Doing
---

> [!IMPORTANT]
> This document describes a feature that is not yet developed. The content is subject to change and may not reflect the final implementation.
> This document describes a feature that is not fully developed yet. The content is subject to change and may not reflect the final implementation.

The Internal Developer Platform provides flexible data integration to connect to any source and map incoming data to your entities at runtime without code changes. That's powerful for rapid adaptation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Understand Dynamic mappings and JSLT expressions.

## Overview

A mapping targets one Entity Template and describes how to derive entity fields from the incoming JSON payload with a JSLT filter and entity projections.
A mapping targets one Entity Template and describes how to derive entity fields from the incoming JSON payload with a JSLT filter and entity projections. It is linked to a data integration configuration (Webhook, Kafka, etc) as it describes how to transform incoming payloads.

## Entity Dynamic Mapping Fields

Expand Down Expand Up @@ -35,6 +35,20 @@ A mapping targets one Entity Template and describes how to derive entity fields
| `name` | ✅ | Relation name from the Entity Template |
| `target_entity_identifiers` | ✅ | Array of JSLT expressions to extract target identifiers |

> [!TIP]
> To remove all target relations while preserving the entity, set `target_entity_identifiers` to `["null"]`.
> Setting `[]` or `[""]` will not work.
>
> ```json
> "relations": [
> {
> "name": "your-relation-name",
> "target_entity_identifiers": ["null"]
> }
> ]
> ```
>

### Mapping Actions

The `action` field determines how the resolved entity payload modifies the entity in IDP-Core:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/features/graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,4 +496,4 @@ Overlay health metrics onto graph nodes to quickly identify troubled components.

- **[Data Integration](data-integration.md)** - Connect external systems and populate the graph with data
- **[Entity Templates](../concepts/entity-templates.md)** - Define the types of entities in your graph
- **[Audit Trail](../concepts/audit.md)** - Track changes to entities and relationships
- **[Audit Trail](audit.md)** - Track changes to entities and relationships
18 changes: 14 additions & 4 deletions docs/src/features/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Features
description: Explore the Internal Developer Platform features - Data Integration, Scorecards, Dashboards, Self-Service Actions, and AI Integration
description: Explore IDP-Core features, including data integration, audit history, graphs, scorecards, and self-service actions
---

The Internal Developer Platform provides a comprehensive set of features to build your Internal Developer Platform. This section covers current capabilities and the roadmap for future development.
IDP-Core provides features for integrating data, tracking changes, and building your Internal Developer Platform. This section covers available capabilities and planned features.

## Feature Overview

Expand All @@ -13,17 +13,27 @@ The Internal Developer Platform provides a comprehensive set of features to buil

---

Connect to any data source through Webhooks, Kafka, or Pub/Sub. Map incoming data to entities using JSLT expressions.
Connect external systems and map incoming data to entities.

**Status:** 🕐 Doing

**Details:** [Webhooks](webhooks.md) · [Entity Dynamic Mappings](entity-dynamic-mapping.md)

- 🕸️ **[Graph](graph.md)**

---

Visualize entity relationships and dependencies as interactive graphs.

**Status:** 🕐 Done
**Status:** ✅ Available

- 📜 **[Audit](audit.md)**

---

Track entity changes with revision history and user attribution.

**Status:** ✅ Available

- 📈 **[Scorecards](scorecards.md)**

Expand Down
Loading
Loading