mahara-contributors team mailing list archive

Thread
Date

[Bug 1947533] Re: Only display web services groups with OAuth1/OAuth2 in 'External apps'

To: mahara-contributors@xxxxxxxxxxxxxxxxxxx
From: Dianne Tennent <1947533@xxxxxxxxxxxxxxxxxx>
Date: Mon, 10 Jan 2022 02:18:40 -0000
Reply-to: Bug 1947533 <1947533@xxxxxxxxxxxxxxxxxx>
Sender: noreply@xxxxxxxxxxxxx

** Description changed:

This is an issue discovered as part of bug #1947529 and slightly related
to bug #1947529.

At the moment, all web services groups that are set up in the web
services configuration are displayed on the 'External apps' screen even
if they aren't using OAuth1 or OAuth2. The 'External apps' screen should
only display those apps that can actually be used for the intended
purpose.

Therefore, we need a new Yes/No switch on the 'Edit' screen for a
service group to indicate whether it can be displayed in the drop-down
menu for 'External apps'.

This should go in the first section on the page
/webservice/admin/serviceconfig.php?service=ID

right below 'Short name' with the label 'External app'.

To replicate the issue:

1. Enable web services on your site.
2. Set up a new web services group in Admin menu -> Web services -> Configuration -> Manage services group -> Add a new one.
3. Enable it via the 'Edit' button and add one web service call to it.
4. Save.
5. Go to Admin menu -> Web services -> External apps.

Expected result: Only LTI, LTI Advantage, and Mahara / Moodle assignment
submission are potential options.

Actual result: The newly created web services group shows up, too.

What should happen when the issue is fixed:

1. Enable web services on your site.
2. Set up a new web services group 'Auth' in Admin menu -> Web services -> Configuration -> Manage services group -> Add a new one.
3. Enable it via the 'Edit' button.
4. There is a new option 'External app' with a Yes/No switch. Switch this to 'Yes'
5. Add one web service call to it and save the form.
5. Set up a new web services group 'Not auth' in Admin menu -> Web services -> Configuration -> Manage services group -> Add a new one.
6. Enable it via the 'Edit' button.
7. There is a new option 'External app' with a Yes/No switch. Leave this set to 'No'.
8. Add one web service call to it and save the form.
9. Go to Admin menu -> Web services -> External apps.

+ Further specs:
+ - For LTI, LTI Advantage, and Mahara / Moodle assignment, their 'Edit' pages must have the 'External app' switch set to 'Yes' by default
+ - Ideally, the 'External app' switch for these three services is greyed out (i.e. inactive, cannot be changed)
+
Expected result: The web services group 'Auth' is displayed in the drop-
down menu, but 'Not auth' is not shown.

This fix should be followed by bug #1947528

** Description changed:

This is an issue discovered as part of bug #1947529 and slightly related
to bug #1947529.

Therefore, we need a new Yes/No switch on the 'Edit' screen for a
service group to indicate whether it can be displayed in the drop-down
menu for 'External apps'.

This should go in the first section on the page
/webservice/admin/serviceconfig.php?service=ID

right below 'Short name' with the label 'External app'.

To replicate the issue:

Expected result: Only LTI, LTI Advantage, and Mahara / Moodle assignment
submission are potential options.

Actual result: The newly created web services group shows up, too.

What should happen when the issue is fixed:

Further specs:
- - For LTI, LTI Advantage, and Mahara / Moodle assignment, their 'Edit' pages must have the 'External app' switch set to 'Yes' by default
- - Ideally, the 'External app' switch for these three services is greyed out (i.e. inactive, cannot be changed)
+ - For LTI, LTI Advantage, and Mahara / Moodle assignment, their 'Edit' pages must have the 'External app' switch set to 'Yes' by default
+ - Ideally, the 'External app' switch for these three services is greyed out (i.e. inactive, cannot be changed)

- Expected result: The web services group 'Auth' is displayed in the drop-
- down menu, but 'Not auth' is not shown.
+ Expected result: The web services group 'Auth' (along with LTI, LTI
+ Advantage, and Mahara / Moodle assignment) is displayed in the drop-down
+ menu, but 'Not auth' is not shown.

This fix should be followed by bug #1947528

--
You received this bug notification because you are a member of Mahara
Contributors, which is subscribed to Mahara.
Matching subscriptions: mahara-contributors
https://bugs.launchpad.net/bugs/1947533

Title:
Only display web services groups with OAuth1/OAuth2 in 'External apps'

Status in Mahara:
Confirmed

Bug description:
This is an issue discovered as part of bug #1947529 and slightly
related to bug #1947529.

At the moment, all web services groups that are set up in the web
services configuration are displayed on the 'External apps' screen
even if they aren't using OAuth1 or OAuth2. The 'External apps' screen
should only display those apps that can actually be used for the
intended purpose.

Therefore, we need a new Yes/No switch on the 'Edit' screen for a
service group to indicate whether it can be displayed in the drop-down
menu for 'External apps'.

This should go in the first section on the page
/webservice/admin/serviceconfig.php?service=ID

right below 'Short name' with the label 'External app'.

To replicate the issue:

Expected result: Only LTI, LTI Advantage, and Mahara / Moodle
assignment submission are potential options.

Actual result: The newly created web services group shows up, too.

What should happen when the issue is fixed:

Further specs:
- For LTI, LTI Advantage, and Mahara / Moodle assignment, their 'Edit' pages must have the 'External app' switch set to 'Yes' by default
- Ideally, the 'External app' switch for these three services is greyed out (i.e. inactive, cannot be changed)

Expected result: The web services group 'Auth' (along with LTI, LTI
Advantage, and Mahara / Moodle assignment) is displayed in the drop-
down menu, but 'Not auth' is not shown.

This fix should be followed by bug #1947528

To manage notifications about this bug go to:
https://bugs.launchpad.net/mahara/+bug/1947533/+subscriptions

References

[Bug 1947533] [NEW] Only display web services groups with OAuth1/OAuth2 in 'External apps'
From: Kristina Hoeppner, 2021-10-18