Skip to content

Commit

Permalink
Added documentation about upgrading the API spec
Browse files Browse the repository at this point in the history
  • Loading branch information
JimTheCactus committed Oct 11, 2024
1 parent 873ec53 commit 61423a6
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

cc-api-sandbox is a mock server for the Console Connect API.

*Please, be aware that this repo is under heavy development, and should be expected to change rapidly.*
_Please, be aware that this repo is under heavy development, and should be expected to change rapidly._

## Installation

Expand All @@ -42,6 +42,21 @@ Pull requests are welcome and encouraged!

For details, please see [CONTRIBUTING.md](CONTRIBUTING.md).

### Updating the OpenAPI Specification

There is a modified version of the Console Connect OpenAPI specification included in the repository.
To update the spec, simply remove the old specification from the `specs/` folder and push a new
version with the filename `ccapi_YYYYMMDD.json`, where YYYY is the 4 digit year, MM is the two
digit month, and DD is the two digit day. Then update the filename in `src/app.ts` to match.

To try out a new specification file locally, you can pass in the path to the file through the
environment variable `SPEC_FILE`. For example:

```shell
export SPEC_FILE="./specs/mytestapi.json"
yarn dev
```

## License

[Apache 2.0](LICENSE)

0 comments on commit 61423a6

Please sign in to comment.