Move package into ipa directory

Author: Sophia Marie Terry

tools/spectral/README.md

@@ -2,20 +2,6 @@
 
 A set of custom validation rules for the MongoDB Atlas Programmatic API, adhering to API Standards (IPA).
 
-## Quick Links
-
-| Site                        | Link                                                                                                     |
-| --------------------------- | -------------------------------------------------------------------------------------------------------- |
-| MongoDB API Standards (IPA) | [https://mongodb.github.io/ipa/](https://mongodb.github.io/ipa/)                                         |
-| Installation & Usage           | [IPA README](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa#readme) |
-| Implemented Rules           | [Ruleset Documentation](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/rulesets#readme) |
-| Spectral Docs               | [Spectral](https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview)                               |
-| Spectral Wiki (Internal)    | [http://go/openapi-spectral-updates](http://go/openapi-spectral-updates)                                 |
-| Contributing                | [CONTRIBUTING.md](https://github.com/mongodb/openapi/blob/main/tools/spectral/CONTRIBUTING.md)           |
-| Changelog                   | [CHANGELOG.md](https://github.com/mongodb/openapi/blob/main/tools/spectral/CHANGELOG.md)                 |
-| Issues                      | [https://github.com/mongodb/openapi/issues](https://github.com/mongodb/openapi/issues)                   |
-
-
 ## Structure
 
 - **/ipa** - Contains custom Spectral rulesets covering MongoDB API standards.

tools/spectral/ipa/README.md

@@ -2,6 +2,20 @@
 
 The IPA validation uses [Spectral](https://docs.stoplight.io/docs/spectral/9ffa04e052cc1-spectral-cli) to validate the [MongoDB Atlas Admin API OpenAPI Specification](https://github.com/mongodb/openapi/tree/main/openapi). The rules cover MongoDB's [Improvement Proposal for APIs](https://mongodb.github.io/ipa/) (IPA), which are best-practices for API design.
 
+
+## Quick Links
+
+| Site                        | Link                                                                                                     |
+| --------------------------- | -------------------------------------------------------------------------------------------------------- |
+| MongoDB API Standards (IPA) | [https://mongodb.github.io/ipa/](https://mongodb.github.io/ipa/)                                         |
+| Installation & Usage           | [IPA README](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa#readme) |
+| Implemented Rules           | [Ruleset Documentation](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/rulesets#readme) |
+| Spectral Docs               | [Spectral](https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview)                               |
+| Spectral Wiki (Internal)    | [http://go/openapi-spectral-updates](http://go/openapi-spectral-updates)                                 |
+| Contributing                | [CONTRIBUTING.md](https://github.com/mongodb/openapi/blob/main/tools/spectral/CONTRIBUTING.md)           |
+| Changelog                   | [CHANGELOG.md](https://github.com/mongodb/openapi/blob/main/tools/spectral/CHANGELOG.md)                 |
+| Issues                      | [https://github.com/mongodb/openapi/issues](https://github.com/mongodb/openapi/issues)                   |
+
 ## Running Locally
 
 ### Prerequisites
@@ -14,25 +28,32 @@ The IPA validation uses [Spectral](https://docs.stoplight.io/docs/spectral/9ffa0
 To run the IPA validation locally, install necessary dependencies with `npm install` if you haven't already. Then, simply run:
 
 ```
-npm run ipa-validation --file="{your/file/name}"
+npm run ipa-validation
 ```
 
 This command will run Spectral CLI for the ruleset [ipa-spectral.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/ipa-spectral.yaml).
 
 For use on the OpenAPI specification, run `npm run ipa-validation` from the root directory of the OpenAPI repo, which will validate the raw [v2.yaml](https://github.com/mongodb/openapi/blob/main/openapi/.raw/v2.yaml) OpenAPI spec.
 
-The Spectral CLI can also be used to run the validation on any valid OpenAPI file (`json` or `yaml`).
-
-```
-spectral lint {path/to/oas/file} --ruleset=./tools/spectral/ipa/ipa-spectral.yaml
-```
-
 ## Integrating IPA Validations
 
 To incorporate the IPA Spectral ruleset for OpenAPI specification validation in your repositories, you can follow these implementation approaches:
 
 ### Installation Options
 
+#### Package-based Installation
+
+Run:
+```
+npm install @mongodb/ipa-validation-ruleset
+```
+
+Then reference the ruleset directly in your `.spectral.yaml` file:
+```
+extends:
+- "@mongodb/ipa-validation-ruleset"
+```
+
 #### Server-based Installation
 
 You can reference our ruleset directly in your `.spectral.yaml` file without installation:
@@ -42,10 +63,6 @@ extends:
 - https://raw.githubusercontent.com/mongodb/openapi/<latest-git-commit-sha>/tools/spectral/ipa/ipa-spectral.yaml
 ```
 
-#### Package-based Installation
-
-Not supported yet
-
 ### Integration Methods
 
 #### Local Configuration
@@ -57,6 +74,13 @@ extends:
 - https://raw.githubusercontent.com/mongodb/openapi/<latest-git-commit-sha>/tools/spectral/ipa/ipa-spectral.yaml
 ```
 
+or 
+
+```
+extends:
+- "@mongodb/ipa-validation-ruleset"
+```
+
 For more information about how to extend rulesets, see the [web page](https://meta.stoplight.io/docs/spectral/83527ef2dd8c0-extending-rulesets).
 
 #### Customization Options

tools/spectral/ipa/package-lock.json

@@ -0,0 +1,25 @@
+{
+  "name": "@mongodb-js/ipa-validation-ruleset",
+  "version": "1.0.0",
+  "description": "Custom validation rules for MongoDB API Standards (IPA).",
+  "keywords": [
+    "mongodb",
+    "openapi",
+    "spectral"
+  ],
+  "homepage": "https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa#readme",
+  "bugs": {
+    "url": "https://github.com/mongodb/openapi/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mongodb/openapi.git"
+  },
+  "license": "Apache-2.0",
+  "author": "MongoDB",
+  "type": "module",
+  "main": "ipa-spectral.yaml",
+  "scripts": {
+    "test": "jest"
+  }
+}