Skip to content

[Discuss] OpenAPI spec for registry #487

@jfsiii

Description

@jfsiii

From OpenAPI

OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including:

  • Available endpoints (/users) and operations on each endpoint (GET /users, POST /users)
  • Operation parameters Input and output for each operation
  • Authentication methods
  • Contact information, license, terms of use and other information.

If the registry published this, consumers could use the structured format to integrate into scripts and other parts of workflow.

For example, EPM use that file to create the TS types it needs. This would accomplish the goal of elastic/kibana#54955 without requiring the registry to generate them #196

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:EcosystemLabel for the Packages Ecosystem team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions