Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hleb-albau committed Jul 22, 2021
1 parent 737a9af commit 0c63cff
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,21 @@
* **rt - \*.yml** - files describing results types
* **p - \*.yml** - files describing endpoints

## Scheme validation

## Updating clients according to the current spec

To update clients, use `update clients` GitHub action. Specify title PR and press run. For each client **PR** with changes will be created.

:warning: NOTE: Static typed clients, such as Java or C#, require adding all new **enums** to `update-models.sh` ENUM_MAPPINGS section.

:warning: NOTE: For some clients generator produces not-valid client code. See `update-models.sh` for ad-hocks fixing generator issues.

:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc in ext folder.

:bulb: All clients have RawResultItem container that is used for deserialization for undescribed types. This container is a simple map/dict.


## Spec validation
```
docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml
```
Expand Down

0 comments on commit 0c63cff

Please sign in to comment.