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.

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

[DO NOT MERGE] Office 365 usage reports JSON version to Beta #1749

Closed
wants to merge 23 commits into from

Conversation

@kszb
Copy link
Contributor

commented Sep 25, 2017

No description provided.

@msftgits msftgits removed the cla-required label Sep 26, 2017

@microsoftgraph microsoftgraph deleted a comment from msftclas Sep 26, 2017

@msftclas

This comment has been minimized.

Copy link

commented Sep 28, 2017

CLA assistant check
All CLA requirements met.

kszb added 11 commits Sep 28, 2017
"participated": 91,
"reportRefreshDate": "2017-09-01",
"reportDate": "2017-09-01",
"reportPeriod": "7"

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 6, 2017

Contributor

I'm curious why reportPeriod is a string

This comment has been minimized.

Copy link
@kszb

kszb Oct 11, 2017

Author Contributor

The period parameter is string type.

"organizedConferenceCloudDialInOutMicrosoftCount": 0,
"organizedConferenceCloudDialInMicrosoftMinutes": 0,
"organizedConferenceCloudDialOutMicrosoftMinutes": 0,
"participantedConferenceIMCount": 0,

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 6, 2017

Contributor

I don't understand what this represents: participantedConferenceIMCount. Do you mean, participatedInConferenceIMCount?
Similarly for all that begin with "participanted"

This comment has been minimized.

Copy link
@kszb

kszb Oct 11, 2017

Author Contributor

Yes. We've already reviewed the field names before. This means the conference participated in.

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 11, 2017

Contributor

That's a concern because participanted is not a valid word and may confuse developers.


## Response

If successful, this method returns a `200 OK` response code and an **skypeForBusinessOrganizerActivityUserCounts** object in the response body.

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 6, 2017

Contributor

Please ensure that "an" is used before vowels but use "a" otherwise. In this case, it should be "and a" instead of "and an"

kszb added 6 commits Oct 11, 2017
@@ -21,7 +21,7 @@ One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } -->

```http
GET /reports/Office365ActiveUserCounts(period='{period_value}')?$format=application/json

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 12, 2017

Contributor

per our meeting yesterday: you should keep the $format here as it's required at this point. When the function supports both csv and json then you can remove it from the request and update the instructions accordingly.

@@ -36,7 +36,7 @@ In the request URL, provide the chosen query parameter with a valid value.

> **Note:** You need to set either period or date in the URL.
This method supports the `$top` and `$skipToken` [OData query parameters](../../../concepts/query_parameters.md) to customize the response.
This method supports the `$format`, `$top` and `$skipToken` [OData query parameters](../../../concepts/query_parameters.md) to customize the response. `$format` must be set application/json value.

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 12, 2017

Contributor

Query parameters should be in its own section.

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 12, 2017

Contributor

To keep with the pattern of the rest of the content, you should follow this general outline:
Permissions
HTTP request
Optional request parameters OR Request parameters
Optional query parameters OR Query parameters
Request headers
Request body
Response
Example

@@ -0,0 +1,16 @@
# office365ActiveUserDetail resource type

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 12, 2017

Contributor

Please include a brief description of the resource

This comment has been minimized.

Copy link
@kszb

kszb Oct 13, 2017

Author Contributor

As said before, we always have one resource type for one function, so the description of resource type is almost the same with function, I don't know whether we need to add that. For some cases, which the same resource is used by several different functions, the meaning of resource would be different when they apply in different functions.

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 13, 2017

Contributor

But you can't assume that the user is coming from the function context, especially if you're including it in the TOC as that means the user may come upon this documentation but not the function with the description. You should still be able to give the gist of the resource's purpose in the brief description. Also, if the difference is that important between the different functions, then it might be worth calling out here.


## Properties

| Property | Type |

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 12, 2017

Contributor

Known pending item: Add description for each property

| yammer | Int64 |
| teams | Int64 |
| reportDate | Date |
| reportPeriod | String |

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 12, 2017

Contributor

Should add a JSON representation section for the resource. Please include the comment block before the json code block to enable validation.


```http
{
"reportRefreshDate": "2017-09-01",

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 13, 2017

Contributor

The JSON representation should in general have the type of the property instead of a sample value. Please see here for a sample: https://developer.microsoft.com/en-us/graph/docs/api-reference/beta/resources/timezoneinformation

@@ -46,7 +46,7 @@ This method supports the `$format`, `$top` and `$skipToken` [OData query paramet

## Response

If successful, this method returns a `200 OK` response code and an **[office365ActiveUserDetail](../resources/office365activeuserdetail)** object in the response body.
If successful, this method returns a `200 OK` response code and an **[office365ActiveUserDetail](../resources/office365activeuserdetail.md)** object in the response body.

This comment has been minimized.

Copy link
@ElizabethSamuel-MSFT

ElizabethSamuel-MSFT Oct 13, 2017

Contributor

verify that referenced files are correct, particularly where you updated names

@kszb kszb closed this Oct 27, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.