Skip to content

Document HTTP service#42331

Merged
mshustov merged 8 commits intoelastic:masterfrom
mshustov:http-service-doc
Aug 3, 2019
Merged

Document HTTP service#42331
mshustov merged 8 commits intoelastic:masterfrom
mshustov:http-service-doc

Conversation

@mshustov
Copy link
Copy Markdown
Contributor

@mshustov mshustov commented Jul 31, 2019 •
edited
Loading

Summary

Document HTTP service public interfaces and generate docs.

TODO:
discuss recommended folder structure. can be done as a separate PR.

[skip-ci]

@mshustov mshustov added review Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes labels Jul 31, 2019
@mshustov mshustov requested a review from a team as a code owner July 31, 2019 08:30
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jul 31, 2019

Pinging @elastic/kibana-platform

@mshustov mshustov mentioned this pull request Jul 31, 2019
Closed
@kimjoar kimjoar mentioned this pull request Jul 31, 2019
Closed
15 tasks
joshdover
joshdover reviewed Aug 1, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@joshdover joshdover left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So pumped about having great docs 🎉

src/core/MIGRATION.md Outdated
location: '/created-url'
}
})
```
Copy link
Copy Markdown
Contributor

@joshdover joshdover Aug 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about testing? Could you provide an example of how to test these handler methods?

Copy link
Copy Markdown
Contributor Author

@mshustov mshustov Aug 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing is not relevant as I moved the docs closer to the code.
We can provide a separate document recommending test patterns for NP.
Although I don't it's common for plugins to test their endpoints in insolation. Usually, It's a part of integration/functional tests.

Copy link
Copy Markdown
Contributor

@joshdover joshdover Aug 2, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although I don't it's common for plugins to test their endpoints in insolation.

Heh this really made upgrading Hapi very hard last time. IMO, endpoints should be tested with decent units so there can be fewer integrations tests needed. Anyways, I'm fine with not doing that here in this PR.

@mshustov mshustov requested a review from joshdover August 2, 2019 08:44
@mshustov mshustov merged commit d394ded into elastic:master Aug 3, 2019
@mshustov mshustov deleted the http-service-doc branch August 3, 2019 07:58
@mshustov mshustov mentioned this pull request Aug 3, 2019
Merged
mshustov added a commit to mshustov/kibana that referenced this pull request Aug 3, 2019
@mshustov
Document HTTP service (elastic#42331)
1644854 
* improving naming, add TSDoc

* re-genereate docs

* use response name in migration guide

* Apply suggestions from code review

Co-Authored-By: Josh Dover <me@joshdover.com>

* place docs near the related code

* re-generate docs

* mark code as example to reduce noise in http-service.md
mshustov added a commit that referenced this pull request Aug 4, 2019
@mshustov
Document HTTP service (#42331) (#42558)
c2aafcf 
* improving naming, add TSDoc

* re-genereate docs

* use response name in migration guide

* Apply suggestions from code review

Co-Authored-By: Josh Dover <me@joshdover.com>

* place docs near the related code

* re-generate docs

* mark code as example to reduce noise in http-service.md
jloleysens added a commit to jloleysens/kibana that referenced this pull request Aug 5, 2019
@jloleysens
Merge branch 'master' of github.com:elastic/kibana into feature/clone…
ad759ef 
…-or-edit-existing-rollup-job

* 'master' of github.com:elastic/kibana: (67 commits)
  [TSVB] Shim new platform (elastic#39169)
  [Metric Vis] Shim new platform (elastic#42240)
  [Tag Cloud] Shim new platform (elastic#42348)
  Disable flaky request lib tests. Add es_ui_shared plugin to CODEOWNERS.
  Add disk space percentage to node listing (elastic#42145)
  [SIEM] Add chart interactions - update date picker after brush selection on charts (elastic#42440)
  Document HTTP service (elastic#42331)
  [Reporting] Sanitize 409 error log message (elastic#42495)
  [docs][skip ci] Maps read only access (elastic#35561)
  [x-pack/ftr] refactor types to be more accurate/consistent wit… (elastic#42407)
  [DOCS] Updates images and content in Dashboard docs (elastic#42500)
  Allow sorting on multiple columns in Discover (elastic#41918)
  [Infra UI][Logs UI] Fix autocomplete to use proper derived index pattern (elastic#42287)
  [ftr/cheerio] improve cheerio types to include test subject me… (elastic#42534)
  Upgraded EUI 13.0.0 -> 13.1.1 (elastic#42298)
  Increase max-old-space-size for builds (elastic#42218)
  [Infra UI] Add cloud metrics and cloud/host info to metadata endpoint (elastic#41836)
  [Logs UI][a11y] Announce name of column on remove column button (elastic#41695)
  Inspector 👉 New Platform (elastic#42164)
  Make alerting properly space aware (elastic#42081)
  ...
jloleysens added a commit to jloleysens/kibana that referenced this pull request Aug 5, 2019
@jloleysens
Merge branch 'master' of github.com:elastic/kibana into fix/doc_value…
b366497 
…s_autocomplete

* 'master' of github.com:elastic/kibana: (189 commits)
  [TSVB] Shim new platform (elastic#39169)
  [Metric Vis] Shim new platform (elastic#42240)
  [Tag Cloud] Shim new platform (elastic#42348)
  Disable flaky request lib tests. Add es_ui_shared plugin to CODEOWNERS.
  Add disk space percentage to node listing (elastic#42145)
  [SIEM] Add chart interactions - update date picker after brush selection on charts (elastic#42440)
  Document HTTP service (elastic#42331)
  [Reporting] Sanitize 409 error log message (elastic#42495)
  [docs][skip ci] Maps read only access (elastic#35561)
  [x-pack/ftr] refactor types to be more accurate/consistent wit… (elastic#42407)
  [DOCS] Updates images and content in Dashboard docs (elastic#42500)
  Allow sorting on multiple columns in Discover (elastic#41918)
  [Infra UI][Logs UI] Fix autocomplete to use proper derived index pattern (elastic#42287)
  [ftr/cheerio] improve cheerio types to include test subject me… (elastic#42534)
  Upgraded EUI 13.0.0 -> 13.1.1 (elastic#42298)
  Increase max-old-space-size for builds (elastic#42218)
  [Infra UI] Add cloud metrics and cloud/host info to metadata endpoint (elastic#41836)
  [Logs UI][a11y] Announce name of column on remove column button (elastic#41695)
  Inspector 👉 New Platform (elastic#42164)
  Make alerting properly space aware (elastic#42081)
  ...
@mshustov mshustov added backported and removed review labels Aug 8, 2019
@jfsiii jfsiii mentioned this pull request Aug 14, 2019
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@joshdover joshdover joshdover approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

backported Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t//

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mshustov @elasticmachine @joshdover