From 154b22dc96120b622eef8f1a3982a9ddf4013ddd Mon Sep 17 00:00:00 2001 From: Chris Price Date: Wed, 9 May 2018 12:24:47 -0400 Subject: [PATCH 1/6] Initial cut at some documentation for meetings --- guides/V1_Meeting.md | 79 +++++++++++++++++++++++++++++++++++++ guides/V1_Start_Meeting.md | 55 ++++++++++++++++++++++++++ guides/V1_Update_Meeting.md | 55 ++++++++++++++++++++++++++ guides/V1_wwsg_Meetings.md | 23 +++++++++++ 4 files changed, 212 insertions(+) create mode 100644 guides/V1_Meeting.md create mode 100644 guides/V1_Start_Meeting.md create mode 100644 guides/V1_Update_Meeting.md create mode 100644 guides/V1_wwsg_Meetings.md diff --git a/guides/V1_Meeting.md b/guides/V1_Meeting.md new file mode 100644 index 0000000..3dea2b4 --- /dev/null +++ b/guides/V1_Meeting.md @@ -0,0 +1,79 @@ +--- +copyright: 'Copyright IBM Corp. 2018' +link: 'meeting' +is: 'experimental' +--- + +# Get meeting details + +## Concepts + +The _meeting_ query allows the API caller to get details about the meeting. The query accepts a Space ID (spaceId) and will return meeting details if the calling user has access to the meeting. The calling user will have access to the meeting if the user has access to the space which contains the meeting, or the meeting has been marked to allow public participants. + +## Schema + +### Meeting Query + + +```graphql +type QueryRoot { + ... + meeting(spaceId: ID!): Meeting +} + +type Meeting { + active: Boolean! + meetingNumber: String + password: String + allowPublic: Boolean! + startTime: Date + joinInfo: JoinInfo +} + +type JoinInfo { + meetingProviderJoinUrl: String + pstnPasscode: String + dialInNumbers : [DialInNumber] +} + +type DialInNumber { + countryCode: String! + number: String! +} + +``` + +## Example Request + +~~~~ +Method: POST +URL: https://api.watsonwork.ibm.com/graphql +Headers: 'Content-Type: application/graphql' , 'x-graphql-view: PUBLIC, EXPERIMENTAL' +Body: +{ + query { + meeting(spaceId: "5a9ee86ee4b0cb1ca3dfef33") { + active + password + joinInfo { + meetingProviderJoinUrl + } + } + } +} +~~~~ +## Example Result + +~~~~ +{ + "data": { + "meeting": { + "active": true, + "password": "53621872", + "joinInfo": { + "meetingProviderJoinUrl": "https://zoom.us/j/240286814?pwd=vBRBlZBaXAKwIumekTziMw" + } + } + } +} +~~~~ diff --git a/guides/V1_Start_Meeting.md b/guides/V1_Start_Meeting.md new file mode 100644 index 0000000..7e51080 --- /dev/null +++ b/guides/V1_Start_Meeting.md @@ -0,0 +1,55 @@ +--- +copyright: 'Copyright IBM Corp. 2018' +link: 'start-meeting' +is: 'experimental' +--- + +# Start a meeting within a space + +## Concepts + +The _startMeeting_ mutation allows the API caller to start a meeting with a **space**. The mutation accepts a Space ID (spaceId) as an argument, and makes the request on behalf of the caller, starting a meeting within the specified space. The result will reflect the whether the call was accepted for processing by the service. + +## Schema + +### Start Meeting Mutation + + + +```graphql +type MutationRoot { + ... + startMeeting(input: StartMeetingInput!): MeetingMutationOutput +} + +type MeetingMutationOutput { + accepted: Boolean! +} +``` + +## Example Request + +~~~~ +Method: POST +URL: https://api.watsonwork.ibm.com/graphql +Headers: 'Content-Type: application/graphql' , 'x-graphql-view: PUBLIC, EXPERIMENTAL' +Body: +{ + mutation { + startMeeting(input: {spaceId : "5ad0fabfe4b078066d690a24"}) { + accepted + } + } +} +~~~~ +## Example Result + +~~~~ +{ + "data": { + "startMeeting": { + "accepted": "true" + } + } +} +~~~~ diff --git a/guides/V1_Update_Meeting.md b/guides/V1_Update_Meeting.md new file mode 100644 index 0000000..2420c4e --- /dev/null +++ b/guides/V1_Update_Meeting.md @@ -0,0 +1,55 @@ +--- +copyright: 'Copyright IBM Corp. 2018' +link: 'update-meeting' +is: 'experimental' +--- + +# Update a meeting + +## Concepts + +The _updateMeeting_ mutation allows the API caller to configure options on the meeting. The mutation accepts a Space ID (spaceId), and an allowPublic boolean as arguments, and makes the request on behalf of the caller, updating the meeting within the specified space. The result will reflect the whether the call was accepted for processing by the service. + +## Schema + +### Update Meeting Mutation + + + +```graphql +type MutationRoot { + ... + updateMeeting(input: UpdateMeetingInput!): MeetingMutationOutput +} + +type MeetingMutationOutput { + accepted: Boolean! +} +``` + +## Example Request + +~~~~ +Method: POST +URL: https://api.watsonwork.ibm.com/graphql +Headers: 'Content-Type: application/graphql' , 'x-graphql-view: PUBLIC, EXPERIMENTAL' +Body: +{ + mutation { + updateMeeting(input: {spaceId : "5ad0fabfe4b078066d690a24", allowPublic: true}) { + accepted + } + } +} +~~~~ +## Example Result + +~~~~ +{ + "data": { + "updateMeeting": { + "accepted": "true" + } + } +} +~~~~ diff --git a/guides/V1_wwsg_Meetings.md b/guides/V1_wwsg_Meetings.md new file mode 100644 index 0000000..855c405 --- /dev/null +++ b/guides/V1_wwsg_Meetings.md @@ -0,0 +1,23 @@ +--- +copyright: 'Copyright IBM Corp. 2018' +link: 'meetings-overview' +is: 'experimental' +--- +## Meetings Overview + +Watson Work Services provides a set of **meeting** APIs for callers to start and get details about meetings. Meetings are online collaboration sessions which allow users to communicate with one another using the Workspace client, Zoom client, or a basic telephone. Meetings include audio, video, screensharing, and whiteboarding. Meetings happen within the context of a **space** and can either be restricted to only members of that space, or can be opened to public access so you can meet with people outside of your team or company. + +### External APIs + + * GraphQL mutation for starting a meeting + * **startMeeting** [Start a meeting within a space](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_Start_Meeting.md) +
+* GraphQL mutation for updating a meeting + * **updateMeeting** [Update a meeting](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_Update_Meeting.md) +
+ * GraphQL query for meeting details + * **meeting** [Get information about the meeting](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_Meeting.md) +
+ * GraphQL query for getting an active meeting within a space + * [Optional inclusion of activeMeeting on a space](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_spaces_main.md) +

From 08f519f4fd56b3399bbe4f35f802b6b493d7e878 Mon Sep 17 00:00:00 2001 From: Chris Price Date: Wed, 9 May 2018 14:54:37 -0400 Subject: [PATCH 2/6] Adding REST doc --- guides/V1_Get_Public_Meeting.md | 50 +++++++++++++++++++++++++++++++++ guides/V1_spaces_main.md | 1 + guides/V1_wwsg_Meetings.md | 7 +++-- 3 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 guides/V1_Get_Public_Meeting.md diff --git a/guides/V1_Get_Public_Meeting.md b/guides/V1_Get_Public_Meeting.md new file mode 100644 index 0000000..abc1be6 --- /dev/null +++ b/guides/V1_Get_Public_Meeting.md @@ -0,0 +1,50 @@ +--- +copyright: 'Copyright IBM Corp. 2017' +link: 'get-public-meeting' +is: 'experimental' +--- +# Get Public Meeting Details + +This REST GET request allows the API caller to get details about a public meeting. + +### Version information +- Version: 1.0.0 + +### URI scheme +_Host_ : **api.watsonwork.ibm.com** +_Scheme_: **HTTPS** + +### Path +``` +GET v1/publicMeeting/bySpaceId/ +``` + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|The meeting data returned.|MeetingData(see below)| + + +#### Produces + +* `application/json` + + + + +#### MeetingData +Entity that represents the requested meeting. + +|Name|Description|Schema| +|---|---|---| +|**meetingId**
*required*|Id of the meeting.|string| +|**meetingNumber**
*optional*|The Zoom meeting number if the meeting is currently active or otherwise null.|string| +|**password**
*optional*|The Zoom meeting password if the meeting is currently active or otherwise null.|string| +|**active**
*required*|Boolean representing whether the meeting is currently active.|string| +|**allowPublic**
*required*|Boolean representing whether the meeting open to the public.|string| +|**startTime**
*optional*|Start time of the active meeting or otherwise null.|string| +|**meetingProviderJoinUrl**
*optional*|A URL to join the meeting with the Zoom client or otherwise null.|string| +|**meetingProviderJoinUrl**
*optional*|A URL to join the meeting with the Zoom client or otherwise null.|string| +|**pstnPasscode**
*optional*|The PSTN passcode of the active meeting if present or otherwise null.|string| +|**dialInNumbers**
*optional*|An array of country code identifier plus dial-in number forthe active meeting or otherwise null.|string| diff --git a/guides/V1_spaces_main.md b/guides/V1_spaces_main.md index 4801f0c..3d20f92 100644 --- a/guides/V1_spaces_main.md +++ b/guides/V1_spaces_main.md @@ -23,3 +23,4 @@ Watson Work Services represents a Space with this object. | members(before: String, after: String, first: Int, last: Int) | PersonCollection | The members of this space provided as a PersonCollection | membersUpdated | Date | The date the membership was updated | | conversation |Conversation | The conversation object for this space | +| activeMeeting | Meeting | Indicates that there is a meeting active within this space. Will only contain a sub-selection of all available meeting details, so this is suitable to use in a list view of spaces. This requires the `EXPERIMENTAL` value in `x-graphql-view header`. | diff --git a/guides/V1_wwsg_Meetings.md b/guides/V1_wwsg_Meetings.md index 855c405..5fce2b4 100644 --- a/guides/V1_wwsg_Meetings.md +++ b/guides/V1_wwsg_Meetings.md @@ -19,5 +19,8 @@ Watson Work Services provides a set of **meeting** APIs for callers to start and * **meeting** [Get information about the meeting](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_Meeting.md)
* GraphQL query for getting an active meeting within a space - * [Optional inclusion of activeMeeting on a space](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_spaces_main.md) -

+ * **Space.activeMeeting** [Optional inclusion of activeMeeting on a space](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_spaces_main.md) +
+ * REST request for getting details of a public meeting + * **/api/v1/publicMeeting/bySpaceId/** [Get information about a public meeting](https://github.com/watsonwork/watsonwork-developer-docs/blob/master/guides/V1_Get_Public_Meeting.md) +
From 2e3da0f5632d45fd813eb287caf1f8f310e8f173 Mon Sep 17 00:00:00 2001 From: Chris Price Date: Wed, 18 Jul 2018 16:30:35 -0400 Subject: [PATCH 3/6] Address review comments --- Whats_New.md | 1 + guides/V1_Meeting.md | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Whats_New.md b/Whats_New.md index 363714a..19212bb 100644 --- a/Whats_New.md +++ b/Whats_New.md @@ -9,6 +9,7 @@ Keep up to date on what's new in IBM Watson Work Services. We'll list the latest | Date | What's new | | ------------- |:-------------| +| 18.Jul.2018 | Added [meeting API](./guides/V1_wwsg_Meetings.md). | | 03.Jul.2018 | Added section with GraphQL [pagination](./guides/V1_pagination.md) example. | | 19.Jun.2018 | Added documentation section on [Moments GraphQL](./guides/V1_moment_main.md). | | 27.Mar.2018 | Added `space-updated` and `space-deleted` webhook events. | diff --git a/guides/V1_Meeting.md b/guides/V1_Meeting.md index 3dea2b4..b2484a3 100644 --- a/guides/V1_Meeting.md +++ b/guides/V1_Meeting.md @@ -52,7 +52,7 @@ Headers: 'Content-Type: application/graphql' , 'x-graphql-view: PUBLIC, EXPERIME Body: { query { - meeting(spaceId: "5a9ee86ee4b0cb1ca3dfef33") { + meeting(spaceId: "space-id") { active password joinInfo { @@ -77,3 +77,5 @@ Body: } } ~~~~ + +Try it out with our GraphQL tool - Get a meeting by space-id From 559ed52db168cdc262742f68988ffadf3ac4ae44 Mon Sep 17 00:00:00 2001 From: Chris Price Date: Wed, 18 Jul 2018 16:39:55 -0400 Subject: [PATCH 4/6] Address review comments --- guides/V1_Get_Public_Meeting.md | 2 +- guides/V1_Start_Meeting.md | 2 ++ guides/V1_Update_Meeting.md | 2 ++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/guides/V1_Get_Public_Meeting.md b/guides/V1_Get_Public_Meeting.md index abc1be6..ede9a78 100644 --- a/guides/V1_Get_Public_Meeting.md +++ b/guides/V1_Get_Public_Meeting.md @@ -1,5 +1,5 @@ --- -copyright: 'Copyright IBM Corp. 2017' +copyright: 'Copyright IBM Corp. 2018' link: 'get-public-meeting' is: 'experimental' --- diff --git a/guides/V1_Start_Meeting.md b/guides/V1_Start_Meeting.md index 7e51080..e712ad8 100644 --- a/guides/V1_Start_Meeting.md +++ b/guides/V1_Start_Meeting.md @@ -53,3 +53,5 @@ Body: } } ~~~~ + +Try it out with our GraphQL tool - Start a meeting diff --git a/guides/V1_Update_Meeting.md b/guides/V1_Update_Meeting.md index 2420c4e..3f08bc2 100644 --- a/guides/V1_Update_Meeting.md +++ b/guides/V1_Update_Meeting.md @@ -53,3 +53,5 @@ Body: } } ~~~~ + +Try it out with our GraphQL tool - Update a meeting From c40d096e432e36d19d15266e2d130c14b091c50c Mon Sep 17 00:00:00 2001 From: Chris Price Date: Wed, 29 Aug 2018 20:43:47 -0400 Subject: [PATCH 5/6] Address review comments --- guides/V1_Meeting.md | 26 ++++++++++++++++++++++++++ guides/V1_Start_Meeting.md | 16 ++++++++++++++++ guides/V1_Update_Meeting.md | 18 ++++++++++++++++++ 3 files changed, 60 insertions(+) diff --git a/guides/V1_Meeting.md b/guides/V1_Meeting.md index b2484a3..76903f7 100644 --- a/guides/V1_Meeting.md +++ b/guides/V1_Meeting.md @@ -43,6 +43,32 @@ type DialInNumber { ``` +## Field definitions + +# Meeting +|Name|Description|Schema| +|---|---|---|---| +|**active**|Whether the meeting is currently active|**Boolean**
_required_| +|**meetingNumber**|If a meeting is active, the a string of digits representing the Zoom meeting|**String**| +|**password** |If a meeting is active, the password required to join the Zoom meeting|**String**| +|**allowPublic** |Whether the meeting can be joined by non-members of the space|**Boolean**
_required_| +|**startTime** |The start date/time of the meeting |**Date**| +|**joinInfo** |Join details about the active meeting |**JoinInfo**| + +# JoinInfo +|Name|Description|Schema| +|---|---|---|---| +|**meetingProviderJoinUrl**|A URL which can be used to directly joint he meeting in a browser|**String**| +|**pstnPasscode**|If required, the DTMF digits necessary to join a meeting via a phone dial in|**String**| +|**dialInNumbers**|An array of DialInNumber objects|** DialInNumber** array| + +# DialInNumber +|Name|Description|Schema| +|---|---|---|---| +|**countryCode**|Two character country code where the number resides|**String**
_required_| +|**number**|E.164 phone number which can be used to dial into the meeting|**String**
_required_| + + ## Example Request ~~~~ diff --git a/guides/V1_Start_Meeting.md b/guides/V1_Start_Meeting.md index e712ad8..948ed0b 100644 --- a/guides/V1_Start_Meeting.md +++ b/guides/V1_Start_Meeting.md @@ -22,11 +22,27 @@ type MutationRoot { startMeeting(input: StartMeetingInput!): MeetingMutationOutput } +type StartMeetingInput { + spaceId: ID! +} + type MeetingMutationOutput { accepted: Boolean! } ``` +## Field definitions + +# StartMeetingInput +|Name|Description|Schema| +|---|---|---|---| +|**spaceId**|Space ID of the space in which to start a meeting|**String**
_required_| + +# MeetingMutationOutput +|Name|Description|Schema| +|---|---|---|---| +|**accepted**|Whether the request to start a meeting was accepted for processing|**Boolean**
_required_| + ## Example Request ~~~~ diff --git a/guides/V1_Update_Meeting.md b/guides/V1_Update_Meeting.md index 3f08bc2..f37a9b1 100644 --- a/guides/V1_Update_Meeting.md +++ b/guides/V1_Update_Meeting.md @@ -22,10 +22,28 @@ type MutationRoot { updateMeeting(input: UpdateMeetingInput!): MeetingMutationOutput } +type UpdateMeetingInput { + spaceId: ID! + +} + type MeetingMutationOutput { accepted: Boolean! } ``` +## Field definitions + +# UpdateMeetingInput +|Name|Description|Schema| +|---|---|---|---| +|**spaceId**|Space ID of the space for which the meeting should be updated|**String**
_required_| +|**allowPublic**|Whether or not non-space members can join meetings started in the space|**Boolean**
_required_| + +# MeetingMutationOutput +|Name|Description|Schema| +|---|---|---|---| +|**accepted**|Whether the request to update the meeting was accepted for processing|**Boolean**
_required_| + ## Example Request From 93fc8ad531ea6e4c63d3ac343b4cd36ed3a7092f Mon Sep 17 00:00:00 2001 From: Chris Price Date: Fri, 12 Oct 2018 17:02:23 -0400 Subject: [PATCH 6/6] Revisions for latest code changes that are currently live in production --- guides/V1_Meeting.md | 92 +++++++++++++------ ...eting.md => V1_Update_Meeting_Settings.md} | 24 ++--- guides/V1_spaces_main.md | 2 +- 3 files changed, 79 insertions(+), 39 deletions(-) rename guides/{V1_Update_Meeting.md => V1_Update_Meeting_Settings.md} (51%) diff --git a/guides/V1_Meeting.md b/guides/V1_Meeting.md index 76903f7..e53f282 100644 --- a/guides/V1_Meeting.md +++ b/guides/V1_Meeting.md @@ -8,7 +8,7 @@ is: 'experimental' ## Concepts -The _meeting_ query allows the API caller to get details about the meeting. The query accepts a Space ID (spaceId) and will return meeting details if the calling user has access to the meeting. The calling user will have access to the meeting if the user has access to the space which contains the meeting, or the meeting has been marked to allow public participants. +The _meeting_ query allows the API caller to get details about the meeting. The query accepts either a Space ID (spaceId) or a meeting ID (id) and will return meeting details if the calling user has access to the meeting. The calling user will have access to the meeting if the user has access to the space which contains the meeting, or the meeting has been marked to allow public participants. ## Schema @@ -18,55 +18,93 @@ The _meeting_ query allows the API caller to get details about the meeting. The ```graphql type QueryRoot { ... - meeting(spaceId: ID!): Meeting + meeting(spaceId: ID, id: ID): Meeting } -type Meeting { - active: Boolean! - meetingNumber: String - password: String - allowPublic: Boolean! +type MeetingRecording { + url: String! startTime: Date - joinInfo: JoinInfo + stopTime: Date +} + +type DialInNumber { + countryCode: String! + number: String! } type JoinInfo { + allowPublic: Boolean! + meetingNumber: String meetingProviderJoinUrl: String + password: String + hostKey: String! pstnPasscode: String + webJoinToken: String! dialInNumbers : [DialInNumber] } -type DialInNumber { - countryCode: String! - number: String! +type Meeting { + id: ID! + active: Boolean! + allowPublic: Boolean! + startTime: Date + endTime: Date + description: String + recordings: [MeetingRecording] + activeParticipants: PersonCollection + attendees: PersonCollection + space: Space! + startedBy: Person + message: Message + joinInfo: JoinInfo } ``` ## Field definitions -# Meeting +# MeetingRecording |Name|Description|Schema| |---|---|---|---| -|**active**|Whether the meeting is currently active|**Boolean**
_required_| -|**meetingNumber**|If a meeting is active, the a string of digits representing the Zoom meeting|**String**| -|**password** |If a meeting is active, the password required to join the Zoom meeting|**String**| -|**allowPublic** |Whether the meeting can be joined by non-members of the space|**Boolean**
_required_| -|**startTime** |The start date/time of the meeting |**Date**| -|**joinInfo** |Join details about the active meeting |**JoinInfo**| +|**url**|The URL pointing to the meeting recording MP4 file.|**String**
_required_| +|**startTime** |The start date/time of the meeting recording |**Date**| +|**stopTime** |The stop date/time of the meeting recording |**Date**| + + +# DialInNumber +|Name|Description|Schema| +|---|---|---|---| +|**countryCode**|Two character country code where the number resides|**String**
_required_| +|**number**|E.164 phone number which can be used to dial into the meeting|**String**
_required_| # JoinInfo |Name|Description|Schema| |---|---|---|---| -|**meetingProviderJoinUrl**|A URL which can be used to directly joint he meeting in a browser|**String**| +|**allowPublic** |Whether the meeting can be joined by non-members of the space|**Boolean**
_required_| +|**meetingNumber**|If a meeting is active, the a string of digits representing the Zoom meeting|**String**
_required_| +|**meetingProviderJoinUrl**|A URL which can be used to directly joint he meeting in a browser|**String**
_required_| +|**password** |If a meeting is active, the password required to join the Zoom meeting|**String**| +|**hostKey** |If a meeting is active and there is no current host, the host key required to claim host.|**String**| |**pstnPasscode**|If required, the DTMF digits necessary to join a meeting via a phone dial in|**String**| +|**webJoinToken** |If a meeting is active, the token required to join via the web client.|**String**
_required_| |**dialInNumbers**|An array of DialInNumber objects|** DialInNumber** array| -# DialInNumber +# Meeting |Name|Description|Schema| |---|---|---|---| -|**countryCode**|Two character country code where the number resides|**String**
_required_| -|**number**|E.164 phone number which can be used to dial into the meeting|**String**
_required_| +|**id**|ID of the meeting|**String**
_required_| +|**active**|Whether the meeting is currently active|**Boolean**
_required_| +|**allowPublic** |Whether the meeting can be joined by non-members of the space|**Boolean**
_required_| +|**startTime** |The start date/time of the meeting |**Date**| +|**endTime** |The date/time the meeting ended |**Date**| +|**description**|A description for the meeting|**String**| +|**recordings**|An array of MeetingRecording objects. A new MeetingRecording is created each time a cloud recording is started in the meeting.|** MeetingRecording** array| +|**activeParticipants**|If a meeting is active, a PersonCollection representing the current Workspace users.|**PersonCollection**| +|**attendeesParticipants**|A PersonCollection representing the Workspace users who have attended the meeting.|**PersonCollection**| +|**space** |The Space where the meeting was held.|**Space**
_required_| +|**message** |A Message representing where in the Space transcript the meeting occurred. |**Message**| +|**joinInfo** |If a meeting is active, the details required to join the meeting |**JoinInfo**| + ## Example Request @@ -80,8 +118,9 @@ Body: query { meeting(spaceId: "space-id") { active - password joinInfo { + meetingNumber + password meetingProviderJoinUrl } } @@ -95,13 +134,14 @@ Body: "data": { "meeting": { "active": true, - "password": "53621872", "joinInfo": { - "meetingProviderJoinUrl": "https://zoom.us/j/240286814?pwd=vBRBlZBaXAKwIumekTziMw" + "password": "235253938", + "password": "53621872", + "meetingProviderJoinUrl": "https://zoom.us/j/235253938?pwd=vBRBlZBaXAKwIumekTziMw" } } } } ~~~~ -Try it out with our GraphQL tool - Get a meeting by space-id +Try it out with our GraphQL tool - Get a meeting by space-id diff --git a/guides/V1_Update_Meeting.md b/guides/V1_Update_Meeting_Settings.md similarity index 51% rename from guides/V1_Update_Meeting.md rename to guides/V1_Update_Meeting_Settings.md index f37a9b1..e3d8a64 100644 --- a/guides/V1_Update_Meeting.md +++ b/guides/V1_Update_Meeting_Settings.md @@ -1,6 +1,6 @@ --- copyright: 'Copyright IBM Corp. 2018' -link: 'update-meeting' +link: 'update-meeting-settings' is: 'experimental' --- @@ -8,38 +8,38 @@ is: 'experimental' ## Concepts -The _updateMeeting_ mutation allows the API caller to configure options on the meeting. The mutation accepts a Space ID (spaceId), and an allowPublic boolean as arguments, and makes the request on behalf of the caller, updating the meeting within the specified space. The result will reflect the whether the call was accepted for processing by the service. +The _updateMeetingSettings_ mutation allows the API caller to configure options on the meeting. The mutation accepts a Space ID (spaceId), and an allowPublic boolean as arguments, and makes the request on behalf of the caller, updating the meeting within the specified space. The result will reflect the whether the call was accepted for processing by the service. ## Schema -### Update Meeting Mutation +### Update Meeting Settings Mutation ```graphql type MutationRoot { ... - updateMeeting(input: UpdateMeetingInput!): MeetingMutationOutput + updateMeetingSettings(input: UpdateMeetingSettingsInput!): MeetingSettingsMutationOutput } -type UpdateMeetingInput { +type UpdateMeetingSettingsInput { spaceId: ID! - + allowPublic: Boolean! } -type MeetingMutationOutput { +type MeetingSettingsMutationOutput { accepted: Boolean! } ``` ## Field definitions -# UpdateMeetingInput +# UpdateMeetingSettingsInput |Name|Description|Schema| |---|---|---|---| |**spaceId**|Space ID of the space for which the meeting should be updated|**String**
_required_| |**allowPublic**|Whether or not non-space members can join meetings started in the space|**Boolean**
_required_| -# MeetingMutationOutput +# MeetingSettingsMutationOutput |Name|Description|Schema| |---|---|---|---| |**accepted**|Whether the request to update the meeting was accepted for processing|**Boolean**
_required_| @@ -54,7 +54,7 @@ Headers: 'Content-Type: application/graphql' , 'x-graphql-view: PUBLIC, EXPERIME Body: { mutation { - updateMeeting(input: {spaceId : "5ad0fabfe4b078066d690a24", allowPublic: true}) { + updateMeetingSettings(input: {spaceId : "5ad0fabfe4b078066d690a24", allowPublic: true}) { accepted } } @@ -65,11 +65,11 @@ Body: ~~~~ { "data": { - "updateMeeting": { + "updateMeetingSettings": { "accepted": "true" } } } ~~~~ -Try it out with our GraphQL tool - Update a meeting +Try it out with our GraphQL tool - Update meeting settings diff --git a/guides/V1_spaces_main.md b/guides/V1_spaces_main.md index 3d20f92..be6e46a 100644 --- a/guides/V1_spaces_main.md +++ b/guides/V1_spaces_main.md @@ -23,4 +23,4 @@ Watson Work Services represents a Space with this object. | members(before: String, after: String, first: Int, last: Int) | PersonCollection | The members of this space provided as a PersonCollection | membersUpdated | Date | The date the membership was updated | | conversation |Conversation | The conversation object for this space | -| activeMeeting | Meeting | Indicates that there is a meeting active within this space. Will only contain a sub-selection of all available meeting details, so this is suitable to use in a list view of spaces. This requires the `EXPERIMENTAL` value in `x-graphql-view header`. | +| activeMeeting | JoinInfo | Indicates that there is a meeting active within this space and includes the necessary information to join the meeting. This requires the `EXPERIMENTAL` value in `x-graphql-view header`. |