Skip to content

Commit

Permalink
fix: Add a link to the x-aep-resource extension in aep-131 (#253)
Browse files Browse the repository at this point in the history
  • Loading branch information
mkistler authored Dec 13, 2024
1 parent c70e65a commit 498914a
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions aep/general/0131/aep.md.j2
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
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

0 comments on commit 498914a

Please sign in to comment.