Skip to content

docs(contributing): add guide to update examples #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
toumorokoshi merged 1 commit into from
Jan 7, 2025
Merged

docs(contributing): add guide to update examples #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading