Skip to content

[gha] ensure bundled openapi.yaml is in sync #243

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.

Sign up for GitHub

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
shreyav merged 1 commit into from
Mar 3, 2026
Merged

[gha] ensure bundled openapi.yaml is in sync #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/dummy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ on:
pull_request:
paths-ignore:
- 'openapi.yaml'
- 'openapi/**'
- 'mintlify/**'
- '.markdownlint.json'
merge_group:
paths-ignore:
- 'openapi.yaml'
- 'openapi/**'
- 'mintlify/**'
- '.markdownlint.json'

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ on:
branches: [ main ]
paths:
- 'openapi.yaml'
- 'openapi/**'
- '.markdownlint.json'
- 'mintlify/**'
pull_request:
branches: [ main ]
paths:
- 'openapi.yaml'
- 'openapi/**'
- '.markdownlint.json'
- 'mintlify/**'
# Allow manual triggering
Expand Down
10 changes: 10 additions & 0 deletions .github/workflows/openapi-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ on:
branches: [ main ]
paths:
- 'openapi.yaml'
- 'openapi/**'
- 'mintlify/**'
pull_request:
branches: [ main ]
paths:
- 'openapi.yaml'
- 'openapi/**'
- 'mintlify/**'
# Allow manual triggering
workflow_dispatch:
Expand All @@ -36,3 +38,11 @@ jobs:

- name: Build documentation
run: make build

- name: Check compiled OpenAPI is up to date
run: |
if ! git diff --exit-code openapi.yaml mintlify/openapi.yaml; then
echo "ERROR: Compiled openapi.yaml is out of sync with source files in openapi/."
Copy link
Contributor

@greptile-apps greptile-apps bot Mar 3, 2026

Choose a reason for hiding this comment

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

The error message only mentions openapi.yaml, but the git diff check on line 44 validates both openapi.yaml and mintlify/openapi.yaml. If only mintlify/openapi.yaml is out of sync, this message will be misleading.

Suggested change
echo "ERROR: Compiled openapi.yaml is out of sync with source files in openapi/."
echo "ERROR: Compiled openapi.yaml or mintlify/openapi.yaml is out of sync with source files in openapi/."
Prompt To Fix With AI 
This is a comment left during a code review.
Path: .github/workflows/openapi-build.yml
Line: 45

Comment:
The error message only mentions `openapi.yaml`, but the `git diff` check on line 44 validates both `openapi.yaml` and `mintlify/openapi.yaml`. If only `mintlify/openapi.yaml` is out of sync, this message will be misleading.

```suggestion
            echo "ERROR: Compiled openapi.yaml or mintlify/openapi.yaml is out of sync with source files in openapi/."
```

How can I resolve this? If you propose a fix, please make it concise.

echo "Run 'make build' locally and commit the result."
exit 1
fi
2 changes: 1 addition & 1 deletion mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion openapi/components/schemas/quotes/PurposeOfPayment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
type: string
description: >-
The purpose of the payment. This may be required when sending to certain
geographies such as India.
geographies (e.g. India).
enum:
- GIFT
- SELF
Expand Down
Loading