Skip to content

Commit ad6974a

Browse files
authored
OAS guidance for AEP 159 (#387)
* OAS guidance for AEP 159 * Fix build
1 parent e2336f4 commit ad6974a

2 files changed

Lines changed: 32 additions & 2 deletions

File tree

aep/general/0157/aep.md.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,4 @@ parameters:
116116
metadata, FULL returns all fields.
117117
```
118118

119-
{% endtab %}
119+
{% endtabs %}

aep/general/0159/aep.md.j2

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,37 @@ guidance in [unreachable resources].
3939

4040
{% tab oas %}
4141

42-
Note: OAS guidance is yet to be written.
42+
- The OpenAPI path pattern **must** include a parameter for the collection
43+
identifier, rather than hard-coding the `-` character. This allows clients to
44+
use either a specific collection ID or the wildcard `-`.
45+
- The path parameter **should** allow the `-` character as a valid value.
46+
47+
**Example:** List books across all publishers:
48+
49+
```yaml
50+
paths:
51+
/v1/publishers/{publisher_id}/books:
52+
get:
53+
operationId: ListBooks
54+
description: >-
55+
Lists books for a specific publisher. Supports wildcard collection
56+
lookup: use `-` as the publisher_id to list books across all
57+
publishers. When using the wildcard, books from all publishers are
58+
returned with their canonical resource paths (e.g.,
59+
publishers/123/books/456, not publishers/-/books/456).
60+
parameters:
61+
- in: path
62+
name: publisher_id
63+
required: true
64+
schema:
65+
type: string
66+
description: >-
67+
The publisher ID. Use `-` to list books across all publishers.
68+
```
69+
70+
**Note:** When using wildcard collection lookup, the response **must** return
71+
resources with their canonical paths containing actual parent collection
72+
identifiers, not the wildcard character.
4373

4474
{% endtabs %}
4575

0 commit comments

Comments
 (0)