From a0fab5739751244c1c9fb08c4b66fbde449b97d4 Mon Sep 17 00:00:00 2001 From: Yusuke Tsutsumi Date: Tue, 7 Jan 2025 14:24:21 -0800 Subject: [PATCH] docs(contributing): add guide to update examples (#258) --- CONTRIBUTING.md | 12 ++++++++++++ README.md | 4 ++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 700bad62..8cf15f29 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,3 +57,15 @@ Run `./scripts/serve.sh` to: ### Hot reloading The development server currently does not support hot reloading. + +### Updating examples + +The example files are code-generated by [aepc](https://github.com/aep-dev/aepc) +and copied into this repository. + +Specifically, the following files are copied over: + +| aeps file | aepc file | +| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| [./aep/general/example.oas.yaml](./aep/general/example.oas.yaml) | [example/bookstore/v1/bookstore_openapi.json](https://github.com/aep-dev/aepc/blob/main/example/bookstore/v1/bookstore_openapi.json) | +| [./aep/general/example.proto](./aep/general/example.proto) | [example/bookstore/v1/bookstore.proto](https://github.com/aep-dev/aepc/blob/main/example/bookstore/v1/bookstore.proto) | diff --git a/README.md b/README.md index bfc4a2dd..64d836e9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # API Enhancement Proposals -The [AEP Project](https://aep.dev) is an API design specification and ecosystem of -clients and tooling for protobuf and HTTP REST APIs. +The [AEP Project](https://aep.dev) is an API design specification and ecosystem +of clients and tooling for protobuf and HTTP REST APIs. ## Overview