[DOCS-13777] [Atlas API] Some event types are not documented Created: 21/Jul/20  Updated: 14/Sep/20  Resolved: 14/Sep/20

Status: Closed
Project: Documentation
Component/s: Atlas
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major - P3
Reporter: Dmitry Ryabtsev Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 3 years, 21 weeks, 2 days ago
Epic Link: DOCSP-7540
Story Points: 2

 Description   

Description

For the documentation section that talks about the endpoints that should be used to work with the events (this one, for example) some of the event types are missing. For instance these should also be mentioned, but they're not:

  • CLUSTER_UPDATE_COMPLETED
  • CLUSTER_UPDATE_STARTED
  • AUTOMATION_CONFIG_PUBLISHED_AUDIT
  • MONGODB_USER_ADDED

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Melissa Plunkett [ 14/Sep/20 ]

Correct - until we have a less human centered process we had to make a call to ensure what we document is 100% correct. The best way we could be sure of that right now is to match the UI. If a customer asks about an option that exists but is not documented we can address those but imo it's better to be correct with a complex resource than ensure we have every possible option.

Comment by Anthony Sansone (Inactive) [ 14/Sep/20 ]

dmitry.ryabtsev: This was recently updated to match the Atlas Alert Config UI per guidance from melissa.plunkett. As this list does match the UI, these would not be added.

Generated at Thu Feb 08 08:08:42 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.