@@ -1,68 +1,42 @@
1−# About
1+## About
22
33The package is the client library for the [mock server](https://www.mock-server.com/). The source code is
44generated by the [openapi3-code-generator](https://hackage.haskell.org/package/openapi3-code-generator), specifically its patched version.
55
6−## Usage
6+## How to regenerate code from the spec
77
8−``` haskell
9−module Main
10−
11−import MockServer as Mock
12−import Network.HTTP.Client
13−
14−conf :: Mock.Configuration
15−conf = Configuration
16− { configBaseURL = "http://localhost"
17− , configSecurityScheme = id
18− , configIncludeUserAgent = False
19− , configApplicationName = "ping-app" }
20−
21−expectation :: Mock.Expectations
22−expectation = Mock.ExpectationsExpectation $ Mock.mkExpectation
23− { expectationHttpRequest = Just request
24− , expectationHttpResponse = Just response }
25− where
26− request = Mock.mkHttpRequest
27− { httpRequestMethod = Just $ StringOrJsonSchemaText "POST"
28− , httpRequestPath = Just $ StringOrJsonSchemaText "/ping" }
29− response = Mock.mkHttpResponse
30− { httpResponseBody = Just $ BodyWithContentTypeRawStringResponseBody "pong"
31− , httpResponseStatusCode = Just 200 }
32−
33−-- | Puts the expectation which will response with "pong" body to the "POST /ping" request
34−main :: IO ()
35−main = do
36− void $ Mock.runWithConfiguration conf $ Mock.put_mockserver_expectation expectation
378```
9+cd codegen && ./regen.sh
10+```
11+
12+It requires the `nix` to be installed in your system because it uses the
13+`openapi3-code-generator` built by the `nix`.
3814
39−# Maintainance
15+After regeneration you will see some `.hs` files changed. This is because some
16+parts of the libary are modified by hand to make the more usable.
4017
4118## Files
4219
4320### The `codegen` dir
4421
4522* `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 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.
23+* `shell.nix` a shell in which the `regen.sh` calls the `openapi3-code-generator` to regenerate the
24+* `mock-server-openapi-5.13.x-swagger.yaml` not the original file as you might
25+ think. The thing is that the `openapi3-code-generator` does not support all
26+ the features of the OpenAPI3 standard correctly, so it is
27+ hand-postprocessed. It was originally downloaded from [here](https://app.swaggerhub.com/apis/jamesdbloom/mock-server-openapi/5.13.x) and fixed.
28+* `src` contails the generted code, but not exactly. Some of the parts of the
29+ generted code was not very pleasant, so it was fixed too.
5130
52−### Other
53−
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.
56−
57−## What will happen if you just call the `regen.sh`?
31+### What will happen if you just call the `regen.sh`?
5832
5933It will build the `openapi3-code-generator` in `nix` and regenerate the whole
6034Haskell source code. You will see that the code was changed, because as
6135mentioned earlier the original code was slightly modified, so watch your commits.
6236
63−## How to update the package to the new version of the `mock-server` spec?
37+## How the to update the package to the new version of the `mock-server`?
6438
65−* Commit or discard all changes
39+* Commit all changes
6640* `git checkout update-openapi-spec`
6741* Replace the `codegen/mock-server-openapi.yaml` with a newer version
6842* `git commit -m "updated mock-server-openapi.yaml to version $NEWVERSION"`
@@ -78,19 +52,3 @@ mentioned earlier the original code was slightly modified, so watch your commits
7852* Resolve conflicts if any
7953* `git push origin "update-$NEWVERSION"`
8054* Create PR, wait for CI, review, merge into the master
81−
82−The algorithm is kind of weird, but for a reason.
83−
84−The branch `update-openapi-spec` is the branch tracking only original
85−`codegen/mock-server-openapi.yaml` changes, meaning changes made by authors of the
86−`mock-server`. So, when you merge changes of this branch into the master you literally merge the
87−changes made by authors of the `mock-server` with our manual changes made to please the
88−`openapi3-code-generator`.
89−
90−The bratch `update-generated-code` is for tracking "changes" made by the code generator when it is
91−feed by the new OpenAPI spec file. So, when you merge this branch into the master you literally
92−merge the "code regeneration patch" with changes made by hand.
93−
94−The `master` branch is for manual changes only. The changes made to keep things working and the
95−package usable. You can always see the manual changes just by `git diff update-generated-code
96−master` or `git diff update-openapi-spec master`