Skip to content

Commit

Permalink
addressing code review
Browse files Browse the repository at this point in the history
  • Loading branch information
toumorokoshi committed Feb 21, 2024
1 parent baa8954 commit 2d493a7
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions aep/general/0005/aep.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ This AEP serves as a high-level guide to designing an AEP-compliant API. AEPs.
## Enumerate use cases

The first step in designing an API is understanding precisely what operations
you would like your user to be able to perform. Enumerate these operations, attempting to
be as granular as possible.
you would like your user to be able to perform. Enumerate these operations,
attempting to be as granular as possible.

For example, if the API is for VM management in a public cloud, the operations
may include:
Expand All @@ -34,6 +34,8 @@ Some best practices:

- Attempt to define granular use cases that can be composed to satisfy more
complex use cases.
- Be comprehensive and consider lower-priority use cases: having more use cases
enumerated often leads to better API design.

## Identify resources

Expand Down

0 comments on commit 2d493a7

Please sign in to comment.