Skip to content

Commit 8566600

Browse files
authored
Examples for AEP-157 OAS (#385)
* Examples for 157 OAS * Make changes * prettier
1 parent 75b1c97 commit 8566600

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

aep/general/0157/aep.md.j2

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ named `read_mask`.
2121
- An API **may** allow read masks with non-terminal repeated fields (unlike
2222
update masks), but is not obligated to do so.
2323

24+
List serialization / deserialization must conform to
25+
[RFC 9651](https://www.rfc-editor.org/rfc/rfc9651.html#name-serializing-a-list)
26+
2427
**Note:** Changing the default value of `read_mask` is a
2528
[breaking change](./backwards-compatibility#semantic-changes).
2629

@@ -41,7 +44,17 @@ named `read_mask`.
4144

4245
{% tab oas %}
4346

44-
**Note:** OAS example not yet written.
47+
```yaml
48+
parameters:
49+
- in: query
50+
name: fields
51+
schema:
52+
type: string
53+
description: >-
54+
A comma-separated list of fields to include in the response. If not
55+
provided, all fields are returned. Nested fields can be specified using
56+
dot notation. For example: `title,author.name`.
57+
```
4558

4659
{% endtabs %}
4760

@@ -89,6 +102,18 @@ enum BookView {
89102

90103
{% tab oas %}
91104

92-
**Note:** OAS example not yet written.
105+
```yaml
106+
parameters:
107+
- in: query
108+
name: view
109+
schema:
110+
type: string
111+
enum:
112+
- BASIC
113+
- FULL
114+
description: >-
115+
Specifies which fields to return for the book. BASIC returns basic
116+
metadata, FULL returns all fields.
117+
```
93118

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

0 commit comments

Comments
 (0)