Merge pull request #497 from openownership/kca-496

Fixed json pointers in the schema reference page, fixes #496

README.md

@@ -41,11 +41,11 @@ Meanwhile, to include the appropriate version of docson JS after you clone this
 git submodule init
 git submodule update
 ```
-Create a Python Virtual Environment. It should be python3.8 to match our build server.
+Create a Python Virtual Environment. It should be python3.9 to match our build server.
 
-    python3 -m virtualenv -p python3.8 .ve
+    python3 -m virtualenv -p python3.9 .ve
 
-(If you don't have python3.8 installed [see here](https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa).)
+(If you don't have python3.9 installed [see here](https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa).)
 
 Activate the virtual environment:
 

docs/schema/reference.rst

@@ -31,10 +31,10 @@ Address
 -------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Address/description
+   :pointer: /$defs/Address/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Address
+   :pointer: /$defs/Address
    :externallinks: {"type":{"url":"#addresstype","text":"AddressType"}}
    :allowexternalrefs:
 
@@ -51,10 +51,10 @@ Agent
 -----
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Agent/description
+   :pointer: /$defs/Agent/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Agent
+   :pointer: /$defs/Agent
    :collapse:
    :allowexternalrefs:
 
@@ -66,7 +66,7 @@ Annotation
 The ``annotations`` property of statements currently allows an array of these simple annotation objects to be included. An annotation can be used to hold information (structured or otherwise) for which a place does not exist elsewhere in the schema. See :ref:`Sources and annotations <provenance>` for further guidance.
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Annotation
+   :pointer: /$defs/Annotation
    :externallinks: {"motivation":{"url":"#annotationmotivation","text":"AnnotationMotivation"}}
    :allowexternalrefs:
 
@@ -76,10 +76,10 @@ Country
 -------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Country/description
+   :pointer: /$defs/Country/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Country
+   :pointer: /$defs/Country
    :allowexternalrefs:
 
 
@@ -104,7 +104,7 @@ ID
 A string of minimum length 32 and maximum length 64.
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/ID/description
+   :pointer: /$defs/ID/description
 
 .. _schema-identifier:
 
@@ -114,10 +114,10 @@ Identifier
 The Identifier object is used to connect a statement to the real-world person or entity that it refers to, using one or more existing known identifiers. See :any:`Real world identifiers <guidance-identifiers>` for technical guidance on when and how to use this object.
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Identifier/description
+   :pointer: /$defs/Identifier/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Identifier
+   :pointer: /$defs/Identifier
    :allowexternalrefs:
 
 .. _schema-interest:
@@ -126,10 +126,10 @@ Interest
 --------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Interest/description
+   :pointer: /$defs/Interest/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Interest
+   :pointer: /$defs/Interest
    :collapse: share
    :externallinks: {"share":{"url":"#share","text":"Share"}, "type":{"url":"#interesttype","text":"InterestType"}}
    :allowexternalrefs:
@@ -140,7 +140,7 @@ InterestedParty
 ---------------
 
 .. json-value:: ../_build_schema/ownership-or-control-statement.json
-   :pointer: /definitions/InterestedParty/description
+   :pointer: /$defs/InterestedParty/description
 
 .. jsonschema:: ../_build_schema/ownership-or-control-statement.json
    :pointer: /properties/interestedParty
@@ -154,10 +154,10 @@ Jurisdiction
 ------------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Jurisdiction/description
+   :pointer: /$defs/Jurisdiction/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Jurisdiction
+   :pointer: /$defs/Jurisdiction
    :allowexternalrefs:
 
 .. _schema-name:
@@ -166,10 +166,10 @@ Name
 ----
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Name/description
+   :pointer: /$defs/Name/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Name
+   :pointer: /$defs/Name
    :externallinks: {"type":{"url":"#nametype","text":"NameType"}}
    :allowexternalrefs:
 
@@ -194,10 +194,10 @@ PepStatusDetails
 ----------------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/PepStatusDetails/description
+   :pointer: /$defs/PepStatusDetails/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/PepStatusDetails
+   :pointer: /$defs/PepStatusDetails
    :collapse: jurisdiction,source
    :externallinks: {"source/type":{"url":"#sourcetype","text":"SourceType"}}
    :allowexternalrefs:
@@ -222,10 +222,10 @@ PublicListing
 ---------------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/PublicListing/description
+   :pointer: /$defs/PublicListing/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/PublicListing
+   :pointer: /$defs/PublicListing
    :collapse: securitiesListings
    :allowexternalrefs:
 
@@ -235,10 +235,10 @@ PublicationDetails
 ------------------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/PublicationDetails/description
+   :pointer: /$defs/PublicationDetails/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/PublicationDetails
+   :pointer: /$defs/PublicationDetails
    :collapse: publisher
    :allowexternalrefs:
 
@@ -248,10 +248,10 @@ Publisher
 ---------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Publisher/description
+   :pointer: /$defs/Publisher/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Publisher
+   :pointer: /$defs/Publisher
    :allowexternalrefs:
 
 
@@ -262,7 +262,7 @@ ReplacesStatements
 ------------------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/ReplacesStatements/description
+   :pointer: /$defs/ReplacesStatements/description
 
 See :any:`Updating statements <guidance-updating-data>` for technical guidance on working with updates to data.
 
@@ -273,13 +273,13 @@ SecuritiesListing
 -----------------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/SecuritiesListing/description
+   :pointer: /$defs/SecuritiesListing/description
 
 See :any:`Real world identifiers <guidance-identifiers-other>` for technical guidance on representing securities listings.
 
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/SecuritiesListing
+   :pointer: /$defs/SecuritiesListing
    :externallinks: {"security/idScheme":{"url":"#securitiesidentifierschemes","text":"SecuritiesIdentifierSchemes"}}
    :allowexternalrefs:
 
@@ -289,10 +289,10 @@ Share
 -----
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Interest/properties/share/description
+   :pointer: /$defs/Interest/properties/share/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Interest/properties/share
+   :pointer: /$defs/Interest/properties/share
    :allowexternalrefs:
 
 
@@ -302,10 +302,10 @@ Source
 ------
 
 .. json-value:: ../_build_schema/components.json
-   :pointer: /definitions/Source/description
+   :pointer: /$defs/Source/description
 
 .. jsonschema:: ../_build_schema/components.json
-   :pointer: /definitions/Source
+   :pointer: /$defs/Source
    :collapse: assertedBy
    :externallinks: {"type":{"url":"#sourcetype","text":"SourceType"}}
    :allowexternalrefs:

readthedocs.yml

@@ -7,6 +7,6 @@ build:
     image: latest
 
 python:
-   version: 3.8
+   version: 3.9
 
 

requirements.in

@@ -2,7 +2,7 @@ sphinx>=4.2,<4.3
 sphinx-intl[transifex]
 sphinx_rtd_theme
 sphinxcontrib-opendataservices-jsonschema
-sphinxcontrib-opendataservices
+sphinxcontrib-opendataservices==0.5.0
 -e git+https://github.com/openownership/data-standard-sphinx-theme.git@master#egg=standard_theme
 ocds-babel
 urllib3>=1.23

requirements.txt

@@ -1,8 +1,8 @@
 #
-# This file is autogenerated by pip-compile with python 3.8
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
 #
-#    pip-compile
+#    pip-compile requirements.in
 #
 -e git+https://github.com/openownership/data-standard-sphinx-theme.git@master#egg=standard_theme
     # via -r requirements.in
@@ -108,9 +108,9 @@ sphinxcontrib-htmlhelp==2.0.0
     # via sphinx
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
-sphinxcontrib-opendataservices==0.2.0
+sphinxcontrib-opendataservices==0.5.0
     # via -r requirements.in
-sphinxcontrib-opendataservices-jsonschema==0.4.0
+sphinxcontrib-opendataservices-jsonschema==0.6.1
     # via
     #   -r requirements.in
     #   sphinxcontrib-opendataservices

requirements_test.in

@@ -21,4 +21,3 @@ strict-rfc3339
 compiletojsonschema==0.3.0
 rfc3339-validator
 rfc3986-validator
-

requirements_test.txt

@@ -1,6 +1,6 @@
 #
-# This file is autogenerated by pip-compile with python 3.8
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
 #
 #    pip-compile requirements_test.in
 #
@@ -45,8 +45,6 @@ idna==2.10
     # via requests
 imagesize==1.2.0
     # via sphinx
-importlib-resources==5.12.0
-    # via jsonschema
 iniconfig==1.1.1
     # via pytest
 jinja2==2.11.3
@@ -98,8 +96,6 @@ pep517==0.10.0
     # via pip-tools
 pip-tools==6.5.1
     # via -r requirements_test.in
-pkgutil-resolve-name==1.3.10
-    # via jsonschema
 pluggy==0.13.1
     # via
     #   -r requirements_test.in
@@ -175,9 +171,9 @@ sphinxcontrib-htmlhelp==2.0.0
     # via sphinx
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
-sphinxcontrib-opendataservices==0.2.0
+sphinxcontrib-opendataservices==0.5.0
     # via -r requirements.in
-sphinxcontrib-opendataservices-jsonschema==0.4.0
+sphinxcontrib-opendataservices-jsonschema==0.6.1
     # via
     #   -r requirements.in
     #   sphinxcontrib-opendataservices
@@ -202,8 +198,6 @@ urllib3==1.26.4
     #   transifex-client
 wheel==0.37.1
     # via pip-tools
-zipp==3.15.0
-    # via importlib-resources
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip