diff --git a/README.md b/README.md index 451935e..cc29619 100644 --- a/README.md +++ b/README.md @@ -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 @@ -82,4 +88,4 @@ $ openapi-generator generate \ -i ./management/openapi-3.yaml \ -o ./build/mgmt-ruby/ \ -c ./management/codegen-config/ruby.json -``` \ No newline at end of file +```