Skip to content

Conversation

@sbliven
Copy link
Member

@sbliven sbliven commented May 20, 2025

Description

Use yaml to parse all JSON files (fix #1120)

This change is backwards compatible. No changes to existing json files are needed (although yaml features like comments can be added if desired). YAML features like comments can be added in the existing JSON files without changing the filename. If you want editor support for yaml it might be desirable to change the config file suffixes to .yaml; this is not done by default but is supported through environmental variables (FUNCTIONAL_ACCOUNT_FILE and similar).

Motivation

Use of yaml for the jobConfig.yaml file has been convenient. This PR extends that out to other JSON config files.

Fixes

Tests included

  • Included for each change/fix?
  • Passing?

Documentation

  • swagger documentation updated (required for API changes)
  • official documentation updated

official documentation info

@sbliven sbliven requested review from bpedersen2 and nitrosx May 20, 2025 12:29
@sbliven sbliven requested a review from Junjiequan May 22, 2025 07:54
@sbliven sbliven self-assigned this May 22, 2025
Copy link
Member

@nitrosx nitrosx left a comment

Choose a reason for hiding this comment

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

Can you clarify my questions?

Copy link
Member

@Junjiequan Junjiequan left a comment

Choose a reason for hiding this comment

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

looks good to me

sbliven added 3 commits July 17, 2025 14:58
This is backwards compatible. No changes to existing json files are
needed (although yaml features like comments can be added if desired).
@nitrosx
Copy link
Member

nitrosx commented Sep 2, 2025

Looks good to me.

@bpedersen2
Copy link
Contributor

This would also enable us to provide commented sample config files, making admin docs more usable and probably easier to maintain.

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.

Parse config files as YAML

4 participants