Skip to content

Commit edef570

Browse files
committed
updated openapi readmes
1 parent d7cbe9b commit edef570

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

dataframe-openapi-generator/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## :dataframe-openapi
2+
3+
This module, published as `dataframe-openapi-generator` contains all logic and tests for DataFrame to be able to import
4+
OpenAPI specifications as auto-generated data schemas. This module is a sister module to
5+
[`dataframe-openapi`](../dataframe-openapi):
6+
7+
- `dataframe-openapi-generator` is used as a dependency of the Gradle plugin and Jupyter plugin to be able to generate
8+
data schemas from OpenAPI specifications.
9+
- `dataframe-openapi` must be used as a dependency of a user-project to be able to use the generated data schemas.
10+
11+
See [Import OpenAPI Schemas in Gradle project](https://kotlin.github.io/dataframe/schemasimportopenapigradle.html) and
12+
[Import Data Schemas, e.g. from OpenAPI, in Jupyter](https://kotlin.github.io/dataframe/schemasimportopenapijupyter.html)
13+
for more information about how to use it.

dataframe-openapi/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
## :dataframe-openapi
22

3-
This module, published as `dataframe-openapi` contains all logic and tests for DataFrame to be able to import
4-
OpenAPI specifications as auto-generated data schemas.
3+
This module, published as `dataframe-openapi` contains some functions to be able to use auto-generated
4+
data schemas from OpenAPI specifications. This module is a sister module to
5+
[`dataframe-openapi-generator`](../dataframe-openapi-generator):
6+
7+
- `dataframe-openapi-generator` is used as a dependency of the Gradle plugin and Jupyter plugin to be able to generate
8+
data schemas from OpenAPI specifications.
9+
- `dataframe-openapi` must be used as a dependency of a user-project to be able to use the generated data schemas.
510

611
See [Import OpenAPI Schemas in Gradle project](https://kotlin.github.io/dataframe/schemasimportopenapigradle.html) and
712
[Import Data Schemas, e.g. from OpenAPI, in Jupyter](https://kotlin.github.io/dataframe/schemasimportopenapijupyter.html)

0 commit comments

Comments
 (0)