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

[DOCS][8.3] Update note on API page #2033

Merged
merged 5 commits into from
Jun 16, 2022
Merged

[DOCS][8.3] Update note on API page #2033

merged 5 commits into from
Jun 16, 2022

Conversation

benironside
Copy link
Contributor

@benironside benironside commented May 31, 2022 •
edited
Loading

Fixes #1970 by removing a note from the Detections API topic about Kibana APIs not being supported in Console, and makes a couple minor edits on the same page. Wasn't sure if I should put the API label on this one.

Preview: Detections API

There are a ton of docs changed here, so I didn't think linking a preview of each would be appropriate. The change is the same across all the updated pages: replacing the old NOTE: with the new one.

@benironside benironside self-assigned this May 31, 2022
@mergify
Copy link
Contributor

mergify bot commented May 31, 2022

This pull request does not have a backport label. Could you fix it @benironside? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • v7.x is the label to automatically backport to the 7.x branch.
  • v7./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot removed the backport-skip label May 31, 2022
@benironside benironside added the Team: Detections/Response Detections and Response label May 31, 2022
@joepeeples
Copy link
Contributor

@benironside I think the change will need to be more extensive for this. Pretty much every API docs page has this note about Console, in both section landing pages like this and in the individual API pages. If I'm understanding #1970 and elastic/kibana#128562, then the change is Kibana-wide, not just in the Detections API. Might want to confirm with @spong?

@nastasha-solomon
Copy link
Contributor

nastasha-solomon commented Jun 1, 2022 •
edited
Loading

Hey, @benironside! @joepeeples is correct about the additional changes, though I think a few more changes are needed as well:

  • The note needs to be slightly revised to show that Kibana APIs are also supported but must be used with a special syntax (i.e., endpoint requests must be prefixed with kbn:api/).
  • Case API docs in the Kibana docset need the updated note added to them. Lisa might be able to help with this.

@benironside benironside changed the title [DOCS][8.3] Remove note that Console does not support Kibana APIs [DOCS][8.3] Update note on API page Jun 14, 2022
nastasha-solomon
nastasha-solomon reviewed Jun 14, 2022
View reviewed changes
Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

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

Left a minor suggestion. Also, as per our Slack convo:

  • The note is only needed in the Detections API page and the Elastic Security API page. , a few more actions are needed for this PR:
  • The note can be removed from all other API topics.

jmikell821
jmikell821 reviewed Jun 15, 2022
View reviewed changes
Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

Did a quick once-over glance, but looks good from what I scanned. Left one small comment.

joepeeples
joepeeples reviewed Jun 15, 2022
View reviewed changes
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

One small tweak to @jmikell821's suggestion, otherwise LGTM!

@benironside benironside merged commit be69c3b into main Jun 16, 2022
@benironside benironside deleted the issue-1970-big branch June 16, 2022 20:51
mergify bot pushed a commit that referenced this pull request Jun 16, 2022
@benironside @mergify
[DOCS][8.3] Update note on API page (#2033)
c2912cd 
* Fixes #1970 by removing a note that no longer applies.

* Updates API note throughout docs

* Removes NOTE from API pages except "Elastic Security APIS"

* Update docs/siem-apis.asciidoc

Co-authored-by: Janeen Mikell-Straughn <[email protected]>

Co-authored-by: Janeen Mikell-Straughn <[email protected]>
(cherry picked from commit be69c3b)
@mergify mergify bot mentioned this pull request Jun 16, 2022
Merged
benironside added a commit that referenced this pull request Jun 16, 2022
@mergify @benironside
[DOCS][8.3] Update note on API page (#2033) (#2079)
861f6c7 
* Fixes #1970 by removing a note that no longer applies.

* Updates API note throughout docs

* Removes NOTE from API pages except "Elastic Security APIS"

* Update docs/siem-apis.asciidoc

Co-authored-by: Janeen Mikell-Straughn <[email protected]>

Co-authored-by: Janeen Mikell-Straughn <[email protected]>
(cherry picked from commit be69c3b)

Co-authored-by: benironside <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmikell821 jmikell821 jmikell821 left review comments

@nastasha-solomon nastasha-solomon nastasha-solomon left review comments

@joepeeples joepeeples joepeeples left review comments

Assignees

@benironside benironside

Labels
Team: Detections/Response Detections and Response v8.3.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOCS] Remove note that Console only supports ES API's as it will now support Kibana API's in 8.3
4 participants
@benironside @joepeeples @nastasha-solomon @jmikell821