CLOUDP 329982: Documentation changes to public IPA links (#818)

Author: sphterry

README.md

@@ -15,8 +15,8 @@ The [tools/cli](tools/cli) directory hosts a Go-based CLI tool used to merge mul
 For more details, please refer to the [CLI’s README.md](tools/cli/README.md).
 
 ### Spectral
-The [tools/spectral](tools/spectral) directory contains MongoDB-specific [Spectral](https://github.com/stoplightio/spectral) rule definitions.
-These rules are used to validate that the generated OpenAPI specifications comply with MongoDB’s guidelines.
+The [tools/spectral](tools/spectral) directory contains [Spectral](https://github.com/stoplightio/spectral) rule definitions.
+These rules are used to validate that the generated OpenAPI specifications comply with MongoDB's [Improvement Proposal for APIs](https://mongodb.github.io/ipa/) (IPA).
 
 For more details, please refer to the [Spectral’s README.md](tools/spectral/README.md).
 

tools/README.md

@@ -8,7 +8,7 @@ Includes resources and scripts to generate [MongoDB Atlas Postman Collections](h
 
 ## Spectral
 
-MongoDB [Spectral](https://github.com/stoplightio/spectral) OpenAPI specification validation rules
+MongoDB [Spectral](https://github.com/stoplightio/spectral) OpenAPI specification validation rules for IPA-compliance.
 
 ## CLI
 

tools/spectral/README.md

@@ -10,7 +10,10 @@ A set of custom validator rules for the MongoDB Atlas Programmatic API, adhering
 
 For a complete list of implemented rules, please refer to the [Ruleset Documentation](./ipa/rulesets/README.md).
 
+### External Documentation
+
+- Refer to the [IPA Standards](https://mongodb.github.io/ipa/) for specific rules.
+
 ### Internal Documentation
 
-- Refer to the [IPA Standards](http://go/ipa) for specific rules.
 - Visit the [Spectral Wiki](http://go/openapi-spectral-updates) for additional information.

tools/spectral/ipa/README.md

@@ -1,8 +1,6 @@
 # IPA Validation
 
-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 best-practices for API design.
-
-**Note:** For MongoDB engineers, please review https://go/ipa-validation for additional information.
+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.
 
 ## Running Locally
 

tools/spectral/ipa/rulesets/IPA-005.yaml

@@ -1,5 +1,5 @@
 # IPA-5: Documenting Exceptions to IPAs
-# http://go/ipa/5
+# https://mongodb.github.io/ipa/5
 
 functions:
   - IPA005ExceptionExtensionFormat

tools/spectral/ipa/rulesets/IPA-102.yaml

@@ -1,5 +1,5 @@
 # IPA-102: Resource Identifiers
-# http://go/ipa/102
+# https://mongodb.github.io/ipa/102
 
 rules:
   xgen-IPA-102-collection-identifier-camelCase:

tools/spectral/ipa/rulesets/IPA-104.yaml

@@ -1,5 +1,5 @@
 # IPA-104: Get
-# http://go/ipa/104
+# https://mongodb.github.io/ipa/104
 
 functions:
   - IPA104EachResourceHasGetMethod

tools/spectral/ipa/rulesets/IPA-105.yaml

@@ -1,5 +1,5 @@
 # IPA-105: List
-# http://go/ipa/105
+# https://mongodb.github.io/ipa/105
 
 functions:
   - IPA105ListResponseCodeShouldBe200OK

tools/spectral/ipa/rulesets/IPA-106.yaml

@@ -1,5 +1,5 @@
 # IPA-106: Create
-# https://mdb.link/mongodb-atlas-openapi-validation#
+# https://mongodb.github.io/ipa/106
 
 functions:
   - IPA106CreateMethodRequestBodyIsRequestSuffixedObject

tools/spectral/ipa/rulesets/IPA-107.yaml

@@ -1,5 +1,5 @@
 # IPA-107: Update
-# http://go/ipa/107
+# https://mongodb.github.io/ipa/107
 
 functions:
   - IPA107UpdateMethodMustNotHaveQueryParams