@@ -82,27 +82,68 @@ Rule is based on [http://go/ipa/IPA-104](http://go/ipa/IPA-104).
8282
8383 ![ warn] ( https://img.shields.io/badge/warning-yellow )  
8484APIs must provide a Get method for resources.
85+ 
86+ ##### Implementation details  
87+ Rule checks for the following conditions:
88+   -  Only applies to resource collection identifiers
89+   -  For singleton resources, verifies the resource has a GET method
90+   -  For regular resources, verifies there is a single resource path with a GET method
91+ 
8592#### xgen-IPA-104-get-method-returns-single-resource  
8693
8794 ![ warn] ( https://img.shields.io/badge/warning-yellow )  
8895The purpose of the Get method is to return data from a single resource.
96+ 
97+ ##### Implementation details  
98+ Rule checks for the following conditions:
99+   -  Applies only to 2xx responses of GET methods on single resources or singleton resources
100+   -  Verifies the response is not an array or paginated result
101+   -  Different error messages are provided for standard vs singleton resources
102+ 
89103#### xgen-IPA-104-get-method-response-code-is-200  
90104
91105 ![ warn] ( https://img.shields.io/badge/warning-yellow )  
92106The Get method must return a 200 OK response.
107+ 
108+ ##### Implementation details  
109+ Rule checks for the following conditions:
110+   -  Applies only to GET methods on single resources or singleton resources
111+   -  Verifies the 200 OK response code is present
112+   -  Fails if the method lacks a 200 OK response or defines a different 2xx status code
113+ 
93114#### xgen-IPA-104-get-method-returns-response-suffixed-object  
94115
95116 ![ warn] ( https://img.shields.io/badge/warning-yellow )  
96117The Get method of a resource should return a "Response" suffixed object.
118+ 
119+ ##### Implementation details  
120+ Rule checks for the following conditions:
121+   -  Applies only to 2xx responses of GET methods on single resources or singleton resources
122+   -  Verifies the schema references a predefined schema (not inline)
123+   -  Confirms the referenced schema name ends with "Response" suffix
124+ 
97125#### xgen-IPA-104-get-method-response-has-no-input-fields  
98126
99127 ![ warn] ( https://img.shields.io/badge/warning-yellow )  
100128The Get method response object must not include writeOnly properties (fields that should be used only on creation or update, ie output fields).
129+ 
130+ ##### Implementation details  
131+ Rule checks for the following conditions:
132+   -  Applies only to 2xx responses of GET methods on single resources or singleton resources
133+   -  Searches through the schema to find any properties marked with writeOnly attribute
134+   -  Fails if any writeOnly properties are found in the response schema
135+ 
101136#### xgen-IPA-104-get-method-no-request-body  
102137
103138 ![ warn] ( https://img.shields.io/badge/warning-yellow )  
104139The Get method request must not include a body.
105140
141+ ##### Implementation details  
142+ Rule checks for the following conditions:
143+   -  Applies only to GET methods on single resources or singleton resources
144+   -  Verifies that the operation object does not contain a requestBody property
145+ 
146+ 
106147
107148### IPA-105  
108149
0 commit comments