Skip to content

Integration with development tools #231231

@TinaHeiligers

Description

@TinaHeiligers

Parent Issue: Part of elastic/kibana-team#1971

User Story ID: OAS-010

Description: As a developer, I want validation feedback to integrate with my existing development tools using the enhanced CLI tool so that I can address issues efficiently

Acceptance Criteria:

  • Enhances existing VS Code integration to use the improved CLI tool
  • Extends the existing command-line interface (scripts/validate_oas_docs.js) for local testing and debugging
  • Integrates with existing make api-docs-lint workflow while adding new capabilities
  • Offers file-specific validation for targeted testing using enhanced CLI tool
  • Maintains compatibility with existing OAS development patterns
  • Leverages existing @kbn/validate-oas package integration
  • Supports new output formats for better development experience

Priority: Medium
Phase: 2 - Local Validation Tool

Related Files:

  • scripts/validate_oas_docs.js (enhanced CLI tool)
  • packages/kbn-validate-oas/ (existing validation package)
  • .vscode/kibana-lint-oas.json
  • oas_docs/makefile
  • Existing VS Code OAS linting configuration

This issue is part of the OAS Quality Feedback Automation project tracked in elastic/kibana-team#1971.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:CorePlatform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t//enhancementNew value added to drive a business result

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions