diff --git a/.gitignore b/.gitignore index 346e566..b505c85 100644 --- a/.gitignore +++ b/.gitignore @@ -17,4 +17,7 @@ env/ .idea/ # Ignore editor backup files -*~ \ No newline at end of file +*~ + +# Ignore mac files +*DS_store \ No newline at end of file diff --git a/docs/HDRUK/2.2.0.example.json b/docs/HDRUK/2.2.0.example.json index abe2ff0..0d5cb20 100644 --- a/docs/HDRUK/2.2.0.example.json +++ b/docs/HDRUK/2.2.0.example.json @@ -32,10 +32,10 @@ "isPartOf": "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}] | typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]] | null" }, "coverage": { - "spatial": "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}] | typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]] | null", - "typicalAgeRange": "AgeRange[{'anyOf': [{'pattern': 'Not Known|(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])-(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])', 'type': 'string'}, {'type': 'null'}]}] | null", + "spatial": "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}] | null", + "pathway": "LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}] | null", "followup": "Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null] | null", - "pathway": "Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}] | null", + "typicalAgeRange": "AgeRange[{'anyOf': [{'pattern': 'Not Known|(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])-(150|1[0-4][0-9]|[0-9]|[1-8][0-9]|9[0-9])', 'type': 'string'}, {'type': 'null'}]}] | null", "gender": "GenderType['Male','Female','Other']", "biologicalsamples": "BiologicalSampleType['Blood','Other','Urine','Saliva']", "psychological": "PsychologicalType['Cognitive Function','Mental Health']", diff --git a/docs/HDRUK/3.0.0.form.json b/docs/HDRUK/3.0.0.form.json index e75aadd..bb005bb 100644 --- a/docs/HDRUK/3.0.0.form.json +++ b/docs/HDRUK/3.0.0.form.json @@ -253,11 +253,12 @@ "Primary Care Prescription", "Accident and Emergency Admissions" ], - "is_list": false, + "is_list": true, "is_optional": true, "types": { - "title": "CommaSeparatedValues", - "pattern": "([^,]+)", + "maxLength": 150, + "minLength": 2, + "title": "OneHundredFiftyCharacters", "type": "string" }, "location": "summary.keywords" diff --git a/docs/HDRUK/3.0.0.md b/docs/HDRUK/3.0.0.md index e6a4c13..52d9701 100644 --- a/docs/HDRUK/3.0.0.md +++ b/docs/HDRUK/3.0.0.md @@ -176,9 +176,9 @@ Please provide a URL that describes the organisation. Organisation contact point(s) which will be used for receiving queries from HDR, and enquiries and data access requests from Researchers. -| title | guidance | is_list | required | type | -|:--------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| contact point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]'] | +| title | guidance | is_list | required | type | +|:--------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------| +| contact point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List'] | @@ -209,9 +209,9 @@ Input the number of people captured within the dataset. Please provide a list of relevant and specific keywords that can improve the search engine optimisation (SEO) of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users. -| title | guidance | is_list | required | type | -|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Keywords | - Please provide **relevant** and **specific keywords** that can **improve the search engine optimization** of your dataset.
- Please **enter one keyword at a time** and click **Add New Field** to add further keywords.
- Text from the title is automatically included in the search, there is no need to include this in the keywords.
- Include words that researcher may include in their searches. | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------| +| Keywords | - Please provide **relevant** and **specific keywords** that can **improve the search engine optimization** of your dataset.
- Please **enter one keyword at a time** and click **Add New Field** to add further keywords.
- Text from the title is automatically included in the search, there is no need to include this in the keywords.
- Include words that researcher may include in their searches. | True | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | Examples: @@ -253,9 +253,9 @@ Examples: Alternate dataset identifiers or local identifiers. -| title | guidance | is_list | required | type | -|:------------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Alternate dataset identifiers | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Alternate dataset identifiers | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -284,9 +284,9 @@ A free-text description of the dataset.
A URL can also be provided as the des Please provide any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question. The following formats will be accepted .jpg, .png or .svg, .pdf, .xslx or .docx. Note: media asset can be hosted by the organisation or uploaded using the onboarding portal. -| title | guidance | is_list | required | type | -|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Associated media | - Please provide any media associated with the Gateway Organisation **using a valid URL** for the content.
- This is an opportunity to **provide additional context** that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question.
- Note: media assets should be hosted by the organisation.
- **Example**: This could be a **link to a PDF Document** that describes methodology or further detail about the datasets, or a graph or chart that provides further context about the dataset.
- If you are providing multiple links for associated media, we recommend that you separate these with a comma. | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Associated media | - Please provide any media associated with the Gateway Organisation **using a valid URL** for the content.
- This is an opportunity to **provide additional context** that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question.
- Note: media assets should be hosted by the organisation.
- **Example**: This could be a **link to a PDF Document** that describes methodology or further detail about the datasets, or a graph or chart that provides further context about the dataset.
- If you are providing multiple links for associated media, we recommend that you separate these with a comma. | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -317,9 +317,9 @@ This information includes attributes for geographical and temporal coverage, coh The geographical area covered by the dataset. It is recommended that links are to entries in one of the recommended standards:
- For locations in the UK: [ONS standards](https://geoportal.statistics.gov.uk/datasets/ons::index-of-place-names-in-great-britain-november-2021/about)
- For locations in other countries: [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes) -| title | guidance | is_list | required | type | -|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------| -| Geographic coverage | - The geographical area covered by the dataset.
- Please provide a valid location.
- For locations in the UK, this location should conform to [ONS standards](https://geoportal.statistics.gov.uk/datasets/ons::index-of-place-names-in-great-britain-november-2021/about).
- For locations in other countries we use [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes). | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Url.Url]'] | +| title | guidance | is_list | required | type | +|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------| +| Geographic coverage | - The geographical area covered by the dataset.
- Please provide a valid location.
- For locations in the UK, this location should conform to [ONS standards](https://geoportal.statistics.gov.uk/datasets/ons::index-of-place-names-in-great-britain-november-2021/about).
- For locations in other countries we use [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes). | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List'] | Examples: @@ -601,9 +601,9 @@ Please indicate fit here are any additional conditions set for use if any, multi Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided. -| title | guidance | is_list | required | type | -|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Citation requirements | - Please provide the text that you would like included as part of any citation that credits this dataset.
- This is typically just the name of the publisher. No employee details should be provided.
- To add multiple entries, please click on **'+' symbol** to enter each separate website.
- **Example**: National Services Scotland | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Citation requirements | - Please provide the text that you would like included as part of any citation that credits this dataset.
- This is typically just the name of the publisher. No employee details should be provided.
- To add multiple entries, please click on **'+' symbol** to enter each separate website.
- **Example**: National Services Scotland | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -693,9 +693,9 @@ Please provide an indication of the typical processing times based on the types Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored. -| title | guidance | is_list | required | type | -|:-------------|:----------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Jurisdiction | A full list of country codes can be found here (alpha-2 column): https://www.iso.org/obp/ui/#search/code/ | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +| title | guidance | is_list | required | type | +|:-------------|:----------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Jurisdiction | A full list of country codes can be found here (alpha-2 column): https://www.iso.org/obp/ui/#search/code/ | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -764,9 +764,9 @@ Examples: This should list all the languages in which the dataset metadata and underlying data is made available complaint with ISO 639. -| title | guidance | is_list | required | type | -|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Language | https://www.iso.org/iso-639-language-code
- **aa**: Afar
- **ab**: Abkhazian
- **af**: Afrikaans
- **ak**: Akan
- **sq**: Albanian
- **am**: Amharic
- **ar**: Arabic
- **an**: Aragonese
- **hy**: Armenian
- **as**: Assamese
- **av**: Avaric
- **ae**: Avestan
- **ay**: Aymara
- **az**: Azerbaijani
- **ba**: Bashkir
- **bm**: Bambara
- **eu**: Basque
- **be**: Belarusian
- **bn**: Bengali
- **bh**: Bihari languages
- **bi**: Bislama
- **bo**: Tibetan
- **bs**: Bosnian
- **br**: Breton
- **bg**: Bulgarian
- **my**: Burmese
- **ca**: Catalan; Valencian
- **cs**: Czech
- **ch**: Chamorro
- **ce**: Chechen
- **zh**: Chinese
- **cu**: Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
- **cv**: Chuvash
- **kw**: Cornish
- **co**: Corsican
- **cr**: Cree
- **cy**: Welsh
- **cs**: Czech
- **da**: Danish
- **de**: German
- **dv**: Divehi; Dhivehi; Maldivian
- **nl**: Dutch; Flemish
- **dz**: Dzongkha
- **el**: Greek, Modern (1453-)
- **en**: English
- **eo**: Esperanto
- **et**: Estonian
- **eu**: Basque
- **ee**: Ewe
- **fo**: Faroese
- **fa**: Persian
- **fj**: Fijian
- **fi**: Finnish
- **fr**: French
- **fy**: Western Frisian
- **ff**: Fulah
- **ka**: Georgian
- **de**: German
- **gd**: Gaelic; Scottish Gaelic
- **ga**: Irish
- **gl**: Galician
- **gv**: Manx
- **el**: Greek, Modern (1453-)
- **gn**: Guarani
- **gu**: Gujarati
- **ht**: Haitian; Haitian Creole
- **ha**: Hausa
- **ho**: Hiri Motu
- **hr**: Croatian
- **hu**: Hungarian
- **hy**: Armenian
- **ig**: Igbo
- **is**: Icelandic
- **io**: Ido
- **ii**: Sichuan Yi; Nuosu
- **iu**: Inuktitut
- **ie**: Interlingue; Occidental
- **ia**: Interlingua (International Auxiliary Language Association)
- **id**: Indonesian
- **ik**: Inupiaq
- **is**: Icelandic
- **it**: Italian
- **jv**: Javanese
- **ja**: Japanese
- **kl**: Kalaallisut; Greenlandic
- **kn**: Kannada
- **ks**: Kashmiri
- **ka**: Georgian
- **kr**: Kanuri
- **kk**: Kazakh
- **km**: Central Khmer
- **ki**: Kikuyu; Gikuyu
- **rw**: Kinyarwanda
- **ky**: Kirghiz; Kyrgyz
- **kv**: Komi
- **kg**: Kongo
- **ko**: Korean
- **kj**: Kuanyama; Kwanyama
- **ku**: Kurdish
- **lo**: Lao
- **la**: Latin
- **lv**: Latvian
- **li**: Limburgan; Limburger; limburgish
- **ln**: Lingala
- **lt**: Lithuanian
- **lb**: Luxembourgish; Letzeburgesch
- **lu**: Luba-Katanga
- **lg**: Ganda
- **mk**: Macedonian
- **mh**: Marshallese
- **ml**: Malayalam
- **mi**: Maori
- **mr**: Marathi
- **ms**: Malay
- **mk**: Macedonian
- **mg**: Malagasy
- **mt**: Maltese
- **mn**: Mongolian
- **mi**: Maori
- **ms**: Malay
- **my**: Burmese
- **na**: Nauru
- **nv**: Navajo; Navaho
- **nr**: Ndebele, South; South Ndebele
- **nd**: Ndebele, North; North Ndebele
- **ng**: Ndonga
- **ne**: Nepali
- **nl**: Dutch; Flemish
- **nn**: Norwegian Nynorsk; Nynorsk, Norwegian
- **nb**: Bokmål, Norwegian; Norwegian Bokmål
- **no**: Norwegian
- **ny**: Chichewa; Chewa; Nyanja
- **oc**: Occitan (post 1500)
- **oj**: Ojibwa
- **or**: Oriya
- **om**: Oromo
- **os**: Ossetian; Ossetic
- **pa**: Panjabi; Punjabi
- **fa**: Persian
- **pi**: Pali
- **pl**: Polish
- **pt**: Portuguese
- **ps**: Pushto; Pashto
- **qu**: Quechua
- **rm**: Romansh
- **ro**: Romanian; Moldavian; Moldovan
- **rn**: Rundi
- **ru**: Russian
- **sg**: Sango
- **sa**: Sanskrit
- **si**: Sinhala; Sinhalese
- **sk**: Slovak
- **sl**: Slovenian
- **se**: Northern Sami
- **sm**: Samoan
- **sn**: Shona
- **sd**: Sindhi
- **so**: Somali
- **st**: Sotho, Southern
- **es**: Spanish; Castilian
- **sq**: Albanian
- **sc**: Sardinian
- **sr**: Serbian
- **ss**: Swati
- **su**: Sundanese
- **sw**: Swahili
- **sv**: Swedish
- **ty**: Tahitian
- **ta**: Tamil
- **tt**: Tatar
- **te**: Telugu
- **tg**: Tajik
- **tl**: Tagalog
- **th**: Thai
- **bo**: Tibetan
- **ti**: Tigrinya
- **to**: Tonga (Tonga Islands)
- **tn**: Tswana
- **ts**: Tsonga
- **tk**: Turkmen
- **tr**: Turkish
- **tw**: Twi
- **ug**: Uighur; Uyghur
- **uk**: Ukrainian
- **ur**: Urdu
- **uz**: Uzbek
- **ve**: Venda
- **vi**: Vietnamese
- **vo**: Volapük
- **cy**: Welsh
- **wa**: Walloon
- **wo**: Wolof
- **xh**: Xhosa
- **yi**: Yiddish
- **yo**: Yoruba
- **za**: Zhuang; Chuang
- **zh**: Chinese
- **zu**: Zulu | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Language | https://www.iso.org/iso-639-language-code
- **aa**: Afar
- **ab**: Abkhazian
- **af**: Afrikaans
- **ak**: Akan
- **sq**: Albanian
- **am**: Amharic
- **ar**: Arabic
- **an**: Aragonese
- **hy**: Armenian
- **as**: Assamese
- **av**: Avaric
- **ae**: Avestan
- **ay**: Aymara
- **az**: Azerbaijani
- **ba**: Bashkir
- **bm**: Bambara
- **eu**: Basque
- **be**: Belarusian
- **bn**: Bengali
- **bh**: Bihari languages
- **bi**: Bislama
- **bo**: Tibetan
- **bs**: Bosnian
- **br**: Breton
- **bg**: Bulgarian
- **my**: Burmese
- **ca**: Catalan; Valencian
- **cs**: Czech
- **ch**: Chamorro
- **ce**: Chechen
- **zh**: Chinese
- **cu**: Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
- **cv**: Chuvash
- **kw**: Cornish
- **co**: Corsican
- **cr**: Cree
- **cy**: Welsh
- **cs**: Czech
- **da**: Danish
- **de**: German
- **dv**: Divehi; Dhivehi; Maldivian
- **nl**: Dutch; Flemish
- **dz**: Dzongkha
- **el**: Greek, Modern (1453-)
- **en**: English
- **eo**: Esperanto
- **et**: Estonian
- **eu**: Basque
- **ee**: Ewe
- **fo**: Faroese
- **fa**: Persian
- **fj**: Fijian
- **fi**: Finnish
- **fr**: French
- **fy**: Western Frisian
- **ff**: Fulah
- **ka**: Georgian
- **de**: German
- **gd**: Gaelic; Scottish Gaelic
- **ga**: Irish
- **gl**: Galician
- **gv**: Manx
- **el**: Greek, Modern (1453-)
- **gn**: Guarani
- **gu**: Gujarati
- **ht**: Haitian; Haitian Creole
- **ha**: Hausa
- **ho**: Hiri Motu
- **hr**: Croatian
- **hu**: Hungarian
- **hy**: Armenian
- **ig**: Igbo
- **is**: Icelandic
- **io**: Ido
- **ii**: Sichuan Yi; Nuosu
- **iu**: Inuktitut
- **ie**: Interlingue; Occidental
- **ia**: Interlingua (International Auxiliary Language Association)
- **id**: Indonesian
- **ik**: Inupiaq
- **is**: Icelandic
- **it**: Italian
- **jv**: Javanese
- **ja**: Japanese
- **kl**: Kalaallisut; Greenlandic
- **kn**: Kannada
- **ks**: Kashmiri
- **ka**: Georgian
- **kr**: Kanuri
- **kk**: Kazakh
- **km**: Central Khmer
- **ki**: Kikuyu; Gikuyu
- **rw**: Kinyarwanda
- **ky**: Kirghiz; Kyrgyz
- **kv**: Komi
- **kg**: Kongo
- **ko**: Korean
- **kj**: Kuanyama; Kwanyama
- **ku**: Kurdish
- **lo**: Lao
- **la**: Latin
- **lv**: Latvian
- **li**: Limburgan; Limburger; limburgish
- **ln**: Lingala
- **lt**: Lithuanian
- **lb**: Luxembourgish; Letzeburgesch
- **lu**: Luba-Katanga
- **lg**: Ganda
- **mk**: Macedonian
- **mh**: Marshallese
- **ml**: Malayalam
- **mi**: Maori
- **mr**: Marathi
- **ms**: Malay
- **mk**: Macedonian
- **mg**: Malagasy
- **mt**: Maltese
- **mn**: Mongolian
- **mi**: Maori
- **ms**: Malay
- **my**: Burmese
- **na**: Nauru
- **nv**: Navajo; Navaho
- **nr**: Ndebele, South; South Ndebele
- **nd**: Ndebele, North; North Ndebele
- **ng**: Ndonga
- **ne**: Nepali
- **nl**: Dutch; Flemish
- **nn**: Norwegian Nynorsk; Nynorsk, Norwegian
- **nb**: Bokmål, Norwegian; Norwegian Bokmål
- **no**: Norwegian
- **ny**: Chichewa; Chewa; Nyanja
- **oc**: Occitan (post 1500)
- **oj**: Ojibwa
- **or**: Oriya
- **om**: Oromo
- **os**: Ossetian; Ossetic
- **pa**: Panjabi; Punjabi
- **fa**: Persian
- **pi**: Pali
- **pl**: Polish
- **pt**: Portuguese
- **ps**: Pushto; Pashto
- **qu**: Quechua
- **rm**: Romansh
- **ro**: Romanian; Moldavian; Moldovan
- **rn**: Rundi
- **ru**: Russian
- **sg**: Sango
- **sa**: Sanskrit
- **si**: Sinhala; Sinhalese
- **sk**: Slovak
- **sl**: Slovenian
- **se**: Northern Sami
- **sm**: Samoan
- **sn**: Shona
- **sd**: Sindhi
- **so**: Somali
- **st**: Sotho, Southern
- **es**: Spanish; Castilian
- **sq**: Albanian
- **sc**: Sardinian
- **sr**: Serbian
- **ss**: Swati
- **su**: Sundanese
- **sw**: Swahili
- **sv**: Swedish
- **ty**: Tahitian
- **ta**: Tamil
- **tt**: Tatar
- **te**: Telugu
- **tg**: Tajik
- **tl**: Tagalog
- **th**: Thai
- **bo**: Tibetan
- **ti**: Tigrinya
- **to**: Tonga (Tonga Islands)
- **tn**: Tswana
- **ts**: Tsonga
- **tk**: Turkmen
- **tr**: Turkish
- **tw**: Twi
- **ug**: Uighur; Uyghur
- **uk**: Ukrainian
- **ur**: Urdu
- **uz**: Uzbek
- **ve**: Venda
- **vi**: Vietnamese
- **vo**: Volapük
- **cy**: Welsh
- **wa**: Walloon
- **wo**: Wolof
- **xh**: Xhosa
- **yi**: Yiddish
- **yo**: Yoruba
- **za**: Zhuang; Chuang
- **zh**: Chinese
- **zu**: Zulu | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -775,9 +775,9 @@ This should list all the languages in which the dataset metadata and underlying If multiple formats are available please specify. See application, audio, image, message, model, multipart, text, video, https://www.iana.org/assignments/media-types/media-types.xhtml Note: If your file format is not included in the current list of formats, please indicate other. If you are using the HOP you will be directed to a service desk page where you can request your additional format. If not please go to: https://metadata.atlassian.net/servicedesk/customer/portal/4 to request your format. -| title | guidance | is_list | required | type | -|:--------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Format | - If multiple formats are available, please specify. See application, audio, image, message, model, multipart, text, video, .
- Please **enter one format type at a time** and click **Add New Field** to add further keywords.
- Note: If your file format is not included in the current list of formats, please indicate other.
- **Example**: text/tab-separated-values, application/sql, text/csv, image/diacom-rle | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Format | - If multiple formats are available, please specify. See application, audio, image, message, model, multipart, text, video, .
- Please **enter one format type at a time** and click **Add New Field** to add further keywords.
- Note: If your file format is not included in the current list of formats, please indicate other.
- **Example**: text/tab-separated-values, application/sql, text/csv, image/diacom-rle | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: diff --git a/docs/HDRUK/3.0.0.structure.json b/docs/HDRUK/3.0.0.structure.json index 22ea4b6..cf4f9ed 100644 --- a/docs/HDRUK/3.0.0.structure.json +++ b/docs/HDRUK/3.0.0.structure.json @@ -235,7 +235,7 @@ "examples": null, "type": [ "EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]" + "List" ], "is_list": false, "is_optional": false, @@ -285,11 +285,9 @@ "Accident and Emergency Admissions" ], "type": [ - "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]", - "null" + "OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]" ], - "is_list": false, + "is_list": true, "is_optional": true, "subItems": [] }, @@ -335,7 +333,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -383,7 +381,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -431,7 +429,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Url.Url]" + "List" ], "is_list": false, "is_optional": false, @@ -805,7 +803,7 @@ ], "type": [ "ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -926,7 +924,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]", + "List", "null" ], "is_list": false, @@ -1023,7 +1021,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Language.Language]", + "List", "null" ], "is_list": false, @@ -1044,7 +1042,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Format.Format]", + "List", "null" ], "is_list": false, diff --git a/hdr_schemata/models/HDRUK/3.0.0/schema.json b/hdr_schemata/models/HDRUK/3.0.0/schema.json index 19067aa..fa575c9 100644 --- a/hdr_schemata/models/HDRUK/3.0.0/schema.json +++ b/hdr_schemata/models/HDRUK/3.0.0/schema.json @@ -1953,9 +1953,6 @@ }, "keywords": { "anyOf": [ - { - "$ref": "#/$defs/CommaSeparatedValues" - }, { "items": { "$ref": "#/$defs/OneHundredFiftyCharacters" diff --git a/hdr_schemata/models/HDRUK/v3_0_0/Summary.py b/hdr_schemata/models/HDRUK/v3_0_0/Summary.py index b79aad4..9c7b143 100644 --- a/hdr_schemata/models/HDRUK/v3_0_0/Summary.py +++ b/hdr_schemata/models/HDRUK/v3_0_0/Summary.py @@ -29,7 +29,7 @@ class Config: ..., **an.populationSize.__dict__, json_schema_extra={"guidance": an.populationSize.guidance} ) - keywords: Optional[Union[CommaSeparatedValues, List[OneHundredFiftyCharacters]]] = ( + keywords: Optional[List[OneHundredFiftyCharacters]] = ( Field(..., **an.keywords.__dict__, json_schema_extra={"guidance": an.keywords.guidance}) )