Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-28650

Full web service documentation should be a lot easier to access for admin

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: 2.0, 2.1.1, 2.2
    • Fix Version/s: 2.0.5, 2.1.2
    • Component/s: Web Services
    • Labels:
    • Testing Instructions:
      Hide
      • Go to Admin block > Plugins > Web service
        You should see a Documentation page.
      • Go to Admin block > plugins > Web service > Manage service. Create a service, you should arrive to a page to add some functions. The function list of the documentation should contain all functions listed in this page.
      Show
      Go to Admin block > Plugins > Web service You should see a Documentation page. Go to Admin block > plugins > Web service > Manage service. Create a service, you should arrive to a page to add some functions. The function list of the documentation should contain all functions listed in this page.
    • Affected Branches:
      MOODLE_20_STABLE, MOODLE_21_STABLE, MOODLE_22_STABLE
    • Fixed Branches:
      MOODLE_20_STABLE, MOODLE_21_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-MDL-28650

      Description

      For admin creates a button that displays a full web service documentation. It is a big request of everybody. At the moment the only way to get a full documentation is:

      1- login as admin
      2- enable ws documentation into Web service > Manage Protocol
      3- create a service and add all functions to it
      4- give create_token capability to a none admin user
      5- login as this user
      6- access your Security Keys page and click on the documentation

        Attachments

          Activity

            People

            Assignee:
            jerome Jérôme Mouneyrac
            Reporter:
            jerome Jérôme Mouneyrac
            Peer reviewer:
            Dongsheng Cai
            Integrator:
            Eloy Lafuente (stronk7)
            Tester:
            Eloy Lafuente (stronk7)
            Participants:
            Component watchers:
            Juan Leyva, Amaia Anabitarte, Carlos Escobedo, Ferran Recio, Sara Arjona (@sarjona), Víctor Déniz Falcón
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Fix Release Date:
              10/Oct/11