> For the complete documentation index, see [llms.txt](https://rc.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rc.sunbird.org/use/developer-guide/schema-setup/schema-configuration.md).

# Schema Configuration

Sunbird RC uses standard JSON-LD schemas. Example — a `Place` concept with `name`, `city`, `addressRegion`, `country`:

{% code title="place.json" %}

```json
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "object",
  "properties": { "Place": { "$ref": "#/definitions/Place" } },
  "required": ["Place"],
  "title": "Place",
  "definitions": {
    "Place": {
      "$id": "#/properties/Place",
      "type": "object",
      "required": ["name", "city", "addressRegion", "country"],
      "properties": {
        "name": { "type": "string" },
        "city": { "type": "string" },
        "addressLocality": { "type": "string" },
        "addressRegion": { "type": "string" },
        "country": { "type": "string" },
        "postalCode": { "type": "string" },
        "contact": { "type": "string" },
        "email": { "type": "string" }
      }
    }
  }
}
```

{% endcode %}

## `_osConfig` extensions

Access, indexing, and primary-key behavior beyond plain JSON-LD.

| Key                                          | What it does                                                                                                                    |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `privateFields`                              | Visible to the owner and consenting third parties                                                                               |
| `internalFields`                             | Never exposed to any actor                                                                                                      |
| `systemFields`                               | `osCreatedAt`, `osUpdatedAt`, `osCreatedBy`, `osUpdatedBy`, `_osClaimId`, `_osCredentialId`, `_osSignedData`, `_osAttestedData` |
| `indexFields`                                | Index field set for faster lookups                                                                                              |
| `uniqueIndexFields`                          | Primary keys — enforces uniqueness                                                                                              |
| `roles` / `inviteRoles`                      | Gate CRUD and invite operations by Keycloak role; either can be `"anonymous"` for open access                                   |
| `ownershipAttributes`                        | Email/mobile/userId/password JSON paths, with `enableLogin: true`                                                               |
| `attestationPolicies`                        | List of attestation policies (see below)                                                                                        |
| `credentialTemplate`                         | W3C-compliant VC template, inline object or external URL                                                                        |
| `certificateTemplates.svg`                   | The visual-certificate template                                                                                                 |
| `PrivateFieldConfig` / `InternalFieldConfig` | How private/internal fields get emitted                                                                                         |
| `uniqueIdentifierFields`                     | Auto-generated formatted IDs (see below)                                                                                        |

Property types are String, Enum, Number, Integer, Object, Array, Boolean — see [type-specific keywords](https://json-schema.org/understanding-json-schema/reference/type).

Notification templates are configured per-schema, per-operation (`create`/`invite`/`update`/`delete`/`revoke`).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://rc.sunbird.org/use/developer-guide/schema-setup/schema-configuration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.