Skip to content

Commit 6411cf5

Browse files
committed
address feedback
1 parent b6d8fb7 commit 6411cf5

1 file changed

Lines changed: 3 additions & 21 deletions

File tree

aep/general/0004/aep.md.j2

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -71,33 +71,15 @@ For OpenAPI 3.0, Resources must be defined in `#components/schemas` and use the
7171
[`x-aep-resource`](https://aep.dev/json-schema/extensions/x-aep-resource.json)
7272
extension:
7373

74-
```json
75-
{
76-
"components": {
77-
"schemas": {
78-
"UserEvent": {
79-
"type": "object",
80-
"x-aep-resource": {
81-
"type": "user.example.com/user-event",
82-
"singular": "user-event",
83-
"plural": "user-events",
84-
"patterns": [
85-
"projects/{project_id}/user-events/{user_event_id}",
86-
"folder/{folder_id}/user-events/{user_event_id}",
87-
"users/{user_id}/events/{user_event_id}"
88-
]
89-
}
90-
}
91-
}
92-
}
93-
}
94-
```
74+
{% sample '../example.oas.yaml', '$.components.schemas.book.x-aep-resource' %}
9575

9676
{% endtabs %}
9777

9878
- The `type` field **must** be the resource type `{API Name}/{Type Name}`
9979
- The `singular` field **must** be the kebab-case singular type name.
10080
- The `plural` field **must** be the kebab-case plural of the singular.
81+
- The `parent` field **must** be a list of all type names of parents of the resource.
82+
- If the resource has no parents, this field may be omitted.
10183

10284
The `pattern` field **must** match the `pattern` rule in the following grammar,
10385
expressed as [EBNF][EBNF]:

0 commit comments

Comments
 (0)