Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Security] Timeline OpenAPI documentation fixes #186458

Merged
merged 9 commits into from
Jul 3, 2024
Merged

[Security] Timeline OpenAPI documentation fixes #186458

merged 9 commits into from
Jul 3, 2024

Conversation

janmonschke
Copy link
Contributor

Summary

  • Fix issues that came up during validation with spectral lint running with the recommended settings.
  • Made sure all return and request types match with the code
  • Fixed incorrect descriptions and links to documenation

Fixes #183812.

@janmonschke
response keys must be scalar values
b143a2a
@janmonschke
fix OpenAPI parsing errors
91e9040
@janmonschke
fix incorrect titles and descriptions
f09a36e
@janmonschke
fix links to docs
fe0e15f
@janmonschke
Fix the body documentation
70fb1f3 
The route code intended the response to be `persistNote: res`. `res` was always undefined and therefore never returned. I changed the docs and the route code to match the behaviour.
Ideally we would have removed the `data: {}` object here but that would create a new route version which seems overkill.
@janmonschke
typo
f284d0e
@janmonschke
Merge branch 'main' into security/timeline-openapi-fixes
49e5efd
@janmonschke janmonschke added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Threat Hunting:Investigations Security Solution Investigations Team labels Jun 19, 2024
@janmonschke janmonschke self-assigned this Jun 19, 2024
@janmonschke janmonschke requested a review from a team as a code owner June 19, 2024 12:14
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting-investigations (Team:Threat Hunting:Investigations)

@janmonschke
Copy link
Contributor Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

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

cc @janmonschke

michaelolo24
michaelolo24 approved these changes Jul 3, 2024
View reviewed changes
Copy link
Contributor

@michaelolo24 michaelolo24 left a comment

Choose a reason for hiding this comment

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

Nice work! Validated that the errors from the spectral lint are resolved.

@michaelolo24
Copy link
Contributor

Gonna go ahead and merge the changes as I want to pull them into the code gen work here: #187172. Thanks!

@michaelolo24 michaelolo24 merged commit aad2239 into elastic:main Jul 3, 2024
37 checks passed
@michaelolo24 michaelolo24 added this to the 8.16 milestone Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michaelolo24 michaelolo24 michaelolo24 approved these changes

Assignees

@janmonschke janmonschke

Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Threat Hunting:Investigations Security Solution Investigations Team v8.15.0 v8.16.0
Projects
None yet
Milestone
8.16
Development

Successfully merging this pull request may close these issues.

[Security Solution] Make existing OpenAPI specs for Timeline API correct
5 participants
@janmonschke @elasticmachine @kibana-ci @michaelolo24 @kibanamachine