Skip to content

ci: publish openapi to scalar, sync version#1978

Merged
ChrisSchinnerl merged 1 commit intomasterfrom
alex
Sep 16, 2025
Merged

ci: publish openapi to scalar, sync version#1978
ChrisSchinnerl merged 1 commit intomasterfrom
alex

Conversation

@alexfreska
Copy link
Copy Markdown
Member

@alexfreska alexfreska commented Aug 26, 2025

  • Workflow for publishing the openapi spec when the file changes on master or via manual trigger.
    • Note: this step will throw an error until tomorrow. I reported an issue with this API to the scalar team and they said it would be fixed in the next release (1-2 days).
  • Workflow for syncing the openapi spec version field to the repo latest release version. When the versions are out of sync this workflow will open a PR.

@github-project-automation github-project-automation bot moved this to In Progress in Sia Aug 26, 2025

This comment was marked as outdated.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a GitHub Actions workflow to automatically publish the OpenAPI specification to Scalar Registry when changes are made to the openapi.yml file or when manually triggered.

  • Adds automated publishing of OpenAPI spec to Scalar Registry
  • Configures workflow to trigger on openapi.yml changes to master branch
  • Enables manual workflow dispatch for on-demand publishing

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you also update the version in the openapi spec to match the latest released renterd version?

Copy link
Copy Markdown
Member Author

@alexfreska alexfreska Sep 2, 2025

Choose a reason for hiding this comment

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

I added another shared workflow for that, I'll add it to this PR. SiaFoundation/workflows#17

@alexfreska alexfreska force-pushed the alex branch 2 times, most recently from 03360e7 to 1860ab8 Compare September 2, 2025 14:34
@alexfreska alexfreska changed the title ci: publish openapi to scalar ci: publish openapi to scalar, sync version Sep 2, 2025
@ChrisSchinnerl ChrisSchinnerl merged commit 2c62e81 into master Sep 16, 2025
15 checks passed
@ChrisSchinnerl ChrisSchinnerl deleted the alex branch September 16, 2025 13:55
@github-project-automation github-project-automation bot moved this from In Progress to Done in Sia Sep 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants