Commit graph

27 commits

Author SHA1 Message Date
Stacey Gammon 4bfb35b43a
Update api docs (#116495)
* update api docs

* update api docs
2021-11-01 19:16:16 +00:00
Stacey Gammon 45e9d51a44
Add pluginTeam to plugin API ci stats (#115007)
* Add pluginTeam to ci stats for easier higher level groupings

* Updated docs
2021-10-14 11:54:35 -04:00
Stacey Gammon 8e72e17648
api docs (#114565) 2021-10-11 19:46:01 -04:00
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -04:00
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
Madison Caldwell 8f9086b4c2
[RAC][Security Solution] Add base Security Rule Type (#105096)
* injects bulkCreate and wrapHits to individual rule executors

* WIP create_security_rule_type_factory based on Marshall's work in #d3076ca54526ea0e61a9a99e1c1bce854806977e

* removes ruleStatusService from old rule executors, fixes executor unit tests

* fixes rebase

* Rename reference_rules to rule_types

* Fix type errors

* Fix type errors in base security rule factory

* Additional improvements to types and interfaces

* More type alignment

* Fix remaining type errors in query rule

* Add validation / inject lists plugin

* Formatting

* Improvements to typing

* Static typing on executors

* cleanup

* Hook up params for query/threshold rules... includes exceptionsList and daterange tuple

* Scaffolding for wrapHits and bulkCreate

* Add error handling / status reporting

* Fixup alert type state

* Begin threshold

* Begin work on threshold state

* Organize rule types

* Export base security rule types

* Fixup lifecycle static typing

* WrapHits / bulk changes

* Field mappings (partial)

* whoops

* Remove redundant params

* More flexibile implementation of bulkCreateFactory

* Add mappings

* Finish query rule

* Revert "Remove redundant params"

This reverts commit 87aff9c810.

* Revert "whoops"

This reverts commit a7771bd392.

* Fixup return types

* Use alertWithPersistence

* Fix import

* End-to-end rule mostly working

* Fix bulkCreate

* Bug fixes

* Bug fixes and mapping changes

* Fix indexing

* cleanup

* Fix type errors

* Test fixes

* Fix query tests

* cleanup / rename kibana.rac to kibana

* Remove eql/threshold (for now)

* Move technical fields to package

* Add indexAlias and buildRuleMessageFactory

* imports

* type errors

* Change 'kibana.rac.*' to 'kibana.*'

* Fix lifecycle tests

* Single alert instance

* fix import

* Fix type error

* Fix more type errors

* Fix query rule type test

* revert to previous ts-expect-error

* type errors again

* types / linting

* General readability improvements

* Add invariant function from Dmitrii's branch

* Use invariant and constants

* Improvements to field mappings

* More test failure fixes

* Add refresh param for bulk create

* Update more field refs

* Actually use refresh param

* cleanup

* test fixes

* changes to rule creation script

* Fix created signals count

* Use ruleId

* Updates to bulk indexing

* Mapping updates

* Cannot use 'strict' for dynamic setting

Co-authored-by: Marshall Main <marshall.main@elastic.co>
Co-authored-by: Ece Ozalp <ozale272@newschool.edu>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-08-03 12:48:07 -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
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 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 8fba2d93a6
Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823)
* Make sure arrow functions capture parameter comments.

* Update docs
2021-05-28 11:56:31 -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
Mike Côté 3abb79a179
Create new alerting HTTP APIs that use the new terminology (#93977)
* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Create new rule HTTP APIs (#93980)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Add necessary files

* Create rule route

* Get rule API

* Update rule API

* Delete rule route

* Aggregate rules API

* Disable rule API

* Enable rule API

* Find rules API

* Fix Update API

* Get rule alert summary API

* Get rule state API

* Health API

* Rule types API

* Mute all API

* Mute alert API

* Unmute all API

* Unmute alert route

* Update API key API

* corrected tpye by making it much more complicated

* removed unneeded cocde

* Fixes

* Add back health route

* mutedInstanceIds -> mutedAlertIds

* lastRun -> last_run

* alert_type_state -> rule_type_state & alert_instances -> alerts

Co-authored-by: Gidi Meir Morris <github@gidi.io>

* Create docs for new rule HTTP APIs, deprecate old docs (#94745)

* Create docs for new APIs, deprecate old docs

* Remove connector_type_id

* Update docs

* Add link to legacy APIs from rules API docs

* Remove connector_type_id references

* [DOCS] Add legacy APIs to index.asciidoc

* Fix camel case

Co-authored-by: lcawl <lcawley@elastic.co>

* Make alerting tests use new rules APIs (#95159)

* Make API integration tests use new HTTP APIs

* Fix end to end tests

* Fix test failures

* Fix more test failures

* Rename some files

* Add tests for legacy APIs (#95333)

* Initial commit (#95457)

* Move some new alerting APIs to /internal (#95461)

* Initial commit

* Update README.md

* Use internal API

* Merge deprecated warning w/ alternative solution

* Update API docs

Co-authored-by: Gidi Meir Morris <github@gidi.io>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
2021-03-30 08:27:28 -04:00
Joe Reuter f07b1722cb
[Lens] Implement filtered metric (#92589) 2021-03-24 11:44:23 +01:00
Stacey Gammon 2ed2cfe52f
update api docs (#95154) 2021-03-23 14:31:08 -04:00
Stacey Gammon cecdcc538e
API docs clean up (#93508)
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
2021-03-05 20:12:28 -05:00
Stacey Gammon 87a5b22626
API DOCS Step 3/3 (#92929)
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-02 22:02:17 -05:00