Quick Start Guide

Initial Setup

1. Create the GitHub repository (if not already created):

   # On GitHub, create a new repository named: core-server-open-api
   # Make sure it's under the calimero-network organization
   

2. Push to GitHub:

   cd core-server-open-api
   git add .
   git commit -m "Initial commit: OpenAPI specs repository"
   git branch -M main
   git push -u origin main
   

Using in Other Repositories

Option 1: Git Submodule

Add as a submodule in your repository:

git submodule add git@github.com:calimero-network/core-server-open-api.git openapi-specs

Then in your CI workflow:

- name: Checkout OpenAPI specs
  uses: actions/checkout@v4
  with:
    repository: calimero-network/core-server-open-api
    path: openapi-specs

Option 2: Direct Checkout in CI

Checkout the specs repository directly in your CI:

- name: Checkout OpenAPI specs
  uses: actions/checkout@v4
  with:
    repository: calimero-network/core-server-open-api
    path: openapi-specs
    token: ${{ secrets.GITHUB_TOKEN }}

Option 3: npm Package (Future)

If published as an npm package:

npm install @calimero-network/core-server-open-api

Running Locally

# Install dependencies
npm install

# Validate all specs
npm run validate

# Validate specific spec
npm run validate:core-server
npm run validate:registry

# Check breaking changes
bash scripts/check-breaking-changes.sh \
  specs/core-server/openapi.yaml \
  /path/to/new/spec.yaml

Next Steps

1. Push the repository to GitHub
2. Set up branch protection rules (require PR reviews)
3. Add the repository to your organization's CODEOWNERS
4. Update other repositories to use this as a reference
5. Add CI workflows to dependent repositories