OpenAPI -> experimental #1115
Merged
OpenAPI -> experimental #1115
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added enableExperimentalOpenApi setting to KSP, Gradle, and jupyter. Enabled json notebook test skipping cells with a certain tag
Jolanrensen
force-pushed
the
openapi-experimental
branch
from
9ea1307 to
c006b97
Compare
Jolanrensen
force-pushed
the
openapi-experimental
branch
from
c006b97 to
87e454b
Compare
Jolanrensen
requested review from
zaleslaw,
koperagen,
AndreiKingsley and
Copilot
There was a problem hiding this comment.
Pull Request Overview
This PR downgrades the OpenAPI type schema support to experimental and updates related documentation and sample configurations. Key updates include:
- Insertion of warning blocks in documentation to indicate the experimental status.
- Updates to sample code and Gradle annotation parameters to include the enableExperimentalOpenApi setting.
- Adjustments to README files and supported versions table to reflect the change.
Reviewed Changes
Copilot reviewed 10 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/StardustDocs/topics/schemasImportOpenApiJupyter.md | Added experimental warning and sample usage for Jupyter Notebooks. |
| docs/StardustDocs/topics/schemasImportOpenApiGradle.md | Updated title, added warning, and enabled experimental setting in code samples. |
| docs/StardustDocs/topics/schemas.md | Modified bullet points to clearly indicate experimental OpenAPI support. |
| docs/StardustDocs/topics/gettingStartedGradleAdvanced.md | Added experimental comments for OpenAPI dependencies in Gradle examples. |
| dataframe-openapi/README.md | Marked the module as experimental and specified OpenAPI 3.0.0 specifications. |
| dataframe-openapi-generator/README.md | Updated module description to indicate experimental OpenAPI 3.0.0 support. |
| dataframe-geo/README.md | Changed experimental note formatting. |
| README.md | Revised the supported versions table to remove the OpenAPI version column. |
Files not reviewed (12)
- core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/annotations/ImportDataSchema.kt: Language not supported
- core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/JupyterConfiguration.kt: Language not supported
- core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/importDataSchema.kt: Language not supported
- dataframe-jupyter/build.gradle.kts: Language not supported
- dataframe-jupyter/src/main/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/Integration.kt: Language not supported
- dataframe-jupyter/src/test/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/SampleNotebooksTests.kt: Language not supported
- plugins/dataframe-gradle-plugin/build.gradle.kts: Language not supported
- plugins/dataframe-gradle-plugin/src/main/kotlin/org/jetbrains/dataframe/gradle/GenerateDataSchemaTask.kt: Language not supported
- plugins/dataframe-gradle-plugin/src/main/kotlin/org/jetbrains/dataframe/gradle/SchemaGeneratorExtension.kt: Language not supported
- plugins/dataframe-gradle-plugin/src/main/kotlin/org/jetbrains/dataframe/gradle/SchemaGeneratorPlugin.kt: Language not supported
- plugins/symbol-processor/build.gradle.kts: Language not supported
- plugins/symbol-processor/src/main/kotlin/org/jetbrains/dataframe/ksp/DataSchemaGenerator.kt: Language not supported
zaleslaw
approved these changes
Apr 3, 2025
Jolanrensen
force-pushed
the
openapi-experimental
branch
from
6a3314c to
d203e8d
Compare
|
need to publish a dev version for the examples to compile |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Downgrades our OpenAPI 3.0.0 type schema support to "experimental".
This is done to reach 1.0 in a more "stable" way, before tackling #897.
I updated the documentation. In all places where OpenAPI type generation could be used, I created the
enableExperimentalOpenApisetting.