Feature request publish legit API documentation including a | Secoda-feature-requests

Docs

Join the conversation Join Slack

Channels

# customers

# discussion

# intros

# secoda-feature-requests

# secoda-support

Channels

Thread

#secoda-feature-requests

polite-microphone-78573

7 months ago

Feature request - publish legit API documentation, including a complete data model defined as OpenAPI or json schema The notion doc is a good start, but you have to dig into the 2nd or 3rd page of Google to find a link to it (via a blog post, not on the Intercom Knowledgebase).

I started putting together an unofficial doc for my own use. it’s pretty barebone at the moment; I’ve scrubbed the examples+schemas I inferred from responses until I can ensure there’s no sensitive info. https://github.com/skwaugh/secoda-openapi

elegant-house-93198

7 months ago

Thanks Sawyer, we’re in the process of revamping our documentation which will combine integration, feature, and API documentation into one aggregated place. But I appreciate the “Unofficial documentation” that you’ve created in the meantime!

👍 3

polite-microphone-78573

7 months ago

can be previewed here - https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/skwaugh/secoda-openapi/main/secoda-openapi.yml

:amazed_clap: 3

limited-solstice-12595

7 months ago

Wow, impressive! @careful-application-95617, have you seen this?

careful-application-95617

7 months ago

This looks awesome, thanks for putting it together 🙌

polite-microphone-78573

7 months ago

Thanks Andrew. Looking forward to that! My main point of interest is to understand the Lineage feature, with the ultimate goal of creating a custom ‘table’ type to accommodate not-yet-supported integrations/resources and including those in the Lineage viz. from testing the API and digging into the Github revision history, I gather that that is not yet possible on the user’s end…but I have high hopes for future feature launches 😎

all in due time

elegant-house-93198

7 months ago

For what it’s worth, the way it works on the backend (which you’re correct is not exposed yet) is that we just take two resource id’s and we specify which is upstream and which is downstream and then we make the connection between the two. If we opened up an API with that specification would you find it useful? It would be a quick add.

polite-microphone-78573

7 months ago

If I could define my own arbitrary integration, i.e. a

custom resource

, and then create new tables, then 100% yes - that API that would be a massive benefit. The entire platform becomes extensible at that point

i.e. https://share.getcloudapp.com/OAu4AXem (could be strictly via API, just using the UI as a reference to make sure I’m using proper terminology)

elegant-house-93198

7 months ago

I see what you’re saying. This is aligned with the direction we’re moving towards where all “resources” from data sources are under one flexible data model instead of their own data models.

💯 1

View count: 1

Join thread in Slack