Skip to content

Auto-sync Postman collection with OpenAPI schema on merge to main #1346

Open

Description

@Ayush8923

Problem

Our shared Postman collection is updated manually, so it often goes out of sync with the actual API. Teams end up using outdated endpoints, request bodies, or missing new APIs.

Proposed Solution

Add a GitHub Actions workflow that runs on every push to main (after merge) and:

  1. Exports the OpenAPI schema using the existing backend/scripts/kaapi_export_openapi.py
  2. Converts it to a Postman collection using openapi-to-postmanv2
  3. Updates the shared team collection via the Postman API

This will be a separate workflow from the existing PR-level API Breaking Changes Check, so only merged changes reach Postman.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions