Skip to content

fix: update/generate validate docs #22

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

Open
wants to merge 3 commits into
base: staging
Choose a base branch
from
Open

fix: update/generate validate docs #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fb2ca0
fix: update validate docs
Aydawka Aug 30, 2025
1853b00
fix: update generate docs
Aydawka Aug 30, 2025
9ce1ba7
fix: typo
Aydawka Aug 30, 2025
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
18 changes: 9 additions & 9 deletions docs/modules/generate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Provide the data required for your `dataset_description` file in this paramater.
| ------ | ------------- | -------- | ------------------------------------------ |
| Object | {} | yes | Data object following the required schemas |

More information about the required data can be found in the [dataset_description](../schemas/dataset_description.md) schema.
More information about the required data can be found in the [dataset_description](https://github.com/AI-READI/pyfairdatatools/blob/main/pyfairdatatools/schemas/dataset_description.schema.json) schema.

##### file_path

Expand Down Expand Up @@ -60,9 +60,9 @@ Provide the file type of the file where you want to save the generated dataset_d
from pyfairdatatools import generate

data = {
"Title": "My Dataset",
"Identifier": "10.5281/zenodo.1234567",
"IdentifierType": "DOI"
"title": "My Dataset",
"identifier": "10.5281/zenodo.1234567",
"identifierType": "DOI"
}

output = generate.generate_dataset_description(data = data, file_path = "dataset_description.json", file_type = "json")
Expand All @@ -84,7 +84,7 @@ Provide the data required for your `study_description` file in this paramater.
| ------ | ------------- | -------- | ------------------------------------------ |
| Object | {} | yes | Data object following the required schemas |

More information about the required data can be found in the [study_description](../schemas/study_description.md) schema.
More information about the required data can be found in the [study_description](https://github.com/AI-READI/pyfairdatatools/blob/main/pyfairdatatools/schemas/study_description.schema.json) schema.

##### file_path

Expand Down Expand Up @@ -114,9 +114,9 @@ Provide the file type of the file where you want to save the generated study_des
from pyfairdatatools import generate

data = {
"Title": "My Dataset",
"Identifier": "10.5281/zenodo.1234567",
"IdentifierType": "DOI"
"title": "My Dataset",
"identifier": "10.5281/zenodo.1234567",
"identifierType": "DOI"
}

output = generate.generate_study_description(data = data, file_path = "study_description.json", file_type = "json")
Expand All @@ -138,7 +138,7 @@ Provide the data required for your readme file in this paramater.
| ------ | ------------- | -------- | ------------------------------------------ |
| Object | {} | yes | Data object following the required schemas |

More information about the required data can be found in the [readme](../schemas/readme.md) schema.
More information about the required data can be found in the [readme](https://github.com/AI-READI/pyfairdatatools/blob/main/pyfairdatatools/schemas/readme.schema.json) schema.

##### file_path

Expand Down
28 changes: 14 additions & 14 deletions docs/modules/validate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ Provide the data required for your `dataset_description` file in this paramater.
| ------ | ------------- | -------- | ------------------------------------------ |
| Object | {} | yes | Data object following the required schemas |

More information about the required data can be found in the [dataset_description](https://github.com/AI-READI/high-level-dataset-structure/blob/specifications/main/v1.0.0/schemas/dataset_description.schema.json) schema.
More information about the required data can be found in the [dataset_description](https://github.com/AI-READI/pyfairdatatools/blob/main/pyfairdatatools/schemas/dataset_description.schema.json) schema.

You can the hosted validator [here](https://www.jsonschemavalidator.net/s/makBzCFq) if you want a better understanding or visualization of the schema for the input.
You can the hosted validator [here](https://www.jsonschemavalidator.net/s/Uaohwh1p) if you want a better understanding or visualization of the schema for the input.

#### Returns

Expand All @@ -46,9 +46,9 @@ You can the hosted validator [here](https://www.jsonschemavalidator.net/s/makBzC
from pyfairdatatools import validate

data = {
"Title": "My Dataset",
"Identifier": "10.5281/zenodo.1234567",
"IdentifierType": "DOI"
"title": "My Dataset",
"identifier": "10.5281/zenodo.1234567",
"identifierType": "DOI"
}

output = validate.validate_dataset_description(data = data)
Expand All @@ -70,9 +70,9 @@ Provide the data required for your `study_description` file in this paramater.
| ------ | ------------- | -------- | ------------------------------------------ |
| Object | {} | yes | Data object following the required schemas |

More information about the required data can be found in the [study_description](https://github.com/AI-READI/high-level-dataset-structure/blob/specifications/main/v1.0.0/schemas/dataset_description.schema.json) schema.
More information about the required data can be found in the [study_description](https://github.com/AI-READI/pyfairdatatools/blob/main/pyfairdatatools/schemas/study_description.schema.json) schema.

You can the hosted validator [here](https://www.jsonschemavalidator.net/s/cmkkqm9P) if you want a better understanding or visualization of the schema for the input.
You can host the validator [here](https://www.jsonschemavalidator.net/s/pfpR4Klf) if you want a better understanding or visualization of the schema for the input.

#### Returns

Expand Down Expand Up @@ -110,9 +110,9 @@ Provide the data required for your `README` file in this paramater.
| ------ | ------------- | -------- | ------------------------------------------ |
| Object | {} | yes | Data object following the required schemas |

More information about the required data can be found in the [README](../schemas/README.md) schema.
More information about the required data can be found in the [README](https://github.com/AI-READI/pyfairdatatools/blob/main/pyfairdatatools/schemas/readme.schema.json) schema.

You can the hosted validator [here](https://www.jsonschemavalidator.net/s/aNSmlcv1) if you want a better understanding or visualization of the schema for the input.
You can host the validator [here](https://www.jsonschemavalidator.net/s/qGe6d1wH) if you want a better understanding or visualization of the schema for the input.

#### Returns

Expand All @@ -126,9 +126,9 @@ You can the hosted validator [here](https://www.jsonschemavalidator.net/s/aNSmlc
from pyfairdatatools import validate

data = {
"Title": "My Dataset",
"Identifier": "10.5281/zenodo.1234567",
"Version": "1.0.0",
"title": "My Dataset",
"identifier": "10.5281/zenodo.1234567",
"version": "1.0.0",
}

output = validate.validate_readme(data = data)
Expand Down Expand Up @@ -184,9 +184,9 @@ Provide the data required for your `participants.tsv` file in this paramater.
| ------ | ------------- | -------- | ------------------------------------------ |
| Object | {} | yes | Data object following the required schemas |

More information about the required data can be found in the [participants](../schemas/participants.md) schema.
More information about the required data can be found in the [participants](https://github.com/AI-READI/pyfairdatatools/blob/main/pyfairdatatools/schemas/participants.schema.json) schema.

You can the hosted validator [here](https://www.jsonschemavalidator.net/s/aNSmlcv1) if you want a better understanding or visualization of the schema for the input.
You can host the validator [here](https://www.jsonschemavalidator.net/s/AGbykeCI) if you want a better understanding or visualization of the schema for the input.

#### Returns

Expand Down
2 changes: 1 addition & 1 deletion pyfairdatatools/schemas/participants.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://schema.aireadi.org/files/participants.json",
"title": "README",
"title": "Participants",
"description": "Additional text here",
"type": "array",
"items": {
Expand Down
Loading