Leverage schema and other API details from OpenAPI spec file

[MeltyBot]

Update (2022-11-28): Discussion on this feature is here, including example implementation:

• Consider whether to prioritize and recommend OpenAPI and SDK integration for existing and future tap maintainers #1227

Note:

• This feature is not actively prioritized by the Meltano team but it is open to community contributions (Accepting Pull Requests).

Migrated from GitLab: https://gitlab.com/meltano/sdk/-/issues/310

Original issue description, by @aaronsteers on 2022-01-21 17:12:12

Show

---

In a perfect world, we'd be able to leverage schema definitions from an API's publicly declared API definition such as OpenAPI spec.

@edgarrmondragon has proven this is a viable path via his work here: https://github.com/edgarrmondragon/tap-shortcut

---

From MeltanoLabs/tap-github#26 (comment):

@ericboucher:

@aaronsteers @edgarrmondragon are there any tools to extract the schema/typing directly from an OpenAPI file? It would be pretty neat if we could simply plug into github/rest-api-description@main/descriptions-next/api.github.com/api.github.com.json to generate and validate types

@edgarrmondragon:

@ericboucher not any that do it as we need out-of-the-box, but I have an implementation here: https://github.com/edgarrmondragon/tap-shortcut/blob/99bb738608305baa11fe26acfe32d2c9c7089a58/tap_shortcut/tap.py#L86-L121.

---

For my part, I have been thinking about the same, and wanted to start a discussion on whether an OpenAPI spec can be leveraged to speed up the development process.

[MeltyBot]

View 10 previous comments from the original issue on GitLab

[aaronsteers]

Logged a new discussion on this topic here:

• Consider whether to prioritize and recommend OpenAPI and SDK integration for existing and future tap maintainers #1227

[stale]

This has been marked as stale because it is unassigned, and has not had recent activity. It will be closed after 21 days if no further activity occurs. If this should never go stale, please add the evergreen label, or request that it be added.

[edgarrmondragon]

Still relevant

[stale]

This has been marked as stale because it is unassigned, and has not had recent activity. It will be closed after 21 days if no further activity occurs. If this should never go stale, please add the evergreen label, or request that it be added.