Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OAS][DOCS] Adds linting rule for missing property descriptions #191594

Merged

Conversation

natasha-moore-elastic
Copy link
Contributor

Summary

Resolves https://github.com/elastic/docs-projects/issues/237 by adding a custom linting rule for missing property descriptions.

@natasha-moore-elastic natasha-moore-elastic added Team:Docs release_note:skip Skip the PR/issue when compiling release notes docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels Aug 28, 2024
@natasha-moore-elastic natasha-moore-elastic requested a review from a team as a code owner August 28, 2024 10:36
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This rule only looks at properties in the components.schemas section of the OpenAPI document, so it won't catch any properties listed directly in the operations. Given how many hits already occur, however, I think this is okay as a starting point for cleanup.

I've also added a new make command in case folks want to be able to see errors only, since I've been thinking of this for quick debugging purposes.

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #81 / Cloud Security Posture Test adding Cloud Security Posture Integrations CSPM AWS CIS_AWS Organization Manual Direct Access CIS_AWS Organization Manual Direct Access Workflow

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@natasha-moore-elastic natasha-moore-elastic merged commit 9babac0 into elastic:main Aug 29, 2024
21 checks passed
@kibanamachine kibanamachine added v8.16.0 backport:skip This commit does not require backporting labels Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants