Skip to content

Commit ae54d57

Browse files
author
Sophia Marie Terry
committed
CLOUDP-328959: Updated docs
1 parent 11f4aab commit ae54d57

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

tools/spectral/ipa/rulesets/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,17 @@ Rule checks for the following conditions:
273273
- Ignores resources without a Get method
274274
- Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
275275

276+
#### xgen-IPA-106-valid-operation-id
277+
278+
`off`
279+
OperationID should be compliant with IPA-106 Naming guidelines.
280+
281+
##### Implementation details
282+
Rule checks for the following conditions:
283+
- Applies only to POST methods on resource collection paths
284+
- Generates the expected OperationId given the resource identifier
285+
- Compares the generated IPA Compliant OperationId with the existing OperationId
286+
276287

277288

278289
### IPA-107
@@ -344,6 +355,17 @@ Rule checks for the following conditions:
344355
- Validation only applies to schema references to a predefined schema (not inline)
345356
- Confirms the referenced schema name ends with "Request" suffix
346357

358+
#### xgen-IPA-107-valid-operation-id
359+
360+
`off`
361+
OperationID should be compliant with IPA-107 Naming guidelines.
362+
363+
##### Implementation details
364+
Rule checks for the following conditions:
365+
- Validation checks the PATCH/PUT methods for single resource paths and [singleton resources](https://go/ipa/113).
366+
- Generates the expected OperationId given the resource identifier
367+
- Compares the generated IPA Compliant OperationId with the existing OperationId
368+
347369

348370

349371
### IPA-108
@@ -388,6 +410,17 @@ Rule checks for the following conditions:
388410
- Fails if any requestBody is defined for the DELETE method
389411
- Skips validation for collection endpoints (without path parameters)
390412

413+
#### xgen-IPA-108-valid-operation-id
414+
415+
`off`
416+
OperationID should be compliant with IPA-108 Naming guidelines.
417+
418+
##### Implementation details
419+
Rule checks for the following conditions:
420+
- Applies to all DELETE methods for single resource endpoints (with path parameters)
421+
- Generates the expected OperationId given the resource identifier
422+
- Compares the generated IPA Compliant OperationId with the existing OperationId
423+
391424

392425

393426
### IPA-109

0 commit comments

Comments
 (0)