Skip to content

Draft v2 (external) API #11678

@Pwuts

Description

@Pwuts

Our current (v1) external API is outdated and not feature complete. Now that we have SSO/OAuth support (#11617), we want a feature-complete API so other apps can meaningfully integrate with our platform.

The scope of this ticket is:

  • Draft a list of features we want to expose through the external API
  • Draft a list of endpoints we want to expose for each of these features
  • Get feedback from @engineering
  • Implement

Core principles

  • Goal: to allow app creators to use the Platform as their backend.
  • I want to strike a balance between feature-completeness and maintainability.
  • DX: endpoints should be self-documenting and have clear input and output types.
  • Ease-of-use: complex user interactions such as selecting the right credentials for a graph execution should be made as easy as possible.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions