-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(api-linter) fix api linter errors (#15)
To ensure full adherence with the AEPs, fix all AEP-linter errors. This resolves almost all AEP-linter errors, sans a change to introduce a path variable for Update which is being discussed in aep-dev/aeps#210. One other error remains, which has to be do with the existence of an APPLY method here: aep-dev/aeps#110. Proto package generation also now aligns with AEP best practices, and to enable flexibility is now decoupled from the API name.
- Loading branch information
1 parent
86ef13e
commit 15b5501
Showing
17 changed files
with
1,195 additions
and
999 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Design Notes | ||
|
||
## Protobuf | ||
|
||
AEP and protobuf best practices forces a particular structure between the following that should align: | ||
|
||
- Protobuf directory structure and filenames. | ||
- Package names. | ||
- AEP API name. | ||
|
||
Using the example in this directory, a file "example/bookstore/bookstore.yaml" from the resource root: | ||
|
||
- aep API name is bookstore.example.com | ||
- com.example.bookstore should be the package name. | ||
- so com/example/bookstore.proto should be the directory name. | ||
|
||
Open questions: | ||
|
||
- Should the AEPC generation match the protobuf convention? so that openapi json files end up in the same directory as the proto files? | ||
- For the AEP API name - is it more correct to go from broadest domain to most qualified domain (e.g. com.example.bookstore instead of example.bookstore.com)? | ||
- this aligns well with the proto, java, and golang packages. It does not align well with how domain names work. | ||
|
||
Thinking about something like the following for `bookstore.example.com`: | ||
|
||
``` | ||
com/ | ||
example/ | ||
bookstore.proto | ||
bookstore_openapi.json | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.