Skip to content

Releases: yaniv-golan/airtable-openapi-schema-generator

Release Notes: Initial Release of Airtable OpenAPI Schema Generator

26 Sep 18:46
@yaniv-golan yaniv-golan
v1.0.0
0854da8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
Release Notes: Initial Release of Airtable OpenAPI Schema Generator Latest
Latest

Release Notes: Initial Release of Airtable OpenAPI Schema Generator

Introduction

The Airtable OpenAPI Schema Generator is a script that automates the creation of an OpenAPI 3.1.0 schema based on your Airtable base structure. This schema enables GPT assistants to understand and interact with your Airtable data through the Airtable API, allowing for natural language queries and responses.

Features

  • Automatic Schema Generation
    • Quickly generate an OpenAPI schema that reflects your Airtable tables, fields, and relationships.
  • Field Type Mapping
    • Maps Airtable field types to appropriate OpenAPI data types for accurate data representation.
  • Linked Records Handling
    • Expresses relationships between tables using custom x-linkedTable properties without nesting, aligning with Airtable's API behavior.
  • Preservation of Field Descriptions
    • Includes existing field descriptions from your Airtable base to provide context within the schema.
  • Error Reporting
    • Identifies and reports unmapped field types for manual attention, ensuring a comprehensive schema.

Benefits

  • Simplifies Integration
    • Eliminates the manual effort of creating an OpenAPI schema, saving time and reducing errors.
  • Enhances Data Accessibility
    • Enables team members to query Airtable data using natural language through a GPT assistant.
  • Handles Complex Relationships
    • Automatically manages linked records and relationships between tables.
  • Improves Assistant Performance
    • Provides GPT assistants with detailed schema information, enhancing their ability to understand and interact with your data.

Getting Started

  1. Clone or Download the Repository

  2. Install the Script in Airtable

    • Open your Airtable base and add a new extension by selecting the "Scripting" option.
    • Copy the contents of script.js into the scripting editor.

  3. Run the Script

    • Execute the script to generate the OpenAPI schema based on your Airtable base's structure.
    • The generated schema will be displayed in the output section.

  4. Configure Your GPT Assistant

    • Use the generated OpenAPI schema in your Custom GPT configuration to enable API interactions.
    • Set up API key authentication using your Airtable API key.
    • Provide the GPT assistant with the sample instructions from sample_gpt_instructions.md to guide its interactions with the data.

  5. Test the Integration

    • Interact with your GPT assistant by asking questions related to your Airtable data.
    • Verify that it retrieves and presents information accurately.

Repository Contents

  • script.js
    • The main script for generating the OpenAPI schema.
  • README.md
    • Detailed setup instructions and explanations.
  • sample_gpt_instructions.md
    • Sample assistant instructions for configuring your GPT assistant.

Feedback and Contributions

We welcome feedback and contributions! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the MIT License.

Assets 2
Loading