Add date limits to JSON schema and document opener parameters API #336

pont-us · 2020-09-21T14:01:31Z

Add min_datetime and max_datetime to JSONStringSchema to make results of get_open_data_params_schema more fully descriptive.
Add opener_parameters_api.md to documentation (a detailed description of how the opener parameters JSON Schema should be used by openers and UI generators).

First step in addressing Issue #334.

- Add a format_checker argument to JsonSchema.validate_instance, so that supported string formats will be validated. - Add the strict-rfc3339 package to the project requirements to allow jsonschema to validate the "date-time" format. - Add more thorough parameter checking for date and time limits to JsonStringSchema. - Add unit tests for the new functionality.

- Add a first, incomplete draft of the store plugin API and opener parameters. - Add mention of CCI and CDS plugins to the plugins documentation.

By default, only Python lists validate against jsonschema's array schema. This commit adds an option to the call to jsonschema.validate in JsonSchema.validate_instance to make sure that Python tuples will also validate as jsonschema arrays.

- Make CubeConfig.get_schema return a schema which permits both "date" and "date-time" formats for the time range endpoints. Previously only "date-time" was allowed, but it made no difference because the string format was not being validated. - Add support for the "anyOf" keyword in xcube.util.jsonschema, required in order to implement the previous item.

pont-us · 2020-09-23T08:33:38Z

Travis builds are failing, but this is because of seven unit tests which are also currently failing in master.

dzelge

Cool docs. If I understand correctly time periods are specified only by a duration character e.g. M or Y. However, they are in the same chapter of the date/time RFC you quoted. I'd just mention it In the chapter Date, time, and duration. (I left a remark)

docs/source/opener_parameters_api.md

forman

Very goodm thanks a lot. However, as you can see, we should further discuss some points..

docs/source/opener_parameters_api.md

xcube/util/jsonschema.py

Co-authored-by: Norman Fomferra <[email protected]>

UI generation is now described as using the JSON Schema itself as the definition, rather than the xcube jsonschema classes.

Co-authored-by: Norman Fomferra <[email protected]>

- Create a JsonDatetimeSchema subclass of JsonStringSchema to make it more convenient to create schemas with date and date-time formats. - Use JsonDatetimeSchema in the schema returned by CubeConfig.get_schema.

Co-authored-by: Norman Fomferra <[email protected]>

forman

Good. Its only the CHANGES.md, I believe...

CHANGES.md

xcube/util/jsonschema.py

xcube/cli/_gen2/genconfig.py

xcube/util/jsonschema.py

Co-authored-by: Norman Fomferra <[email protected]>

The new name is more appropriate for the planned scope of the document.

Implement a convenience method JsonDatetimeSchema.new_datetime_range and use it in CubeConfig.get_schema. Add some TODO comments about anyOf in jsonschema.py.

- In store conventions document, define a format for time specifiers. - Use this format in the schema returned by CubeConfig.get_schema.

pont-us added 8 commits September 15, 2020 17:30

JsonStringSchema: add min_datetime & max_datetime

e501cef

First step in addressing Issue #334.

Add store API document draft; expand plugins doc

87f01e9

- Add a first, incomplete draft of the store plugin API and opener parameters. - Add mention of CCI and CDS plugins to the plugins documentation.

Make jsonschema validate tuples as arrays

dea1f0e

By default, only Python lists validate against jsonschema's array schema. This commit adds an option to the call to jsonschema.validate in JsonSchema.validate_instance to make sure that Python tuples will also validate as jsonschema arrays.

Expand store plugin API documentation

b056161

Further expansion of store plugin API document

78ce1ae

Store plugin API document essentially complete

feeb532

Rename opener parameters API document

92961a1

pont-us marked this pull request as draft September 21, 2020 14:02

pont-us marked this pull request as ready for review September 23, 2020 08:32

pont-us requested review from forman and dzelge September 23, 2020 08:34

dzelge suggested changes Sep 23, 2020

View reviewed changes

dzelge reviewed Sep 23, 2020

View reviewed changes

docs/source/opener_parameters_api.md Outdated Show resolved Hide resolved

forman requested changes Sep 23, 2020

View reviewed changes

pont-us and others added 13 commits September 23, 2020 11:58

Update docs/source/opener_parameters_api.md

1c1e497

Co-authored-by: Norman Fomferra <[email protected]>

Clarify open parameter interdependency example

225bf0e

Update docs/source/opener_parameters_api.md

c0ebdf7

Co-authored-by: Norman Fomferra <[email protected]>

Clarify wording in opener parameters document

fbad202

Update docs/source/opener_parameters_api.md

fc1fd76

Co-authored-by: Norman Fomferra <[email protected]>

Update docs/source/opener_parameters_api.md

bf8bc00

Co-authored-by: Norman Fomferra <[email protected]>

Open params doc: cross-link date specifier section

a005916

Open params doc: update UI generation section

676423d

UI generation is now described as using the JSON Schema itself as the definition, rather than the xcube jsonschema classes.

Update docs/source/opener_parameters_api.md

8939e8d

Co-authored-by: Norman Fomferra <[email protected]>

Update docs/source/opener_parameters_api.md

fb5d5ae

Co-authored-by: Norman Fomferra <[email protected]>

Create JsonDatetimeSchema and use it in CubeConfig

afb2fbf

- Create a JsonDatetimeSchema subclass of JsonStringSchema to make it more convenient to create schemas with date and date-time formats. - Use JsonDatetimeSchema in the schema returned by CubeConfig.get_schema.

Update changelog

75f342d

Update docs/source/opener_parameters_api.md

b9339d8

Co-authored-by: Norman Fomferra <[email protected]>

Terminology fix: opener params -> open params

2b38fde

forman requested changes Sep 24, 2020

View reviewed changes

CHANGES.md Outdated Show resolved Hide resolved

CHANGES.md Outdated Show resolved Hide resolved

xcube/util/jsonschema.py Show resolved Hide resolved

xcube/cli/_gen2/genconfig.py Outdated Show resolved Hide resolved

xcube/util/jsonschema.py Show resolved Hide resolved

pont-us and others added 6 commits September 25, 2020 09:45

Update CHANGES.md

cdc3590

Co-authored-by: Norman Fomferra <[email protected]>

Update CHANGES.md

6b5b138

Co-authored-by: Norman Fomferra <[email protected]>

Improve sectioning of data store conventions doc

94cec31

Rename open_parameters_api.md to storeconv.md

592875e

The new name is more appropriate for the planned scope of the document.

Implement JsonDatetimeSchema.new_datetime_range

2183e63

Implement a convenience method JsonDatetimeSchema.new_datetime_range and use it in CubeConfig.get_schema. Add some TODO comments about anyOf in jsonschema.py.

Define and use time period specifier format

0a57079

- In store conventions document, define a format for time specifiers. - Use this format in the schema returned by CubeConfig.get_schema.

pont-us merged commit 6bf7e5b into master Sep 25, 2020

pont-us mentioned this pull request Sep 30, 2020

Establish common data store conventions #330

Closed

3 tasks

pont-us deleted the pont-334-json-schema-date-limits branch October 6, 2020 14:26

pont-us mentioned this pull request Oct 8, 2020

Extend store open params schema to allow date limits #334

Closed

stiehlrod mentioned this pull request Apr 8, 2022

Api 12293 remove extra validations department-of-veterans-affairs/vets-api#9588

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add date limits to JSON schema and document opener parameters API #336

Add date limits to JSON schema and document opener parameters API #336

Uh oh!

pont-us commented Sep 21, 2020

Uh oh!

pont-us commented Sep 23, 2020

Uh oh!

dzelge left a comment

Uh oh!

Uh oh!

forman left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

forman left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add date limits to JSON schema and document opener parameters API #336

Add date limits to JSON schema and document opener parameters API #336

Uh oh!

Conversation

pont-us commented Sep 21, 2020

Uh oh!

pont-us commented Sep 23, 2020

Uh oh!

dzelge left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

forman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

forman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!