diff --git a/docs/StardustDocs/topics/dataSources/OpenAPI.md b/docs/StardustDocs/topics/dataSources/OpenAPI.md index c8db295c66..19e232fcb1 100644 --- a/docs/StardustDocs/topics/dataSources/OpenAPI.md +++ b/docs/StardustDocs/topics/dataSources/OpenAPI.md @@ -13,8 +13,10 @@ Learn how to use OpenAPI 3.0 JSON schemas with Kotlin DataFrame to load and mani -> **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 diff --git a/docs/StardustDocs/topics/schemas/gradle/Gradle-Plugin.md b/docs/StardustDocs/topics/schemas/gradle/Gradle-Plugin.md index e59a8f4ae3..ab4a83bc2c 100644 --- a/docs/StardustDocs/topics/schemas/gradle/Gradle-Plugin.md +++ b/docs/StardustDocs/topics/schemas/gradle/Gradle-Plugin.md @@ -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 diff --git a/docs/StardustDocs/topics/schemas/gradle/schemasGradle.md b/docs/StardustDocs/topics/schemas/gradle/schemasGradle.md index 44e75cf569..28f8497f0b 100644 --- a/docs/StardustDocs/topics/schemas/gradle/schemasGradle.md +++ b/docs/StardustDocs/topics/schemas/gradle/schemasGradle.md @@ -2,10 +2,11 @@ -> 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 diff --git a/docs/StardustDocs/topics/schemas/gradle/schemasImportOpenApiGradle.md b/docs/StardustDocs/topics/schemas/gradle/schemasImportOpenApiGradle.md index 42a1bc3207..405762ca20 100644 --- a/docs/StardustDocs/topics/schemas/gradle/schemasImportOpenApiGradle.md +++ b/docs/StardustDocs/topics/schemas/gradle/schemasImportOpenApiGradle.md @@ -2,14 +2,17 @@ -> 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"} - - -OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future. - +> 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. diff --git a/docs/StardustDocs/topics/schemas/gradle/schemasImportSqlGradle.md b/docs/StardustDocs/topics/schemas/gradle/schemasImportSqlGradle.md index 1ba632b474..50f03946ee 100644 --- a/docs/StardustDocs/topics/schemas/gradle/schemasImportSqlGradle.md +++ b/docs/StardustDocs/topics/schemas/gradle/schemasImportSqlGradle.md @@ -2,10 +2,11 @@ -> 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. diff --git a/docs/StardustDocs/topics/schemas/schemasImportOpenApiJupyter.md b/docs/StardustDocs/topics/schemas/schemasImportOpenApiJupyter.md index 2e41208a61..8b79ed28c9 100644 --- a/docs/StardustDocs/topics/schemas/schemasImportOpenApiJupyter.md +++ b/docs/StardustDocs/topics/schemas/schemasImportOpenApiJupyter.md @@ -2,9 +2,11 @@ - -OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future. - +> **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.