https://github.com/sourcemeta/registry

A high-performance OEM micro-service to serve collections of JSON Schema over HTTP and build a schema registry for your organisation
https://github.com/sourcemeta/registry

api cpp high-performance json json-schema json-server jsonschema registry schema-registry schemastore

Last synced: about 2 months ago
JSON representation

A high-performance OEM micro-service to serve collections of JSON Schema over HTTP and build a schema registry for your organisation

• Host: GitHub
• URL: https://github.com/sourcemeta/registry
• Owner: sourcemeta
• License: other
• Created: 2024-11-05T18:50:33.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-12T20:26:38.000Z (about 2 months ago)
• Last Synced: 2024-11-12T20:30:50.578Z (about 2 months ago)
• Topics: api, cpp, high-performance, json, json-schema, json-server, jsonschema, registry, schema-registry, schemastore
• Language: C++
• Homepage:
• Size: 2.72 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
Sourcemeta Registry

===================

A high-performance OEM micro-service to serve collections of JSON Schema over

HTTP and build a schema registry for your organisation.

Configuration

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

The Sourcemeta Registry requires a configuration file that defines the schema

collections and pages the instance will serve. See

[`schemas/configuration.json`](./schemas/configuration.json) for the JSON

Schema that defines this configuration file format. The format is designed to

be easy to understand and performant to interact with at runtime.  Here is an

example:

```json

{

  "url": "http://localhost:8000",

  "port": 8000,

  "collections": {

    "example/schemas": {

      "base": "https://example.com/schemas",

      "path": "./schemas/example/folder"

    }

  }

}

```

The `url` property defines the base URL of the instance and will be used for

reidentifying schemas at runtime, so make sure its correct. The `port` property

is optional. The `collections` property mounts a given directory of schemas

into a certain relative path.

Deployment

----------

We release a small `registry-ce` Docker base image to [GitHub

Packages](https://github.com/sourcemeta/registry/pkgs/container/registry-ce)

that you are expected to extend for your own deployment as follows. Replace any

`{{ }}` variable with the values of your choosing:

```docker

FROM ghcr.io/sourcemeta/registry-ce:{{ version }}

# Copy your configuration file (see previous section) and schema files

COPY {{ path/to/configuration.json }} /app/configuration.json

COPY {{ path/to/schemas }} /app/schemas

# Index your schema directory given your configuration

RUN sourcemeta-registry-index /app/configuration.json /app/index \

    && rm -rf /app/schemas /app/configuration.json

# Run the registry against your indexed directory

ENTRYPOINT [ "/usr/bin/sourcemeta-registry-server" ]

CMD [ "/app/index" ]

```