Commit graph

21 commits

Author SHA1 Message Date
Stacey Gammon
66f69d6a13
Clean up task manager public setup contract to improve readability and API docs (#113415)
* Improve API docs for task manager

* Update docs
2021-09-30 09:10:41 -04:00
Stacey Gammon
20202f7e7d
Add a plugin directory page to the docs build (#112862)
* Write plugin directory doc as part of api docs build.

* Replace service folder with the new name for index patterns

* Updated docs

* small update

* update docs
2021-09-28 13:17:12 -04:00
Stacey Gammon
98b7e99747
Clean up some of the API doc code (#111635)
* Clean up api doc infra

* updated docs

* Update api dics
2021-09-08 17:50:25 -04:00
Stacey Gammon
e097adbb6a
API Doc Fixes (#109685)
* Fixes

- Fix bad formatting of deprecated apis by plugin
- Collect deprecated apis recursively
- Include unreferenced apis in Deprecated apis by API page.

* Fix unreferenced dep list

* check in updated docs

* Fix the issue with saved objects management plugin docs not being included

* adding the new docs after fixing some docs missing

* update api docs
2021-08-24 13:42:23 -04:00
Stacey Gammon
899a6f3f11
Fix the API docs bug, where optional functions on interfaces were losing their children. (#107236)
* Fix the bug and update tests

* update api docs

* Fix tests
2021-08-03 11:58:03 -04:00
Stacey Gammon
81fd64c838
Remove line numbers from the json files (#107158)
* Stop tracking line numbers

* Updated api docs

* Fix type error and update tests

* wrap label in encodeURIComponent for the links

* Update docs after encodeUriComponent change
2021-08-02 12:57:22 -04:00
Stacey Gammon
01293bf86f
update api docs (#107312) 2021-07-30 15:26:29 -04:00
Christos Nasikas
82e0ce1b51
[Cases] Migrate to new Connectors APIs (#102662)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-07-29 14:20:51 +03:00
Stacey Gammon
283223101d
Improve deprecated API list, and update api docs (#106942)
* Code to adjust deprecated api list

* updated docs

* fix and update tests
2021-07-28 12:44:17 -04:00
Stacey Gammon
7ff28959b1
Update api docs (#103310)
* Update api docs

* update api docs after merge from master
2021-06-29 12:29:58 -04:00
Stacey Gammon
b2903e9f8f
Small clean up with Cases plugin API (#101668)
* Clean up public API of cases plugin

1. Don't use export * on index.ts files that define the public API
2. Add comments to the interface show they show up in the API docs
3. Export types that are part of the public API so they show up in the API docs.
4. Fill in information for the up and coming `description` and `owner` items in kibana.json.

* Update returns comments to be more descriptive

* update api docs

* Remove kibana.json attributes, until PR supporting them is merged.

* Change all exports to export type to avoid increase page bundle size
2021-06-10 08:43:07 -04:00
Stacey Gammon
7604fd7c80
Improve security server types (#101661)
* Remove RecursiveReadonly wrapper on public API items

* Remove Pick and export some types that are part of the public API

* Udpate api docs

* Export API items that are part of the public API

* Add extra comments

* update api docs
2021-06-09 14:01:48 +02:00
Stacey Gammon
8aa370ba3b
Improve security plugin return types (#101492)
* Add explicit security types

* Remove sessionTimeout, seems unused

* add comments

* Add comments and fix test since removing the unused APIs

* remove unused import

* wording cleanup

* Export some types that are part of the public API but not exported

* more improvements for api docs

* update security docs

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* remove unneccessary readonly prefix

* Update all api docs

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
2021-06-08 14:05:14 -04:00
Stacey Gammon
c489bcaa45
update api docs (#101528) 2021-06-07 17:55:35 -04:00
Stacey Gammon
f670fd23d6
Update api docs (#101509) 2021-06-07 15:02:57 -04:00
Stacey Gammon
044c725c71
Fix a bunch of bugs with APIDocs system (#99589)
* Remove custom code, add in a hack

* remove artifical limit

* Fix arrow functions in interfaces not having children

* Update docs

* Update api docs after merge from master

* update api docs after merge from master

* update api docs
2021-05-20 13:22:41 -04:00
Stacey Gammon
d5ebbac4f7
Add support for building a deprecation list with usage (#99154)
* Add support for building a deprecation list with usage

* Update API docs
2021-05-06 15:29:47 -04:00
Alejandro Fernández Haro
7c432e3048
[Usage Collection] Report the number of SOs per type (#99344)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-05-06 13:09:09 -04:00
Stacey Gammon
503cfcf8c9
Track API stats as part of ci (#95733)
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00
Lukas Olson
813e16f6ae
Fix search telemetry to only update SO periodically (#93130)
* Fix search telemetry to only update SO periodically

* Handle case when searches completed mid flight

* Fix error in resetting counters

* Update docs

* update docs

* Don't track restored searches

* Update docs

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Anton Dosov <anton.dosov@elastic.co>
2021-03-11 09:17:43 -07:00
Steph Milovic
2bb23291c7
[Security Solution] [Cases] rename case dir/plugin/context/i18n to cases (#94149) 2021-03-10 08:58:51 -07:00
Renamed from api_docs/case.json (Browse further)