Skip to content

Commit

Permalink
Merge branch 'main' into kathryn-ods-patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
kd-ods authored Dec 12, 2023
2 parents 9da2576 + 05854db commit 9621bc1
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 57 deletions.
2 changes: 1 addition & 1 deletion docs/schema/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ChangeLog
The schema specifies a **structure**, **fields** and **codelists** but does not yet enforce validation constraints on most fields.

[Unreleased]
=======
============

Changed
-------
Expand Down
2 changes: 1 addition & 1 deletion docs/schema/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ An ``ownershipOrControlStatement`` connects (via ``statementID`` references) the
* A person described by a ``personStatement``; or
* An unspecified party and the reasons that no ownership or control can be specified.

The ownership-or-control statement also contains an array of ``interests``, each with a type (selected from the `interestType codelist <reference.html#interesttype>`_) and, where relevant, percentages indicating the size of the interest.
The ownership-or-control statement also contains an array of ``interests``, each with a type (selected from the `Interest Type codelist <reference.html#interest-type>`_) and, where relevant, percentages indicating the size of the interest.

To explore the structure of the data model in full use the :doc:`Schema browser <schema-browser>`. Or read the :any:`Schema reference <schema-reference>` for detailed definitions of each object and field.

Expand Down
111 changes: 57 additions & 54 deletions docs/schema/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Address

.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/Address
:externallinks: {"type":{"url":"#addresstype","text":"AddressType"}}
:externallinks: {"type":{"url":"#address-type","text":"Address Type"}}
:allowexternalrefs:


Expand Down Expand Up @@ -67,7 +67,7 @@ The ``annotations`` property of statements currently allows an array of these si

.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/Annotation
:externallinks: {"motivation":{"url":"#annotationmotivation","text":"AnnotationMotivation"}}
:externallinks: {"motivation":{"url":"#annotation-motivation","text":"Annotation Motivation"}}
:allowexternalrefs:

.. _schema-country:
Expand All @@ -85,15 +85,15 @@ Country

.. _schema-entity-statement:

EntityStatement
---------------
Entity Statement
----------------

.. json-value:: ../_build_schema/entity-statement.json
:pointer: /description

.. jsonschema:: ../_build_schema/entity-statement.json
:collapse: identifiers,addresses,source,jurisdiction,annotations,publicationDetails,publicListing
:externallinks: {"entityType":{"url":"#entitytype","text":"EntityType"},"entitySubtype/generalCategory":{"url":"#entitysubtypecategory","text":"EntitySubtypeCategory"}, "unspecifiedEntityDetails/reason":{"url":"#unspecifiedreason","text":"UnspecifiedReason"}}
:externallinks: {"statementDate":{"url":"#statement-date","text":"Statement Date"},"entityType":{"url":"#entity-type","text":"Entity Type"},"entitySubtype/generalCategory":{"url":"#entity-subtype-category","text":"Entity Subtype Category"}, "unspecifiedEntityDetails/reason":{"url":"#unspecified-reason","text":"Unspecified Reason"},"replacesStatements":{"url":"#replaces-statements","text":"Replaces Statements"},"publicationDetails":{"url":"#publication-details","text":"Publication Details"},"publicListing":{"url":"#public-listing","text":"Public Listing"}}
:allowexternalrefs:

.. _schema-id:
Expand Down Expand Up @@ -131,21 +131,21 @@ Interest
.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/Interest
:collapse: share
:externallinks: {"share":{"url":"#share","text":"Share"}, "type":{"url":"#interesttype","text":"InterestType"}}
:externallinks: {"share":{"url":"#share","text":"Share"}, "type":{"url":"#interest-type","text":"Interest Type"}}
:allowexternalrefs:

.. _schema-interested-party:

InterestedParty
---------------
Interested Party
----------------

.. json-value:: ../_build_schema/ownership-or-control-statement.json
:pointer: /$defs/InterestedParty/description

.. jsonschema:: ../_build_schema/ownership-or-control-statement.json
:pointer: /properties/interestedParty
:collapse:
:externallinks: {"unspecified/reason":{"url":"#unspecifiedreason","text":"UnspecifiedReason"}}
:externallinks: {"unspecified/reason":{"url":"#unspecified-reason","text":"Unspecified Reason"}}
:allowexternalrefs:

.. _schema-jurisdiction:
Expand All @@ -170,13 +170,13 @@ Name

.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/Name
:externallinks: {"type":{"url":"#nametype","text":"NameType"}}
:externallinks: {"type":{"url":"#name-type","text":"Name Type"}}
:allowexternalrefs:

.. _schema-ownership-or-control-statement:

OwnershipOrControlStatement
---------------------------
Ownership Or Control Statement
------------------------------

If a person is a beneficial owner of an entity - whether directly or indirectly - and the person or entity is required to declare this beneficial ownership, there MUST be an Ownership-or-control Statement connecting the two which represents the beneficial ownership relationship. See :ref:`representing-bo` for detailed requirements.

Expand All @@ -185,54 +185,57 @@ If a person is a beneficial owner of an entity - whether directly or indirectly


.. jsonschema:: ../_build_schema/ownership-or-control-statement.json
:externallinks: {"statementDate":{"url":"#statement-date","text":"Statement Date"},"interestedParty":{"url":"#interested-party","text":"Interested Party"},"replacesStatements":{"url":"#replaces-statements","text":"Replaces Statements"},"publicationDetails":{"url":"#publication-details","text":"Publication Details"}}
:collapse: interests,source,annotations,interestedParty,publicationDetails
:allowexternalrefs:


.. _schema-pep-status:

PepStatusDetails
----------------
PEP Status Details
------------------

.. json-value:: ../_build_schema/components.json
:pointer: /$defs/PepStatusDetails/description

.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/PepStatusDetails
:collapse: jurisdiction,source
:externallinks: {"source/type":{"url":"#sourcetype","text":"SourceType"}}
:externallinks: {"source/type":{"url":"#source-type","text":"Source Type"}}
:allowexternalrefs:

.. _schema-person-statement:

PersonStatement
---------------
Person Statement
----------------

.. json-value:: ../_build_schema/person-statement.json
:pointer: /description

.. jsonschema:: ../_build_schema/person-statement.json
:collapse: names,identifiers,source,placeOfResidence,placeOfBirth,addresses,nationalities,annotations,politicalExposure/details,publicationDetails,taxResidencies
:externallinks: {"personType":{"url": "#persontype","text":"PersonType"}, "unspecifiedPersonDetails/reason":{"url":"#unspecifiedreason","text":"UnspecifiedReason"}}
:externallinks: {"statementDate":{"url":"#statement-date","text":"Statement Date"},"personType":{"url": "#person-type","text":"Person Type"}, "unspecifiedPersonDetails/reason":{"url":"#unspecified-reason","text":"Unspecified Reason"},"replacesStatements":{"url":"#replaces-statements","text":"Replaces Statements"},"publicationDetails":{"url":"#publication-details","text":"Publication Details"},"politicalExposure/details":{"url":"#pep-status-details","text":"PEP Status Details"}}
:allowexternalrefs:


.. _schema-public-listing:

PublicListing
---------------
Public Listing
--------------

.. json-value:: ../_build_schema/components.json
:pointer: /$defs/PublicListing/description

.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/PublicListing
:collapse: securitiesListings
:externallinks: {"securitiesListings":{"url":"#securities-listing","text":"Securities Listing"}}
:allowexternalrefs:

.. _schema-publicationdetails:

PublicationDetails
------------------
Publication Details
-------------------

.. json-value:: ../_build_schema/components.json
:pointer: /$defs/PublicationDetails/description
Expand All @@ -258,8 +261,8 @@ Publisher

.. _schema-replaces-statements:

ReplacesStatements
------------------
Replaces Statements
-------------------

.. json-value:: ../_build_schema/components.json
:pointer: /$defs/ReplacesStatements/description
Expand All @@ -269,8 +272,8 @@ See :any:`Updating statements <guidance-updating-data>` for technical guidance o

.. _schema-securities-listing:

SecuritiesListing
-----------------
Securities Listing
------------------

.. json-value:: ../_build_schema/components.json
:pointer: /$defs/SecuritiesListing/description
Expand All @@ -280,7 +283,7 @@ See :any:`Real world identifiers <guidance-identifiers-other>` for technical gui

.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/SecuritiesListing
:externallinks: {"security/idScheme":{"url":"#securitiesidentifierschemes","text":"SecuritiesIdentifierSchemes"}}
:externallinks: {"security/idScheme":{"url":"#securities-identifier-schemes","text":"Securities Identifier Schemes"}}
:allowexternalrefs:

.. _schema-share:
Expand All @@ -307,16 +310,16 @@ Source
.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/Source
:collapse: assertedBy
:externallinks: {"type":{"url":"#sourcetype","text":"SourceType"}}
:externallinks: {"type":{"url":"#source-type","text":"Source Type"}}
:allowexternalrefs:


See :any:`Sources and annotations <provenance>` for a discussion of provenance modelling.

.. _schema-statement-date:

StatementDate
-------------
Statement Date
--------------

Dates MUST conform with the extended format of `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_. All of the following, for example, are valid:

Expand All @@ -328,35 +331,35 @@ Dates MUST conform with the extended format of `ISO 8601 <https://en.wikipedia.o
Codelists
---------

AddressType
+++++++++++
Address Type
++++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/addressType.csv


AnnotationMotivation
++++++++++++++++++++
Annotation Motivation
+++++++++++++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/annotationMotivation.csv


DirectOrIndirect
++++++++++++++++
Direct Or Indirect
++++++++++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/directOrIndirect.csv


EntityType
++++++++++
Entity Type
+++++++++++

.. csv-table-no-translate::
:header-rows: 1
Expand All @@ -365,8 +368,8 @@ EntityType



EntitySubtypeCategory
+++++++++++++++++++++
Entity Subtype Category
+++++++++++++++++++++++

.. csv-table-no-translate::
:header-rows: 1
Expand All @@ -375,62 +378,62 @@ EntitySubtypeCategory



InterestType
++++++++++++
Interest Type
+++++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/interestType.csv


NameType
++++++++
Name Type
+++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/nameType.csv


PersonType
++++++++++
Person Type
+++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/personType.csv


SecuritiesIdentifierSchemes
+++++++++++++++++++++++++++
Securities Identifier Schemes
+++++++++++++++++++++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/securitiesIdentifierSchemes.csv


SourceType
++++++++++
Source Type
+++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/sourceType.csv


StatementType
+++++++++++++
Statement Type
++++++++++++++

.. csv-table-no-translate::
:header-rows: 1
:class: codelist-table
:file: ../_build_schema/codelists/statementType.csv


UnspecifiedReason
+++++++++++++++++
Unspecified Reason
++++++++++++++++++

.. csv-table-no-translate::
:header-rows: 1
Expand Down
2 changes: 1 addition & 1 deletion schema/person-statement.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
},
"identifiers": {
"title": "Identifiers",
"description": "One or more official identifiers for this perrson. Where available, official registration numbers should be provided.",
"description": "One or more official identifiers for this person. Where available, official registration numbers should be provided.",
"type": "array",
"items": {
"$ref": "components.json#/$defs/Identifier"
Expand Down

0 comments on commit 9621bc1

Please sign in to comment.