Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dsinghvi authored Oct 6, 2023
1 parent bcc074c commit bd37910
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,17 @@

Tagging a release on this repository will update the:

- [Node.js SDK repo](https://github.com/fern-squidex/squidex-node)
- [Java SDK repo](https://github.com/fern-squidex/squidex-java)
- [Node.js SDK repo](https://github.com/squidex/sdk-node)
- [Java SDK repo](https://github.com/squidex/sdk-java)

## What is in this repository?

This repository contains

- Squidex's Fern API Definition which lives in the [definition](./fern/api/definition/) folder
- Generators (see [generators.yml](./fern/api/generators.yml))
- Squidex's OpenAPI specs which lives in the [definition](./fern/openapi/) folder
- Generators (see [generators.yml](./fern/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 [{TODO}.yml](fern/api/definition/{TODO}.yml) and [{TODO}.yml](fern/api/definition/{TODO}.yml).

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

```bash
npm install -g fern-api # Installs CLI
Expand Down

0 comments on commit bd37910

Please sign in to comment.