Skip to content

Commit c006b97

Browse files
committed
updating OpenAPI docs on website
1 parent ccb4e20 commit c006b97

File tree

4 files changed

+24
-4
lines changed

4 files changed

+24
-4
lines changed

docs/StardustDocs/topics/gettingStartedGradleAdvanced.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,11 @@ dependencies {
128128
implementation("org.jetbrains.kotlinx:dataframe-excel:%dataFrameVersion%")
129129
implementation("org.jetbrains.kotlinx:dataframe-jdbc:%dataFrameVersion%")
130130
implementation("org.jetbrains.kotlinx:dataframe-arrow:%dataFrameVersion%")
131+
132+
// experimental
131133
implementation("org.jetbrains.kotlinx:dataframe-openapi:%dataFrameVersion%")
132134

135+
// experimental
133136
// This artifact is only needed to directly call functions that generate @DataSchema code from OpenAPI specifications
134137
// It's used by Gradle and KSP plugins internally.
135138
// Your project needs dataframe-openapi to use generated code
@@ -149,7 +152,14 @@ dependencies {
149152
implementation 'org.jetbrains.kotlinx:dataframe-excel:%dataFrameVersion%'
150153
implementation 'org.jetbrains.kotlinx:dataframe-jdbc:%dataFrameVersion%'
151154
implementation 'org.jetbrains.kotlinx:dataframe-arrow:%dataFrameVersion%'
155+
156+
// experimental
152157
implementation 'org.jetbrains.kotlinx:dataframe-openapi:%dataFrameVersion%'
158+
159+
// experimental
160+
// This artifact is only needed to directly call functions that generate @DataSchema code from OpenAPI specifications
161+
// It's used by Gradle and KSP plugins internally.
162+
// Your project needs dataframe-openapi to use generated code
153163
implementation 'org.jetbrains.kotlinx:dataframe-openapi-generator:%dataFrameVersion%'
154164
}
155165
```

docs/StardustDocs/topics/schemas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ Here's a list of the most popular use cases with Data Schemas.
3838
* [**Schema Definitions from SQL Databases in Gradle Project**](schemasImportSqlGradle.md) <br/>
3939
When you need to take data from the SQL database.
4040

41-
* [**Import OpenAPI Schemas in Gradle Project**](schemasImportOpenApiGradle.md) <br/>
41+
* [**Import OpenAPI 3.0.0 Schemas (Experimental) in Gradle Project**](schemasImportOpenApiGradle.md) <br/>
4242
When you need to take data from the endpoint with OpenAPI Schema.
4343

44-
* [**Import Data Schemas, e.g. from OpenAPI, in Jupyter**](schemasImportOpenApiJupyter.md) <br/>
44+
* [**Import Data Schemas, e.g. from OpenAPI 3.0.0 (Experimental), in Jupyter**](schemasImportOpenApiJupyter.md) <br/>
4545
Similar to [importing OpenAPI Data Schemas in Gradle projects](schemasImportOpenApiGradle.md),
4646
you can also do this in Jupyter Notebooks.

docs/StardustDocs/topics/schemasImportOpenApiGradle.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
[//]: # (title: Import OpenAPI Schemas in Gradle project)
1+
[//]: # (title: Import OpenAPI Schemas in Gradle project (Experimental))
22

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

5+
<warning>
6+
OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future.
7+
</warning>
8+
59
JSON schema inference is great, but it's not perfect. However, more and more APIs offer
610
[OpenAPI (Swagger)](https://swagger.io/) specifications.
711

docs/StardustDocs/topics/schemasImportOpenApiJupyter.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,14 @@
22

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

5+
<warning>
6+
OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future.
7+
</warning>
8+
59
Similar to [importing OpenAPI Data Schemas in Gradle projects](schemasImportOpenApiGradle.md),
6-
you can also do this in Jupyter Notebooks.
10+
you can also do this in Jupyter Notebooks.
11+
This requires enabling the `enableExperimentalOpenApi` setting, like:
12+
```%use dataframe(..., enableExperimentalOpenApi=true)```.
713

814
There is only a slight difference in notation:
915

0 commit comments

Comments
 (0)