CLOUDP-304965: IPA rule for descriptions

[lovisaberggren]

Proposed changes

Adds rule to check for descriptions presence and empty descriptions, it covers:

• Info object
• Tags
• Operation objects
• Inline schema properties for operation object requests and responses
• Parameter objects (in operations and components)
• Schema properties

It can replace the legacy spectral check we have right now.

The violations are the same as we have for the legacy rule:

xgen-IPA-117-description  Description not found. API producers must provide descriptions for Properties, Operations and Parameters. https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-117-description  components.schemas.ClusterProviderSettings.properties.providerName
xgen-IPA-117-description  Description not found. API producers must provide descriptions for Properties, Operations and Parameters. https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-117-description  components.schemas.DataLakeStoreSettings.properties.provider
xgen-IPA-117-description  Description not found. API producers must provide descriptions for Properties, Operations and Parameters. https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-117-description  components.schemas.charFiltermapping.properties.mappings.properties.additionalProperties

Jira ticket: CLOUDP-304965

[lovisaberggren]

FYI wanted to use aliases for these, but got an anonymous error from Spectral, not sure why, perhaps aliases don't work with custom functions. I went like this for now and will see if I can get aliases working, or if I need to open an issue with Spectral

[yelizhenden-mdb]

Q: Don't we need to run IPA docs generation?

[lovisaberggren]

Q: Don't we need to run IPA docs generation?

Hmm yes I'll check why it didn't fail

[lovisaberggren]

@yelizhenden-mdb I didn't add the new ruleset to the base ipa-spectral file so it wasn't included in the validation or the docs

[yelizhenden-mdb]

LGTM, thanks!