Skip to content

[API]: Text and titles in Machine Learning Kibana API docs is unnecessarily verbose #5594

@peteharverson

Description

@peteharverson

Was the documentation helpful?

Yes

What documentation page is affected

Description

The text and titles on the docs pages for the public Machine Learning API docs is overly verbose and would benefit from a review to make it more concise, and consistent with the style used on other pages.

For example Sync saved objects in the default space

  • Drop in the default space from the title Sync saved objects in the default space.
  • Response attribute datafeedsAdded text - could be simplified to something like Contains a list of datafeed objects that were identified for addition as a result of synchronization.
  • Response attributes datafeedsRemoved, savedObjectsCreated, savedObjectsDeleted - similar approach needed as for datafeedsAdded above.

cc @nastasha-solomon

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions