CLOUDP-301224: Add readme

Author: lovisaberggren

tools/spectral/ipa/rulesets/README.md

@@ -0,0 +1,48 @@
+<!--- NOTE: This README file is generated, please see /scripts/generateRulesetReadme.js --->
+
+# IPA Validation Rules
+
+All Spectral rules used in the IPA validation are defined in rulesets grouped by IPA number (`IPA-XXX.yaml`). These rulesets are imported into the main IPA ruleset [ipa-spectral.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/ipa-spectral.yaml) which is used for running the validation.
+
+## Rulesets
+
+The tables below lists all available rules, their descriptions and severity level.
+
+### IPA-005
+
+| Rule Name                               | Description                                                              | Severity |
+| --------------------------------------- | ------------------------------------------------------------------------ | -------- |
+| xgen-IPA-005-exception-extension-format | IPA exception extensions must follow the correct format. http://go/ipa/5 | warn     |
+
+### IPA-102
+
+| Rule Name                                            | Description                                                                      | Severity |
+| ---------------------------------------------------- | -------------------------------------------------------------------------------- | -------- |
+| xgen-IPA-102-path-alternate-resource-name-path-param | Paths should alternate between resource names and path params. http://go/ipa/102 | warn     |
+
+### IPA-104
+
+| Rule Name                     | Description                                                     | Severity |
+| ----------------------------- | --------------------------------------------------------------- | -------- |
+| xgen-IPA-104-resource-has-GET | APIs must provide a get method for resources. http://go/ipa/104 | warn     |
+
+### IPA-109
+
+| Rule Name                                      | Description                                                               | Severity |
+| ---------------------------------------------- | ------------------------------------------------------------------------- | -------- |
+| xgen-IPA-109-custom-method-must-be-GET-or-POST | The HTTP method for custom methods must be GET or POST. http://go/ipa/109 | warn     |
+| xgen-IPA-109-custom-method-must-use-camel-case | The custom method must use camelCase format. http://go/ipa/109            | warn     |
+
+### IPA-113
+
+| Rule Name                               | Description                                                                                 | Severity |
+| --------------------------------------- | ------------------------------------------------------------------------------------------- | -------- |
+| xgen-IPA-113-singleton-must-not-have-id | Singleton resources must not have a user-provided or system-generated ID. http://go/ipa/113 | warn     |
+
+### IPA-123
+
+| Rule Name                                         | Description                                             | Severity |
+| ------------------------------------------------- | ------------------------------------------------------- | -------- |
+| xgen-IPA-123-enum-values-must-be-upper-snake-case | Enum values must be UPPER_SNAKE_CASE. http://go/ipa/123 | warn     |
+
+