oslo.policy/releasenotes/notes/deprecate-policy-file-json-format-e1921f15b5d00287.yaml
Ghanshyam Mann d8ca7c2789 Deprecate the JSON support for policy_file
JSON support for policy_file has been problematic
since projects started policy-in-code. For example,
generating a sample policy file in JSON results in
all the policy-in-code rules being overridden because
it is not possible to comment out the default rules in JSON.

Asd part of migration of JSON format to YAML, this commit
deprecates the:
1. Deprecate JSON support in oslo.policy.
2. Deprecate JSON output in policy CLI tools including '--format'
option.

Partial implement blueprint policy-json-to-yaml

Change-Id: I5432a8cf80903620f48936cbbfb92ea6b6ff30fa
2020-08-27 21:42:16 +00:00

13 lines
593 B
YAML

---
deprecations:
- |
``policy_file`` support for JSON formatted file is deprecated. Use
YAML formatted file which will be default in future.
Use `oslopolicy-convert-json-to-yaml <https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html>`_
tool to convert the existing JSON to YAML formatted policy file in
backward compatible way.
JSON format support and ``--format`` option in ``oslopolicy-sample-generator``
and ``oslopolicy-policy-upgrade`` tools are also deprecated. In future
release, ``--format`` option will be removed.