[DOCS] Generate Kibana API docs from open API specifications

[lcawl]

Per https://github.com/elastic/kibana/issues/82587, it's a long-term plan to automatically generate open API specifications for Kibana.

In the nearer term, there are plans to publish API documentation from such specifications. This is already being done for the Cloud APIs, for example.

To get the docs automation rolling, we can create v3 open API specifications for Kibana and use open source tools to generate interim HTML output for the following APIs:

• [x] Get features API https://github.com/elastic/kibana/pull/184248
• [x] Kibana spaces APIs https://github.com/elastic/kibana/pull/184252
• [x] Kibana role management APIs https://github.com/elastic/kibana/pull/184265
• [x] User session management APIs https://github.com/elastic/kibana/pull/184265
• [x] Saved objects APIs https://github.com/elastic/kibana/pull/184184, https://github.com/elastic/kibana/pull/186134
  • [x] Export objects https://github.com/elastic/kibana/pull/162522
  • [x] Import objects https://github.com/elastic/kibana/pull/162522
  • [x] Resolve import errors https://github.com/elastic/kibana/pull/162825
  • [x] Rotate encryption key https://github.com/elastic/kibana/pull/162566
  • [x] Get object - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Bulk get objects - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Find objects - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Create saved objects - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Bulk create saved objects - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Update object - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Bulk update objects - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Delete object - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Bulk delete objects - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Resolve object - deprecated https://github.com/elastic/kibana/pull/164355
  • [x] Bulk resolve objects - deprecated https://github.com/elastic/kibana/pull/164355
• [ ] Data views APIs https://github.com/elastic/kibana/pull/184182
  • [x] Get all data views https://github.com/elastic/kibana/pull/163444
  • [x] Get data view https://github.com/elastic/kibana/pull/163444
  • [x] Create data view https://github.com/elastic/kibana/pull/163444
  • [x] Update data view https://github.com/elastic/kibana/pull/163444
  • [x] Delete data view https://github.com/elastic/kibana/pull/163444
  • [x] Get default data view https://github.com/elastic/kibana/pull/163444
  • [x] Set default data view https://github.com/elastic/kibana/pull/163444
  • [x] Update data view fields metadata https://github.com/elastic/kibana/pull/164547
  • [x] Get runtime field https://github.com/elastic/kibana/pull/163444
  • [x] Create runtime field https://github.com/elastic/kibana/pull/163776
  • [x] Upsert runtime field https://github.com/elastic/kibana/pull/163776
  • [x] Update runtime field https://github.com/elastic/kibana/pull/163777
  • [x] Delete runtime field https://github.com/elastic/kibana/pull/163777
  • [ ] Swap references https://github.com/elastic/kibana/pull/187927
  • [ ] Swap references preview https://github.com/elastic/kibana/pull/187927
• [x] Index patterns APIs https://github.com/elastic/kibana/issues/161279
• [x] Alerting APIs https://github.com/elastic/kibana/pull/183945, https://github.com/elastic/kibana/pull/183564
  • [x] Create rule https://github.com/elastic/kibana/pull/149565
  • [x] Delete rule https://github.com/elastic/kibana/pull/147407
  • [x] Disable rule https://github.com/elastic/kibana/pull/148494
  • [x] Enable rule https://github.com/elastic/kibana/pull/148494
  • [x] Find rules https://github.com/elastic/kibana/pull/147061
  • [x] Get alerting framework health https://github.com/elastic/kibana/pull/148774
  • [x] Get rule https://github.com/elastic/kibana/pull/147407
  • [x] Get rule types https://github.com/elastic/kibana/pull/148774
  • [x] Update rule https://github.com/elastic/kibana/pull/147407
  • [x] Mute all alerts https://github.com/elastic/kibana/pull/148494
  • [x] Mute alert https://github.com/elastic/kibana/pull/148494
  • [x] Unmute all alerts https://github.com/elastic/kibana/pull/148494
  • [x] Unmute alert https://github.com/elastic/kibana/pull/148494
  • [x] Deprecated APIs https://github.com/elastic/kibana/pull/149655
• [x] Action and connector APIs https://github.com/elastic/kibana/pull/184068, https://github.com/elastic/kibana/pull/184956
  • [x] Create connector https://github.com/elastic/kibana/pull/148691
  • [x] Delete connector https://github.com/elastic/kibana/pull/148360
  • [x] Get connector https://github.com/elastic/kibana/pull/148360
  • [x] Get all connectors https://github.com/elastic/kibana/pull/148360
  • [x] List all connector types https://github.com/elastic/kibana/pull/145951
  • [x] Run connector https://github.com/elastic/kibana/pull/149274
  • [x] Update connector https://github.com/elastic/kibana/pull/148691
  • [x] Deprecated connector APIs https://github.com/elastic/kibana/pull/149637
• [x] Cases APIs https://github.com/elastic/kibana/pull/184074
  • [x] Add comment https://github.com/elastic/kibana/pull/142173
  • [x] Create case https://github.com/elastic/kibana/pull/142929
  • [x] Delete cases https://github.com/elastic/kibana/pull/142929
  • [x] Delete comments https://github.com/elastic/kibana/pull/142173
  • [x] Find cases https://github.com/elastic/kibana/pull/145007
  • [x] Find connectors https://github.com/elastic/kibana/pull/145007
  • [x] Get alerts https://github.com/elastic/kibana/pull/145007
  • [x] Get case activity https://github.com/elastic/kibana/pull/145007
  • [x] Get case https://github.com/elastic/kibana/pull/144950
  • [x] Get case status https://github.com/elastic/kibana/pull/144950
  • [x] Get cases by alert https://github.com/elastic/kibana/pull/144950
  • [x] Get comments https://github.com/elastic/kibana/pull/142173, https://github.com/elastic/kibana/pull/144950
  • [x] Get configuration https://github.com/elastic/kibana/pull/144657, https://github.com/elastic/kibana/pull/144950
  • [x] Get reporters https://github.com/elastic/kibana/pull/144950
  • [x] Get tags https://github.com/elastic/kibana/pull/144950
  • [x] Push case https://github.com/elastic/kibana/pull/144657
  • [x] Set configuration https://github.com/elastic/kibana/pull/144657
  • [x] Update cases https://github.com/elastic/kibana/pull/142929
  • [x] Update comment https://github.com/elastic/kibana/pull/142173
  • [x] Update configuration https://github.com/elastic/kibana/pull/144657
• [ ] Import and export dashboard APIs
• [x] Logstash configuration management APIs https://github.com/elastic/kibana/pull/184266
• [x] Machine learning APIs https://github.com/elastic/kibana/pull/136234, https://github.com/elastic/kibana/pull/141554, https://github.com/elastic/kibana/pull/184154
• [x] Short URLs APIs https://github.com/elastic/kibana/pull/184267
• [x] Task manager APIs https://github.com/elastic/kibana/pull/184249
• [x] Upgrade assistant APIs https://github.com/elastic/kibana/pull/184269
• [ ] Detection APIs see also https://github.com/elastic/examples/blob/master/Security%20Analytics/SIEM-examples/Detections-API/Kibana.postman_collection.v2.json
  • [ ] Create rule
  • [ ] Get rule
  • [ ] Find rules
  • [ ] Update rule
  • [ ] Delete rule
  • [ ] Bulk create rule actions
  • [ ] Bulk delete rule actions
  • [ ] Bulk update rule actions
  • [ ] Bulk action
  • [ ] Get index
  • [ ] Delete index
  • [ ] Get tags
  • [ ] Import rules
  • [ ] Export rules
  • [ ] Get privileges
  • [ ] Get signal alerts
  • [ ] Set signal alert status
  • [ ] Load prebuilt rules
  • [ ] Get prebuilt rule status
• [ ] Exception APIs
• [ ] List APIs
• [ ] Detection alerts migration APIs
• [ ] Timeline APIs
• [ ] Endpoint management APIs

[elasticmachine]

Pinging @elastic/kibana-docs (Team:Docs)

[nicholas-r-king]

Any timeline on data-views API open API specification. This would be useful for the terraform provider.