Uploaded image for project: 'Managed Service - Streams'
  1. Managed Service - Streams
  2. MGDSTRM-9290

Add spectral OpenAPI linter for Admin Server

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Undefined Undefined
    • adminApiServer-0.13.0
    • None
    • None
    • None
    • MK - Sprint 225

      WHAT

      Add spectral OpenAPI linter for Admin Server. Example: https://github.com/bf2fc6cc711aee1a0c2a/srs-fleet-manager/blob/main/.github/workflows/openapi_lint.yaml

      WHY

      Improve quality of API by catching issues/inconsistencies earlier in development cycle.

      HOW

      `npx @stoplight/spectral-cli yourapi.yaml`

      DONE

      Include the following where applicable:

      • <bulleted list of functional acceptance criteria that need to be completed>
      • <call out anything on the documentation side that's needed as a result of this task being completed>
      • <any metrics, monitoring dashboards and alerts that need to be created or be updated>
      • <SOP creation or updates>

      Guidelines

      The following steps should be adhered to:

      • Required tests should be put in place - unit, integration, manual test cases (if necessary)
      • CI and all relevant tests passing
      • Changes have been verified by one additional reviewer against:
      • each required environment
      • each supported upgrade path
      • If the changes could have an impact on the clients (either UI or CLI), a JIRA should be created for making the required changes on the client side and acknowledged by one of the client side team members. PR has been merged
         

            srbiswas@redhat.com Srijoni Biswas
            medgar@redhat.com Michael Edgar
            Kafka Fleet Services
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: