Stubbing out the aep tooling list #238
Open
Conversation
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
will update links after #231 is addressed
toumorokoshi
requested changes
Nov 3, 2024
thanks, agree with all these suggestions and just layered in some minor tweaks to the suggestions. Co-authored-by: Yusuke Tsutsumi <[email protected]>
toumorokoshi
approved these changes
Nov 10, 2024
Comment on lines
+24
to
+26
| AEPs were adapted from [Google's AIP project](https://google.aip.dev/), but also extend it with | ||
| tooling to easily generate and validate that result in better designed APIs, as well as provide clients to | ||
| consume them. |
There was a problem hiding this comment.
Suggested change
| AEPs were adapted from [Google's AIP project](https://google.aip.dev/), but also extend it with | |
| tooling to easily generate and validate that result in better designed APIs, as well as provide clients to | |
| consume them. | |
| AEPs were adapted from [Google's AIP project](https://google.aip.dev/), but also enhanced with improved | |
| guidance for APIs, tooling to generate and validate them, and clients to interact with them. The result is better designed and consumable APIs. |
|
|
||
| - More consistent APIs within and across teams, reducing cognitive load for consumers | ||
| - Argue less about API design decisions, saving time thanks to AEPs explar design patterns | ||
| - are more consistent within and across teams, reducing cognitive load for API consumers |
There was a problem hiding this comment.
Suggested change
| - are more consistent within and across teams, reducing cognitive load for API consumers | |
| - are more consistent within and across teams, reducing cognitive load for API consumers |
double space
|
|
||
| Having an AEP-compliant API also means benefitting from the AEP ecosystem of tooling, such as: | ||
|
|
||
| - Linters and validators to ensure adherence to the AEP design specification [proto]()/[openapi]() | ||
| - Command line tool that make it easier to work with APIs ([aepcli](https://github.com/aep-dev/aepcli)) | ||
| - A command line tool interface genreator that make it easier to work with APIs ([aepcli](https://github.com/aep-dev/aepcli)) |
There was a problem hiding this comment.
Suggested change
| - A command line tool interface genreator that make it easier to work with APIs ([aepcli](https://github.com/aep-dev/aepcli)) | |
| - A dynamic command line interface generator that make it easier to work with APIs ([aepcli](https://github.com/aep-dev/aepcli)) |
I think "dynamic" is important here - it implies it get change without code changes (e.g. parsing and generating static code that has to be distributed and released.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
will update links after #231 is addressed
🍱 Types of changes
What types of changes does your code introduce to AEP? Put an
xin the boxesthat apply