diff --git a/docs/schema/changelog.rst b/docs/schema/changelog.rst index 0d559ab2..5e23a4c1 100644 --- a/docs/schema/changelog.rst +++ b/docs/schema/changelog.rst @@ -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 ------- diff --git a/docs/schema/concepts.rst b/docs/schema/concepts.rst index 59966513..72cd0eed 100644 --- a/docs/schema/concepts.rst +++ b/docs/schema/concepts.rst @@ -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 `_) 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 `_) 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 `. Or read the :any:`Schema reference ` for detailed definitions of each object and field. diff --git a/docs/schema/reference.rst b/docs/schema/reference.rst index f062aa80..baff8715 100644 --- a/docs/schema/reference.rst +++ b/docs/schema/reference.rst @@ -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: @@ -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: @@ -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: @@ -131,13 +131,13 @@ 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 @@ -145,7 +145,7 @@ InterestedParty .. 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: @@ -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. @@ -185,13 +185,15 @@ 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 @@ -199,27 +201,27 @@ PepStatusDetails .. 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 @@ -227,12 +229,13 @@ PublicListing .. 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 @@ -258,8 +261,8 @@ Publisher .. _schema-replaces-statements: -ReplacesStatements ------------------- +Replaces Statements +------------------- .. json-value:: ../_build_schema/components.json :pointer: /$defs/ReplacesStatements/description @@ -269,8 +272,8 @@ See :any:`Updating statements ` for technical guidance o .. _schema-securities-listing: -SecuritiesListing ------------------ +Securities Listing +------------------ .. json-value:: ../_build_schema/components.json :pointer: /$defs/SecuritiesListing/description @@ -280,7 +283,7 @@ See :any:`Real world identifiers ` 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: @@ -307,7 +310,7 @@ 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: @@ -315,8 +318,8 @@ See :any:`Sources and annotations ` for a discussion of provenance m .. _schema-statement-date: -StatementDate -------------- +Statement Date +-------------- Dates MUST conform with the extended format of `ISO 8601 `_. All of the following, for example, are valid: @@ -328,8 +331,8 @@ Dates MUST conform with the extended format of `ISO 8601