Skip to content
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

Add a link to the x-aep-resource extension in aep-131 #253

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Add a link to the x-aep-resource extension in aep-131 #253

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
13 changes: 9 additions & 4 deletions aep/general/0131/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ resource.

## Guidance

- APIs **must** provide a get method for resources. The purpose of the get method
is to return data from a single resource.
- Some resources take longer to be retrieved than is reasonable for a regular API request. In this situation, the API should use a [long-running operation](/long-running-operations).
- APIs **must** provide a get method for resources. The purpose of the get
toumorokoshi marked this conversation as resolved.
Show resolved Hide resolved
method is to return data from a single resource.
- Some resources take longer to be retrieved than is reasonable for a regular
API request. In this situation, the API should use a
[long-running operation](/long-running-operations).

### Operation

Expand Down Expand Up @@ -105,7 +107,10 @@ there is a reason to return a partial response (see AEP-157).
{% sample '../example.oas.yaml', '$.paths./publishers/{publisher}/books/{book}.get.responses.200.content' %}

- The response content **must** be the resource itself. For example:
`#/components/schemas/Book`. The response **must** reference a schema with a `x-aep-resource` extension.
`#/components/schemas/Book`. The response **must** reference a schema with a
[`x-aep-resource` extension].

[`x-aep-resource` extension]: ./0004.md#annotating-resource-types

{% endtabs %}

Expand Down
Loading