Skip to content

Commit 0c63cff

Browse files
authored
Update README.md
1 parent 737a9af commit 0c63cff

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,21 @@
2020
* **rt - \*.yml** - files describing results types
2121
* **p - \*.yml** - files describing endpoints
2222

23-
## Scheme validation
23+
24+
## Updating clients according to the current spec
25+
26+
To update clients, use `update clients` GitHub action. Specify title PR and press run. For each client **PR** with changes will be created.
27+
28+
:warning: NOTE: Static typed clients, such as Java or C#, require adding all new **enums** to `update-models.sh` ENUM_MAPPINGS section.
29+
30+
:warning: NOTE: For some clients generator produces not-valid client code. See `update-models.sh` for ad-hocks fixing generator issues.
31+
32+
:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc in ext folder.
33+
34+
:bulb: All clients have RawResultItem container that is used for deserialization for undescribed types. This container is a simple map/dict.
35+
36+
37+
## Spec validation
2438
```
2539
docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml
2640
```

0 commit comments

Comments
 (0)