Skip to content
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

Ensure an up to date OpenAPI schema is included in the repo #252

Merged
merged 17 commits into from
Feb 3, 2025

Conversation

mz2
Copy link
Collaborator

@mz2 mz2 commented Jan 31, 2025

Description

Adds a GitHub workflow for checking that there is an up to date copy of the schema under ./backend/schemata

Rationale: since we run presently copies of the service in Canonical internal networks, for automation purposes it is easier to consume the API this way.

Resolved issues

None.

Documentation

README mentions of pre-commit added.

Tests

No production code changes => no tests.

@mz2 mz2 requested a review from omar-selo January 31, 2025 15:21
Copy link
Collaborator

@omar-selo omar-selo left a comment

Choose a reason for hiding this comment

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

Thanks for this addition. It looks good, but I have a few comments. The main one is that it seems more appropriate for the schema and pre-commit to live in backend directory.

backend/Dockerfile Show resolved Hide resolved
backend/README.md Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
backend/scripts/fetch_openapi_schema.sh Outdated Show resolved Hide resolved
.github/workflows/check_openapi_schema.yml Outdated Show resolved Hide resolved
.github/workflows/check_openapi_schema.yml Outdated Show resolved Hide resolved
@omar-selo omar-selo merged commit e428e0e into main Feb 3, 2025
2 checks passed
@omar-selo omar-selo deleted the ensure-up-to-date-openapi-schema branch February 3, 2025 13:21
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.

2 participants