Skip to content

Docs warnings update #1843

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

Merged
Jolanrensen merged 3 commits into from
May 5, 2026
Merged

Docs warnings update #1843

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
f15ae38
update gradle plugin deprecation warnings
Jolanrensen May 4, 2026
70039cc
updated OpenAPI experimental-demotion warning with more useful inform…
Jolanrensen May 4, 2026
f02f93d
added mention of #1844 in gradle-plugin warning messages
Jolanrensen May 5, 2026
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
6 changes: 4 additions & 2 deletions docs/StardustDocs/topics/dataSources/OpenAPI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ Learn how to use OpenAPI 3.0 JSON schemas with Kotlin DataFrame to load and mani
</link-summary>


> **Experimental**: Support for OpenAPI 3.0.0 schemas is currently experimental
> and may change or be removed in future releases.
> **Experimental**: Support for OpenAPI 3.0.0 schemas is demoted to experimental
> and may change or be removed in future releases. This is because OpenAPI 3.1 (and 3.2) have
> introduced significant changes that require specialized handling.
> Follow https://github.com/Kotlin/dataframe/issues/897 for updates and please leave your feedback.
> {style="warning"}

Kotlin DataFrame provides support for reading and writing JSON data
Expand Down
5 changes: 3 additions & 2 deletions docs/StardustDocs/topics/schemas/gradle/Gradle-Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
[//]: # (title: Gradle Plugin (deprecated))

> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
> The current Gradle plugin is **deprecated**. Its latest release is 1.0.0-Beta4 and will not have future releases.
>
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
{style="warning"}
> Our plans for the next iteration of this feature can be found in [Issue #1844](https://github.com/Kotlin/dataframe/issues/1844).
> {style="warning"}

This page describes the Gradle plugin that generates `@DataSchema` from data samples.
```Kotlin
Expand Down
5 changes: 3 additions & 2 deletions docs/StardustDocs/topics/schemas/gradle/schemasGradle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->

> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
> The current Gradle plugin is **deprecated**. Its latest release is 1.0.0-Beta4 and will not have future releases.
>
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
{style="warning"}
> Our plans for the next iteration of this feature can be found in [Issue #1844](https://github.com/Kotlin/dataframe/issues/1844).
> {style="warning"}

In Gradle projects, the Kotlin DataFrame library provides

Expand Down
17 changes: 10 additions & 7 deletions docs/StardustDocs/topics/schemas/gradle/schemasImportOpenApiGradle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@

<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->

> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
> The current Gradle plugin is **deprecated**. Its latest release is 1.0.0-Beta4 and will not have future releases.
>
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
{style="warning"}

<warning>
OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future.
</warning>
> At the moment, OpenAPI code generation can be done **[via dedicated methods](OpenAPI.md)** instead of relying on the plugin.
> Our plans for the next iteration of this feature can be found in [Issue #1844](https://github.com/Kotlin/dataframe/issues/1844).
> {style="warning"}

> **Experimental**: Support for OpenAPI 3.0 schemas is demoted to experimental
> and may change or be removed in future releases. This is because OpenAPI 3.1 (and 3.2) have
> introduced significant changes that require specialized handling.
> Follow [Issue #897](https://github.com/Kotlin/dataframe/issues/897) for updates and please leave your feedback.
> {style="warning"}

JSON schema inference is great, but it's not perfect. However, more and more APIs offer
[OpenAPI (Swagger)](https://swagger.io/) specifications.
Expand Down
5 changes: 3 additions & 2 deletions docs/StardustDocs/topics/schemas/gradle/schemasImportSqlGradle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->

> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
> The current Gradle plugin is **deprecated**. Its latest release is 1.0.0-Beta4 and will not have future releases.
>
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
{style="warning"}
> Our plans for the next iteration of this feature can be found in [Issue #1844](https://github.com/Kotlin/dataframe/issues/1844).
> {style="warning"}

Each SQL database contains the metadata for all the tables.
This metadata could be used for the schema generation.
Expand Down
8 changes: 5 additions & 3 deletions docs/StardustDocs/topics/schemas/schemasImportOpenApiJupyter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->

<warning>
OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future.
</warning>
> **Experimental**: Support for OpenAPI 3.0.0 schemas is demoted to experimental
> and may change or be removed in future releases. This is because OpenAPI 3.1 (and 3.2) have
> introduced significant changes that require specialized handling.
> Follow https://github.com/Kotlin/dataframe/issues/897 for updates and please leave your feedback.
> {style="warning"}

Similar to [importing OpenAPI Data Schemas in Gradle projects](schemasImportOpenApiGradle.md),
you can also do this in Kotlin Notebook.
Expand Down
Loading