Add OpenAPI specs for EEM APIs

[tommyers-elastic]

Summary

Add OpenAPI specs for EEM APIs.

This PR introduces a couple of scripts to the @kbn/entities-schema package which generate OpenAPI specs and serves them in a Swagger UI.

To test:

cd x-pack/packages/kbn-entities-schema
yarn run openapi:generate  # [optional] this writes the spec to 'oas.yaml' 
yarn run openapi:serve  # this runs the swagger UI at 'localhost:3000'

[obltmachine]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
• run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

[miltonhultgren]

Didn't look at the specs yet, but can we verify that this is compatible with the documentation team's OAS setup so that whatever we have:
a) Gets re-generated when they run their scripts
b) Gets picked up by their tools to be included in the Kibana OAS docs

[tommyers-elastic]

@miltonhultgren sounds good - let's not block getting these merged though - we can follow up with the rest after. once we have the specs, the conversation with the docs team becomes easier.

[miltonhultgren]

Sounds good to me, I filed https://github.com/elastic/elastic-entity-model/issues/131

[tommyers-elastic]

@elasticmachine merge upstream

[miltonhultgren]

Running node scripts/generate_oas
I get the following warnings:

Recursive reference detected at #/allOf/1/anyOf/1/items! Defaulting to any
Recursive reference detected at #/allOf/1/anyOf/2/additionalProperties! Defaulting to any
Recursive reference detected at #/allOf/1/anyOf/1/items! Defaulting to any
Recursive reference detected at #/allOf/1/anyOf/2/additionalProperties! Defaulting to any

[miltonhultgren]

LGTM

[klacabane]

Running node scripts/generate_oas I get the following warnings:

Recursive reference detected at #/allOf/1/anyOf/1/items! Defaulting to any
Recursive reference detected at #/allOf/1/anyOf/2/additionalProperties! Defaulting to any
Recursive reference detected at #/allOf/1/anyOf/1/items! Defaulting to any
Recursive reference detected at #/allOf/1/anyOf/2/additionalProperties! Defaulting to any

I've had a look but couldn't find any obvious issue with the schemas. I've inspected the generate schema and everything look correctly generated so I'll log this as a follow up

[kibana-ci]

💛 Build succeeded, but was flaky

• Buildkite Build
• Commit: fd487bf
• Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-190203-fd487bfd2795

Failed CI Steps

• FTR Configs #81

Test Failures

• [job] [logs] FTR Configs #81 / Visualizations - Group 3 lens app - TSVB Open in Lens Dashboard to TSVB to Lens should convert a by reference TSVB viz to a Lens viz

Metrics [docs]

✅ unchanged

History

• 💔 Build #228267 failed 4f1e824
• 💛 Build #228098 was flaky 5c97010
• 💛 Build #227964 was flaky 606bb94
• 💚 Build #227557 succeeded df9cd9d
• 💚 Build #227535 succeeded 228886c

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream