8000 feat: Automate OpenAPI type definition updates by daveads · Pull Request #113 · permitio/permit-cli · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

feat: Automate OpenAPI type definition updates #113

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

Merged
merged 7 commits into from
May 9, 2025

Conversation

daveads
Copy link
Collaborator
@daveads daveads commented Apr 23, 2025

This PR adds a GitHub Actions workflow that automatically updates our TypeScript type definitions for the Permit.io APIs. It:

  • Runs weekly on Mondays at midnight UTC
  • Downloads the latest API schemas from both the main API and PDP API endpoints
  • Generates updated TypeScript definitions using openapi-typescript
  • Creates a PR automatically if changes are detected

This automation removes the need for manual updates, ensuring our type definitions are always in sync with the actual APIs.

Closes #112

@daveads
Copy link
Collaborator Author
daveads commented Apr 23, 2025

Screenshot 2025-04-23 at 14-00-27 Pull requests · daveads_permit-cli
Screenshot 2025-04-23 at 14-00-07 test  · daveads_permit-cli@5022fd6
Screenshot 2025-04-23 at 14-00-42 Update OpenAPI Type Definitions by github-actions bot · Pull Request #5 · daveads_permit-cli

Test was Ran on local Fork...

@daveads
Copy link
Collaborator Author
daveads commented Apr 23, 2025

for now test runs once a week on Monday... buh i don't really know how often Permit.io API schema changes.

@gemanor

@daveads daveads requested a review from gemanor April 23, 2025 19:22
Copy link
Collaborator
@gemanor gemanor left a comment

Choose a reason for hiding this comment

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

Please remove the action file and then we can merge it

@gemanor gemanor merged commit 4256e08 into permitio:main May 9, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automate OpenAPI Type Definition Updates with GitHub Actions
2 participants
0