Skip to content

Commit d426572

Browse files
docs fix
1 parent ccd7c34 commit d426572

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

tools/spectral/ipa/rulesets/README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Rules are based on [http://go/ipa/IPA-104](http://go/ipa/IPA-104).
8080

8181
#### xgen-IPA-104-resource-has-GET
8282

83-
![warn](https://img.shields.io/badge/warning-yellow)
83+
![error](https://img.shields.io/badge/error-red)
8484
APIs must provide a Get method for resources.
8585

8686
##### Implementation details
@@ -91,7 +91,7 @@ Rule checks for the following conditions:
9191

9292
#### xgen-IPA-104-get-method-returns-single-resource
9393

94-
![warn](https://img.shields.io/badge/warning-yellow)
94+
![error](https://img.shields.io/badge/error-red)
9595
The purpose of the Get method is to return data from a single resource.
9696

9797
##### Implementation details
@@ -102,7 +102,7 @@ Rule checks for the following conditions:
102102

103103
#### xgen-IPA-104-get-method-response-code-is-200
104104

105-
![warn](https://img.shields.io/badge/warning-yellow)
105+
![error](https://img.shields.io/badge/error-red)
106106
The Get method must return a 200 OK response.
107107
##### Implementation details
108108
Rule checks for the following conditions:
@@ -112,7 +112,7 @@ Rule checks for the following conditions:
112112

113113
#### xgen-IPA-104-get-method-returns-response-suffixed-object
114114

115-
![warn](https://img.shields.io/badge/warning-yellow)
115+
![error](https://img.shields.io/badge/error-red)
116116
The Get method of a resource should return a "Response" suffixed object.
117117
##### Implementation details
118118
Rule checks for the following conditions:
@@ -122,7 +122,7 @@ Rule checks for the following conditions:
122122

123123
#### xgen-IPA-104-get-method-response-has-no-input-fields
124124

125-
![warn](https://img.shields.io/badge/warning-yellow)
125+
![error](https://img.shields.io/badge/error-red)
126126
The Get method response object must not include writeOnly properties (fields that should be used only on creation or update, ie output fields).
127127
##### Implementation details
128128
Rule checks for the following conditions:
@@ -132,7 +132,7 @@ Rule checks for the following conditions:
132132

133133
#### xgen-IPA-104-get-method-no-request-body
134134

135-
![warn](https://img.shields.io/badge/warning-yellow)
135+
![error](https://img.shields.io/badge/error-red)
136136
The Get method request must not include a body.
137137
##### Implementation details
138138
Rule checks for the following conditions:
@@ -147,7 +147,7 @@ Rules are based on [http://go/ipa/IPA-105](http://go/ipa/IPA-105).
147147

148148
#### xgen-IPA-105-list-method-response-code-is-200
149149

150-
![warn](https://img.shields.io/badge/warning-yellow)
150+
![error](https://img.shields.io/badge/error-red)
151151
The List method must return a 200 OK response.
152152

153153
##### Implementation details
@@ -159,7 +159,7 @@ Rule checks for the following conditions:
159159

160160
#### xgen-IPA-105-list-method-no-request-body
161161

162-
![warn](https://img.shields.io/badge/warning-yellow)
162+
![error](https://img.shields.io/badge/error-red)
163163
The List method request must not include a body.
164164

165165
##### Implementation details
@@ -170,7 +170,7 @@ Rule checks for the following conditions:
170170

171171
#### xgen-IPA-105-resource-has-list
172172

173-
![warn](https://img.shields.io/badge/warning-yellow)
173+
![error](https://img.shields.io/badge/error-red)
174174
APIs must provide a List method for resources.
175175

176176
##### Implementation details
@@ -182,7 +182,7 @@ Rule checks for the following conditions:
182182

183183
#### xgen-IPA-105-list-method-response-is-get-method-response
184184

185-
![warn](https://img.shields.io/badge/warning-yellow)
185+
![error](https://img.shields.io/badge/error-red)
186186
The response body of the List method should consist of the same resource object returned by the Get method.
187187
##### Implementation details Rule checks for the following conditions:
188188
- Applies only to resource collection paths with JSON content types
@@ -201,7 +201,7 @@ Rules are based on [http://go/ipa/IPA-106](http://go/ipa/IPA-106).
201201

202202
#### xgen-IPA-106-create-method-request-body-is-request-suffixed-object
203203

204-
![warn](https://img.shields.io/badge/warning-yellow)
204+
![error](https://img.shields.io/badge/error-red)
205205
The Create method request should be a Request suffixed object.
206206

207207
##### Implementation details
@@ -213,7 +213,7 @@ Rule checks for the following conditions:
213213

214214
#### xgen-IPA-106-create-method-should-not-have-query-parameters
215215

216-
![warn](https://img.shields.io/badge/warning-yellow)
216+
![error](https://img.shields.io/badge/error-red)
217217
Create operations should not use query parameters.
218218

219219
##### Implementation details
@@ -222,23 +222,9 @@ Rule checks for the following conditions:
222222
- Verifies the operation does not contain query parameters
223223
- Ignores specified parameters like 'pretty' and 'envelope' via configuration
224224

225-
#### xgen-IPA-106-create-method-request-body-is-get-method-response
226-
227-
![warn](https://img.shields.io/badge/warning-yellow)
228-
Request body content of the Create method and response content of the Get method should refer to the same resource.
229-
230-
##### Implementation details
231-
232-
Validation checks the POST method for resource collection paths.
233-
- Validation ignores resources without a Get method.
234-
- `readOnly:true` properties of Get method response will be ignored.
235-
- `writeOnly:true` properties of Create method request will be ignored.
236-
- Property comparison is based on `type` and `name` matching.
237-
- `oneOf` and `discriminator` definitions must match exactly.
238-
239225
#### xgen-IPA-106-create-method-request-has-no-readonly-fields
240226

241-
![warn](https://img.shields.io/badge/warning-yellow)
227+
![error](https://img.shields.io/badge/error-red)
242228
Create method Request object must not include fields with readOnly:true.
243229

244230
##### Implementation details
@@ -250,7 +236,7 @@ Rule checks for the following conditions:
250236

251237
#### xgen-IPA-106-create-method-response-code-is-201
252238

253-
![warn](https://img.shields.io/badge/warning-yellow)
239+
![error](https://img.shields.io/badge/error-red)
254240
Create methods must return a 201 Created response code.
255241

256242
##### Implementation details
@@ -259,6 +245,20 @@ Rule checks for the following conditions:
259245
- Verifies the 201 Created response code is present
260246
- Fails if the method lacks a 201 Created response or defines a different 2xx status code
261247

248+
#### xgen-IPA-106-create-method-request-body-is-get-method-response
249+
250+
![warn](https://img.shields.io/badge/warning-yellow)
251+
Request body content of the Create method and response content of the Get method should refer to the same resource.
252+
253+
##### Implementation details
254+
255+
Validation checks the POST method for resource collection paths.
256+
- Validation ignores resources without a Get method.
257+
- `readOnly:true` properties of Get method response will be ignored.
258+
- `writeOnly:true` properties of Create method request will be ignored.
259+
- Property comparison is based on `type` and `name` matching.
260+
- `oneOf` and `discriminator` definitions must match exactly.
261+
262262
#### xgen-IPA-106-create-method-response-is-get-method-response
263263

264264
![warn](https://img.shields.io/badge/warning-yellow)

0 commit comments

Comments
 (0)