diff --git a/openapi/README.md b/openapi/README.md new file mode 100644 index 00000000..6d27d683 --- /dev/null +++ b/openapi/README.md @@ -0,0 +1,18 @@ +# API Design Guidelines +This readme is a continually evolving document meant to provide API design best practices for the following purposes. + +1. API feels consistent +2. Preempt known bad patterns +3. Make new APIs easy to define + +## Directory structure + + +## Naming Conventions +### Common fields +| Name | Description | +|---|---| +| timestamp | timestamp an event occurred + +## Service Structure +Prefer stuff