Skip to content

Commit

Permalink
Add "note to self"
Browse files Browse the repository at this point in the history
  • Loading branch information
vkurup committed Nov 6, 2023
1 parent 2e59284 commit 7584406
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ $ openapi-generator generate \

### Management SDK

Note to maintainers: The openapi-3.yaml file doesn't fully reference all of the
endpoints and schemas in the individual entity YAML files. For this reason, please make
sure to update both the individual entity YAML file AND the openapi-3.yaml file when
making changes. Bonus points for linking the 2 with `$ref` so that there is only one
place to make changes.

#### JavaScript

```sh
Expand All @@ -82,4 +88,4 @@ $ openapi-generator generate \
-i ./management/openapi-3.yaml \
-o ./build/mgmt-ruby/ \
-c ./management/codegen-config/ruby.json
```
```

0 comments on commit 7584406

Please sign in to comment.