> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/products/registry/registry/developer-zone/building-a-registry/concepts/registry-extensions.md).

# Registry Extensions

Understanding the registry architecture is necessary before you write code. These pages explain **how the platform loads your extension**, what metadata drives the UI, and how async pipelines interact with domain code.

| Document                      | Summary                                                                                                          |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Platform and extension model  | Core vs extension, API vs Celery startup, import map, end-to-end flows                                           |
| Registers and metadata        | Register types, hierarchy, register-metadata tables, section flags                                               |
| Extension contract            | Required classes, factories, enrichers, score compute, ID generator                                              |
| Section UI schema and widgets | Authoring `section_ui_schema` JSON — panels, widgets, data paths                                                 |
| Ingestion and outgestion      | Partner pipeline, enrichers, Jinja templates, ADD/UPDATE                                                         |
| Background jobs and Celery    | Which workers call extension code; beat vs worker                                                                |
| Domain Services               | Implementer contract for `G2PRegisterDomainService{Mnemonic}` — naming, search text, validation, lifecycle hooks |

Register-metadata table field reference: Register metadata index (10 G2P\* pages aligned with `meta_data/register-metadata/` SQL files).

Non-register-metadata SQL folders: Metadata folder reference.

***

### How the pieces fit together

```mermaid
flowchart TB
    PLAN[Plan domain registers] --> PY[Python extension]
    PLAN --> SQL[meta_data SQL]
    PY --> IMG[Docker images]
    SQL --> IMG
    IMG --> HELM[Helm wrapper]
    HELM --> RUN[Running registry]

    SQL --> RM[register-metadata]
    SQL --> ING[ingestion rules]
    PY --> ENR[enrichers + score compute]
    RM --> UI[Staff portal UI]
    ING --> CEL[Celery workers]
    ENR --> CEL
```

Metadata defines **what** the UI shows and **how** external messages map to registers. Python defines **columns**, **validation**, and **side effects** the metadata layer cannot express. Docker and Helm deliver both to Kubernetes without forking the platform.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openg2p.org/products/registry/registry/developer-zone/building-a-registry/concepts/registry-extensions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.