elastic / elastic/package-registry

[Discuss] OpenAPI spec for registry

Open
#487 6 comments 0 reactions 0 assignees View on GitHub
Team:Ecosystem
Dominant language
Go
Stars
52
Forks
82
Avg merge
9h 53m
Merged PRs (30d)
52

Description

From [OpenAPI](https://swagger.io/docs/specification/about/)
> 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 https://github.com/elastic/kibana/pull/54955 without requiring the registry to generate them https://github.com/elastic/package-registry/pull/196

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.