@@ -43,16 +43,16 @@ main = do
4343### The `codegen` dir
4444
4545* `regen.sh` is the simple script to regenerate the whole package.
46−* `shell.nix` a shell in which the `regen.sh` calls the `openapi3-code-generator` to regenerate the
47−* `mock-server-openapi-5.13.x-swagger.yaml` not the original file as you might
48− think. The thing is that the `openapi3-code-generator` does not support all
49− the features of the OpenAPI3 standard correctly, so it is
50− hand-postprocessed. It was originally downloaded from [here](https://app.swaggerhub.com/apis/jamesdbloom/mock-server-openapi/5.13.x) and fixed.
46+* `shell.nix` a shell in which the `regen.sh` calls the `openapi3-code-generator` to regenerate the code
47+* `mock-server-openapi.yaml` not the [original specification](https://app.swaggerhub.com/apis/jamesdbloom/mock-server-openapi) of the `mock-server` as you might
48+ think. The thing is that the `openapi3-code-generator` does not support all the features of the
49+ OpenAPI3 standard correctly, so it is hand-postprocessed. It was originally downloaded from
50+ [here](https://app.swaggerhub.com/apis/jamesdbloom/mock-server-openapi/5.13.x) and fixed.
5151
5252### Other
5353
54−* `src` contails the generted code, but not exactly. Some of the parts of the
55− generted code was not very pleasant, so it was fixed too.
54+* `src` and `mock-server-client.cabal` contain the generted code, but not exactly. Some of the parts
55+ of the generted code was not very pleasant, so it was fixed too.
5656
5757## What will happen if you just call the `regen.sh`?
5858
@@ -60,9 +60,9 @@ It will build the `openapi3-code-generator` in `nix` and regenerate the whole
6060Haskell source code. You will see that the code was changed, because as
6161mentioned earlier the original code was slightly modified, so watch your commits.
6262
63−## How the to update the package to the new version of the `mock-server`?
63+## How to update the package to the new version of the `mock-server` spec?
6464
65−* Commit all changes
65+* Commit or discard all changes
6666* `git checkout update-openapi-spec`
6767* Replace the `codegen/mock-server-openapi.yaml` with a newer version
6868* `git commit -m "updated mock-server-openapi.yaml to version $NEWVERSION"`