From e547fcf7e2c4b386c16c00b079aec2322b72f84b Mon Sep 17 00:00:00 2001 From: jdholtz Date: Sun, 24 Nov 2024 20:00:00 -0600 Subject: [PATCH] Update changelog to include JSON schema addition --- .github/workflows/docker.yml | 1 + CHANGELOG.md | 6 ++++++ CONFIGURATION.md | 4 ++-- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 9f279a76..aa37801c 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -19,6 +19,7 @@ on: - ".pre-commit-config.yaml" - "**.md" - "config.example.json" + - "config.schema.json" - "LICENSE" - "pyproject.toml" - "setup.cfg" diff --git a/CHANGELOG.md b/CHANGELOG.md index cdb119db..8344e9d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,12 @@ If there is no "Upgrading" header for that version, no post-upgrade actions need ## Upcoming +### New Features +- A [JSON Schema](https://json-schema.org/) definition was added to help users validate their configuration files through updates +([#320](https://github.com/jdholtz/auto-southwest-check-in/pull/320) by [@kaveet](https://github.com/kaveet)) + - If you want to use this schema, you'll need to add the following line to your `config.json` file: + `"$schema": "config.schema.json"` + ### Improvements - Logins that fail due to 'Too Many Requests' or 'Internal Server Error' errors will now be retried once ([#311](https://github.com/jdholtz/auto-southwest-check-in/pull/311) by [@dmytrokoren](https://github.com/dmytorkoren)) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 254c01ef..391dabb2 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -11,7 +11,7 @@ reservation-specific configurations). ## Table of Contents - [Check Fares](#check-fares) - [Notifications](#notifications) - * [Notification URLS](#notification-urls) + * [Notification URLs](#notification-urls) * [Notification Level](#notification-level) * [Notification 24 Hour Time](#notification-24-hour-time) * [Test The Notifications](#test-the-notifications) @@ -187,7 +187,7 @@ Setting specific configuration values for an account or reservation allows you t monitored by the script. Here is a list of configuration values that can be applied to an individual account or reservation: - [Check Fares](#check-fares) - [Healthchecks URL](#healthchecks-url) -- [Notification URLS](#notification-urls) +- [Notification URLs](#notification-urls) - [Notification Level](#notification-level) - [Retrieval Interval](#retrieval-interval)