Skip to content

PEP 739: add version specification to schema_version #4112

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.

Sign up for GitHub

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

Merged
FFY00 merged 1 commit into from
Nov 6, 2024
Merged

PEP 739: add version specification to schema_version #4112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions peps/pep-0739.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ below, which is rendered in an human-readable format here.
* - ``$schema``
- https://json-schema.org/draft/2020-12/schema
* - ``$id``
- https://github.com/python/peps/blob/main/peps/pep-0739/python-build-info-v1.schema.json
- https://github.com/python/peps/blob/main/peps/pep-0739/python-build-info-v1.0.schema.json
* - Title
- Static description file for the build details of Python
installations
Expand All @@ -90,13 +90,28 @@ below, which is rendered in an human-readable format here.
:widths: 25 75

* - Type
- ``string`` (constant — ``1``)
- ``string`` (constant — ``1.0``)
* - Description
- Schema version.

This is a constant value and MUST be ``1``, when using the
schema described here. Future iterations of this schema MUST
update this value.
This is a string following the format ``<MAJOR>.<MINOR>``, where
``<MAJOR>`` and ``<MINOR>`` are unpaded numbers and represent
the **major** and **minor** components of the version. Versions
may be arithmetic compared by intrepreting the version string as
a decimal number.

For this specification version, this value is constant and MUST
be ``1.0``.

Future versions of this schema MUST use a higher version number.
Future versions of this schema MUST NOT use the same **major**
version component as other schema version unless its
specification is deemed backwards-compatible with them — it
can't change, or extend, any parts of the current specification
in such a way as the semantics of the interpreted data differ,
or that data valid under the new specification is invalid under
the older specification, with the exception of additional
properties (errors caused by ``additionalProperties``).
* - Required
- **True**

Expand Down Expand Up @@ -698,7 +713,7 @@ Example
JSON Schema
===========

.. literalinclude:: pep-0739/python-build-info-v1.schema.json
.. literalinclude:: pep-0739/python-build-info-v1.0.schema.json
:language: json
:linenos:

Expand Down
2 changes: 1 addition & 1 deletion peps/pep-0739/example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"schema_version": "1",
"schema_version": "1.0",
"base_prefix": "/usr",
"platform": "linux-x86_64",
"language": {
Expand Down
6 changes: 3 additions & 3 deletions ...pep-0739/python-build-info-v1.schema.json → ...p-0739/python-build-info-v1.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/python/peps/blob/main/peps/pep-0739/python-build-info-v1.schema.json",
"$id": "https://github.com/python/peps/blob/main/peps/pep-0739/python-build-info-v1.0.schema.json",
"type": "object",
"title": "Static description file for the build details of Python installations",
"required": [
Expand All @@ -13,8 +13,8 @@
"properties": {
"schema_version": {
"type": "string",
"description": "Schema version.\n\nThis is a constant value and MUST be ``1``, when using the schema described here. Future iterations of this schema MUST update this value.",
"const": "1"
"description": "Schema version.\n\nThis is a string following the format ``<MAJOR>.<MINOR>``, where ``<MAJOR>`` and ``<MINOR>`` are unpaded numbers and represent the **major** and **minor** components of the version. Versions may be arithmetic compared by intrepreting the version string as a decimal number.\n\nFor this specification version, this value is constant and MUST be ``1.0``.\n\nFuture versions of this schema MUST use a higher version number. Future versions of this schema MUST NOT use the same **major** version component as other schema version unless its specification is deemed backwards-compatible with them — it can't change, or extend, any parts of the current specification in such a way as the semantics of the interpreted data differ, or that data valid under the new specification is invalid under the older specification, with the exception of additional properties (errors caused by ``additionalProperties``).",
"const": "1.0"
},
"base_prefix": {
"type": "string",
Expand Down
Loading