CHANGELOG.md

v0.1.11

Released 2026-02-17

* feature: `namespace_overrides` to allow sending resources to different namespaces in one `lightbeam send`

v0.1.10

Released 2025-11-21

* bugfix: `lightbeam send` not writing >=7.2 API error messages when error payload does not contain `errors` nor `validationErrors` * fix: invalid YAML for `count.separator` in docs example `lightbeam.yml`

v0.1.9

Released 2025-09-26

* feature: support new and improved error messages [introduced in Ed-Fi API 7.2](https://docs.ed-fi.org/reference/ods-api/7.2/whats-new/whats-new-in-this-release/#enhanced-api-error-handling) by @tomreitz in #80 * feature: warn and skip fetching if `--query` keys are not valid parameters for an endpoint by @tomreitz in #81 * bugfix: fix a `KeyError` if `connection.verify_ssl` is not set in `lightbeam.yml` by @tomreitz in #79

v0.1.8

Released 2025-07-11

* bugfix: subarray uniqueness bug by @tomreitz in #76 * bugfix: GET deletes by identity, not required params by @tomreitz in #68 * feature: implement case flexibility for data discovery by @tomreitz in #31 and #77 * feature: implementation of new `lightbeam create` functionality by @tomreitz in #56 * feature: implementing validate references selector, behavior and remote switch, plus update docs by @tomreitz in #61

v0.1.7

Released 2025-05-08

• bugfix: discovery of data in subfolders of data_dir by @tomreitz in #66
• bugfix: structured results record counts by @tomreitz in #60
• bugfix: validation error message shows the wrong number of records by @johncmerfeld in #65
• feature: adds a --set flag to the CLI to enable overriding config values in lightbeam.yml by @tomreitz in #63
• bugfix: validate uniqueness fixes and recurse into array elements, other improvements by @tomreitz in #67
• bugfix: eplace obsolete links to Ed-Fi Tech Docs by @stephenfuqua in #70
• bugfix: self-reference validation by @tomreitz in #71
• feature: protocol (http/https) fall-back for discovery URLs if not found by @ryanaguilar in #74

v0.1.6

Released 2024-11-15

• feature: implement structured results file output for validate
• bugfix: --results-file required a directory prefix
• bugfix: validate of descriptor values without a hash char (#) failed
• bugfix: validate uniqueness by identity instead of required
• bugfix: allow deletion of students (if permitted by credential claimset and API auth strategy)
• bugfix: make max_failures truly optional

v0.1.5

Released 2024-07-23

• feature: add a successes section to the structured log results file to report how many payloads resulted in a 200, 201, etc.
• feature: add a test suite
• bugfix: lightbeam send resulted in an error about lightbeam.get_endpoints_with_data()
• bugfix: restore endpoint dependency ordering to lightbeam.get_endpoints_with_data()
• bugfix: custom API URLs not picked up when some, but not all, are specified

v0.1.4

Released 2024-07-12

• feature: reference validation
• feature: notify user of endpoints to be deleted
• bugfix: handle descriptors with missing (optional) description

v0.1.3

Released 2024-06-03

• feature: Support custom Ed-Fi URLs
• bugfix: Fix --drop-keys and --keep-keys filtering
• bugfix: Ensure command list in help menu and log output is always consistent
• bugfix: Fix how hashlog entries are removed during lightbeam delete
• bugfix: Fix validation of local descriptor values within nested payloads
• bugfix: No descriptor payload keys were kept after being downloaded by lightbeam validate

v0.1.2

Released 2024-04-19

• feature: Add ability for fetch --keep-keys and --drop-keys flags to allow wildcard matching
• feature: Update structured logging to be flatter, per recent team discussion
• bugfix: Support for definitionsbeing renamed to components.schemas in Ed-Fi 7.1 Swagger

v0.1.1

Released 2024-02-16

• bugfix: replace single quotes in logging message with backticks
• bugfix: fetching resources without read permission

v0.1.0

Released 2023-10-16

• feature: adding lightbeam count and lightbeam fetch, with other bugfixes and improvements
• bugfix: typo in descriptor CSV header

v0.0.8

Released 2023-07-11

• bugfix: fixing a bug to create the results_file directory if needed

v0.0.7

Released 2023-06-13

• bugfix: fixing a bug with Ed-Fi 6.1 API's dependencies
• bugfix: fixing a bug with per-request timeout
• feature: adding an option to produce structured output
• feature: adding skip exit code

v0.0.6

Released 2023-04-07

• bugfix: resolve error fetching Swagger docs

v0.0.5

Released 2023-04-07

• bugfix: better error logging (file name and line number) for erroring payloads
• bugfix: better error handling in cases where the Ed-Fi API dependencies and Swagger URLs return error status codes

v0.0.4

Released 2023-01-25

• bugfix: fetching descriptor values for all namespaces, not just ed-fi

v0.0.3

Released 2023-01-12

• bugfix: add pagination when fetching descriptor values

v0.0.2

Released 2022-12-16

• un-pin requirements.txt dependencies from fixed versions

v0.0.1

Released 2022-09-22

• initial release