Skip to content

Commit 6b1b2df

Browse files
authored
fix(AIP-131,AIP-132) make Get/List a must (#1043)
With #993, Get and List are required for resources as stated in AIP-121. Fixe the guidance to match in the more specific AIPs.
1 parent 6d6eac9 commit 6b1b2df

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

aip/general/0131.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ resource.
2020

2121
## Guidance
2222

23-
APIs **should** generally provide a get method for resources unless it is not
24-
valuable for users to do so. The purpose of the get method is to return data
25-
from a single resource.
23+
APIs **must** provide a get method for resources. The purpose of the get method
24+
is to return data from a single resource.
2625

2726
Get methods are specified using the following pattern:
2827

@@ -98,6 +97,7 @@ NOT_FOUND errors][permission-denied].
9897

9998
## Changelog
10099

100+
- **2023-03-17**: Align with AIP-122 and make Get a must.
101101
- **2022-11-04**: Aggregated error guidance to AIP-193.
102102
- **2022-06-02**: Changed suffix descriptions to eliminate superfluous "-".
103103
- **2020-06-08**: Added guidance on returning the full resource.

aip/general/0132.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ parameters), and return a list of responses matching that input.
2020

2121
## Guidance
2222

23-
APIs **should** generally provide a `List` method for resources unless it is
24-
not valuable for users to do so. The purpose of the `List` method is to return
25-
data from a single, finite collection.
23+
APIs **must** provide a `List` method for resources unless the resource is a
24+
[singleton][]. The purpose of the `List` method is to return data from a single,
25+
finite collection.
2626

2727
List methods are specified using the following pattern:
2828

@@ -198,10 +198,12 @@ NOT_FOUND errors][permission-denied].
198198
[aip-203]: ./0203.md
199199
[errors]: ./0193.md
200200
[permission-denied]: ./0193.md#permission-denied
201+
[singleton]: ./156.md
201202
[soft delete]: ./0135.md#soft-delete
202203

203204
## Changelog
204205

206+
- **2023-03-17**: Align with AIP-122 and make Get a must.
205207
- **2022-11-04**: Aggregated error guidance to AIP-193.
206208
- **2022-06-02**: Changed suffix descriptions to eliminate superfluous "-".
207209
- **2020-09-02**: Add link to the filtering AIP.

0 commit comments

Comments
 (0)