Import Data Schemas, e.g. from OpenAPI, in Jupyter

Similar to importing OpenAPI Data Schemas in Gradle projects, you can also do this in Jupyter Notebooks. This requires enabling the enableExperimentalOpenApi setting, like:

%use dataframe(..., enableExperimentalOpenApi=true)

There is only a slight difference in notation:

Import the schema using any path (String), URL, or File:

val PetStore = importDataSchema("https://petstore3.swagger.io/api/v3/openapi.json")

and then from the next cell you run and onwards, you can call, for example:

val df = PetStore.Pet.readJson("https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available")

So, very similar indeed!

(Note: The type of PetStore will be generated as PetStoreDataSchema, but this doesn't affect the way you can use it.)

16 June 2025