Skip to content
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

Move kedro-catalog JSON schema to kedro-datasets #4359

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Move kedro-catalog JSON schema to kedro-datasets #4359

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0a37127
Move `kedro-catalog` JSON schema to `kedro-datasets` #4258
chrisschopp Dec 1, 2024
55261ac
Add description of change to `RELEASE.md`
chrisschopp Dec 1, 2024
80d6c38
Merge branch 'main' into main
chrisschopp Dec 4, 2024
1b3436e
Update refs to `jsonschema` to use `kedro-plugins/kedro-datasets/`
chrisschopp Dec 4, 2024
a387f1c
Merge branch 'main' into main
chrisschopp Dec 10, 2024
d5bca7d
Merge branch 'main' into main
merelcht Dec 12, 2024
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
3 changes: 3 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@

## Bug fixes and other changes
* Added validation to ensure dataset versions consistency across catalog.
* Moved `kedro-catalog` JSON schema to `kedro-datasets`.

## Breaking changes to the API
## Documentation changes
## Community contributions
Many thanks to the following Kedroids for contributing PRs to this release:

Check warning on line 13 in RELEASE.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Kedro.weaselwords] 'Many' is a weasel word!

Raw Output:
{"message": "[Kedro.weaselwords] 'Many' is a weasel word!", "location": {"path": "RELEASE.md", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}

Check warning on line 13 in RELEASE.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Kedro.Spellings] Did you really mean 'Kedroids'?

Raw Output:
{"message": "[Kedro.Spellings] Did you really mean 'Kedroids'?", "location": {"path": "RELEASE.md", "range": {"start": {"line": 13, "column": 30}}}, "severity": "WARNING"}
* [Chris Schopp](https://github.com/chrisschopp)

Check warning on line 14 in RELEASE.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Kedro.Spellings] Did you really mean 'Schopp'?

Raw Output:
{"message": "[Kedro.Spellings] Did you really mean 'Schopp'?", "location": {"path": "RELEASE.md", "range": {"start": {"line": 14, "column": 10}}}, "severity": "WARNING"}

# Release 0.19.10

Expand Down
2 changes: 1 addition & 1 deletion docs/source/data/how_to_create_a_custom_dataset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,6 @@ kedro-plugins/kedro-datasets/kedro_datasets/image
There are two special considerations when contributing a dataset:

1. Add the dataset to `kedro_datasets.rst` so it shows up in the API documentation.
2. Add the dataset to `static/jsonschema/kedro-catalog-X.json` for IDE validation.
2. Add the dataset to `kedro-plugins/kedro-datasets/static/jsonschema/kedro-catalog-X.json` for IDE validation.

```
4 changes: 2 additions & 2 deletions docs/source/development/set_up_pycharm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,10 @@ You can enable the Kedro catalog validation schema in your PyCharm IDE to enable

![](../meta/images/pycharm_edit_schema_mapping.png)

Add a new mapping using the "+" button in the top left of the window and select the name you want for it. Enter this URL `https://raw.githubusercontent.com/kedro-org/kedro/develop/static/jsonschema/kedro-catalog-0.19.json` in the "Schema URL" field and select "JSON Schema Version 7" in the "Schema version" field.
Add a new mapping using the "+" button in the top left of the window and select the name you want for it. Enter this URL `https://raw.githubusercontent.com/kedro-org/kedro-plugins/main/kedro-datasets/static/jsonschema/kedro-catalog-0.19.json` in the "Schema URL" field and select "JSON Schema Version 7" in the "Schema version" field.
Copy link
Author

@chrisschopp chrisschopp Dec 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming this should point to main.


Add the following file path pattern to the mapping: `conf/**/*catalog*`.

![](../meta/images/pycharm_catalog_schema_mapping.png)

> [Different schemas for different Kedro versions can be found in the Kedro repository](https://github.com/kedro-org/kedro/tree/main/static/jsonschema).
> [Different schemas for different Kedro versions can be found in the `kedro-datasets` repository](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-datasets/static/jsonschema).
4 changes: 2 additions & 2 deletions docs/source/development/set_up_vscode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,11 +260,11 @@ Enter the following in your `settings.json` file:
```json
{
"yaml.schemas": {
"https://raw.githubusercontent.com/kedro-org/kedro/develop/static/jsonschema/kedro-catalog-0.19.json": "conf/**/*catalog*"
"https://raw.githubusercontent.com/kedro-org/kedro-plugins/main/kedro-datasets/static/jsonschema/kedro-catalog-0.19.json": "conf/**/*catalog*"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming this should point to main.

}
}
```

and start editing your `catalog` files.

> [Different schemas for different Kedro versions can be found in the Kedro repository](https://github.com/kedro-org/kedro/tree/main/static/jsonschema).
> [Different schemas for different Kedro versions can be found in the Kedro repository](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-datasets/static/jsonschema).
1,202 changes: 0 additions & 1,202 deletions static/jsonschema/kedro-catalog-0.15.9.json
View file
Open in desktop

This file was deleted.

763 changes: 0 additions & 763 deletions static/jsonschema/kedro-catalog-0.16.json
View file
Open in desktop

This file was deleted.

950 changes: 0 additions & 950 deletions static/jsonschema/kedro-catalog-0.17.json
View file
Open in desktop

This file was deleted.

1,423 changes: 0 additions & 1,423 deletions static/jsonschema/kedro-catalog-0.18.json
View file
Open in desktop

This file was deleted.

1,470 changes: 0 additions & 1,470 deletions static/jsonschema/kedro-catalog-0.19.json
View file
Open in desktop

This file was deleted.

Loading