Adjust APIs in preparation to UX study #22260
Conversation
ghost
added
the
| @@ -81,7 +81,7 @@ protected LogsQueryClient() | |||
| /// <summary> | |||
| /// Executes the logs query. | |||
| /// </summary> | |||
| /// <param name="workspace">The workspace to include in the query.</param> | |||
| /// <param name="workspace">The workspace id to include in the query (<c>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</c>).</param> | |||
There was a problem hiding this comment.
should we name this workspaceId ?
There was a problem hiding this comment.
Will this always be a GUID?
There was a problem hiding this comment.
The service defines the parameter as a string so no guarantees although I doubt it would change.
There was a problem hiding this comment.
It's system defined though, correct? The only reason I was asking is that we have examples of services that take a any string value, as long as that string is a valid GUID 😄 . In that case we just typed it as GUID to avoid pain.
There was a problem hiding this comment.
Good point. I'll chat with the team about it.
| @@ -159,7 +159,31 @@ public virtual async Task<Response<LogsQueryResult>> QueryAsync(string workspace | |||
| } | |||
|
|
|||
| /// <summary> | |||
| /// Submits the batch query. | |||
| /// Submits the batch query. Use the <see cref="LogsBatchQuery"/> to compose a batch query. | |||
| /// <code snippet="Snippet:BatchQuery" language="csharp"> | |||
There was a problem hiding this comment.
Should all of these code snippets also be wrapped in <example>?
There was a problem hiding this comment.
I want them to show in VS so embedded the <code> directly into the summary.
There was a problem hiding this comment.
Then it would be duplicated on the doc page. Never tried it though. What benefits do you think it would have?
Co-authored-by: Christopher Scott <[email protected]>
Co-authored-by: Scott Addie <[email protected]>
Add more to string implementations, snippets and turn advanced properties into methods so it's easier to find the main query result.