-
Notifications
You must be signed in to change notification settings - Fork 79
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.
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
[DOCS] Add operation summaries for data stream APIs #2711
Conversation
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added two musings but otherwise docs LGTM
@@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' | |||
import { DataStreamName } from '@_types/common' | |||
|
|||
/** | |||
* Create a data stream. | |||
* Creates a data stream. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Creates a data stream.
Do we need this in the summary too? If it looks better with the repetition in the summary in description, I'm okay with it, just wondering whether we want to do that in general or not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that for the reference to look right, we generally want a description. them being identical is probably an indicator that something should be added to the description - I think a link to the data stream docs here, for example, would be super nice. I am avoiding messing with the descriptions too much in this PR, but I'd rather have the stub here so it's easier to improve them in bulk later. let me know what you think.
@@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' | |||
import { IndexName } from '@_types/common' | |||
|
|||
/** | |||
* Convert an index alias to a data stream. | |||
* Converts an index alias to a data stream. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Converts an index alias to a data stream.
This is another one where I don't think repeating the summary adds a lot of value to the description.
This PR adds operation summaries for the data stream and data stream lifecycle APIs, using text from the appropriate pages from the elasticsearch API reference.
A couple of terminology fixes for data streams in the types area while I'm here as well
part of #2635