Skip to content

Make AEP-121 more generic #337

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make AEP-121 more generic #337

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
7 changes: 1 addition & 6 deletions aep/general/0121/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Resource-oriented design

Resource-oriented design is a pattern for specifying [RPC][] APIs, based on the
Resource-oriented design is a pattern for specifying APIs, based on the
following high-level design principles:

- The fundamental building blocks of an API are individually-named _resources_
Expand All @@ -9,10 +9,6 @@ following high-level design principles:
common operations. However, custom methods are available in situations where
the standard methods do not fit.

Readers might notice similarities between these principles and some principles
of [REST][]; resource-oriented design borrows many principles from REST, while
also defining its own patterns where appropriate.

Comment on lines -12 to -15
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a valid statement, no?

it's helpful to have something to on conceptually - REST is a good concrete example.

## Guidance

When designing an API, consider the following:
Expand Down Expand Up @@ -150,7 +146,6 @@ turn do not increase resource management complexity.
[output only]: ./0203#output-only
[rest]: https://en.wikipedia.org/wiki/Representational_state_transfer
[resource references]: ./0122#fields-representing-another-resource
[rpc]: https://en.wikipedia.org/wiki/Remote_procedure_call
[singleton resources]: ./0156
[soft delete]: ./0164
[state]: ./0216
Expand Down
1 change: 1 addition & 0 deletions aep/general/0121/aep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ id: 121
state: approved
slug: resources
created: 2024-01-27
order: 10
placement:
category: resources