CodeCombat API

Tagging a release on this repository will update the following repos:

• Node.js SDK
• Python SDK
• Java SDK
• Go SDK
• OpenAPI spec
• Postman collection

and the CodeCombat API docs

What is in this repository?

This repository contains

• CodeCombat's Fern API Definition in English and Simplified Chinese which lives in the definition folder
• Generators (see generators.yml)

What is in the API Definition?

The API Definition contains information about what endpoints, types, and errors are used in the API. The definition is broken into smaller files such as clans.yml and stats.yml.

To make sure that the definition is valid, you can use the Fern CLI.

npm install -g fern-api # Installs CLI
fern check # Checks if the definition is valid

What are generators?

Generators read in your API Definition and output artifacts (e.g. the TypeScript SDK Generator) and are tracked in generators.yml.

To trigger the generators run:

fern generate --group external --version <version>

The publish command currently runs in a GitHub workflow (see ci.yml)