Moodle
  1. Moodle
  2. MDL-37143

External_warnings: developer should be able to modify the item/itemid/errorcode description

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.5
    • Fix Version/s: 2.5
    • Component/s: Web Services
    • Labels:
    • Testing Instructions:
      Hide

      Go to Admin > Plugins > Web service > API documentation
      Check that the description of item/itemid/warningcode is explicit for the warnings of:

      • mod_assign_get_assignments()
      • mod_assign_get_grades()
      Show
      Go to Admin > Plugins > Web service > API documentation Check that the description of item/itemid/warningcode is explicit for the warnings of: mod_assign_get_assignments() mod_assign_get_grades()
    • Affected Branches:
      MOODLE_25_STABLE
    • Fixed Branches:
      MOODLE_25_STABLE
    • Pull Master Branch:
      MDL-37143-master
    • Rank:
      46713

      Description

      Example: mod/assign/externallib - get_grades()
      item => assignement
      itemid => assignement->id

      Till the client dev call the function and generate a warnings, it doesn't what's return by item/itemid.

        Activity

        Hide
        Frédéric Massart added a comment -

        Hi Jerome,

        It's a good thing that we can now describe what are the meaning of those arguments. Although I am not sure it would be easily readable if there are many possible warnings and error codes, but I don't have any other idea.

        Push for integration whenever you like.

        Cheers,
        Fred

        Show
        Frédéric Massart added a comment - Hi Jerome, It's a good thing that we can now describe what are the meaning of those arguments. Although I am not sure it would be easily readable if there are many possible warnings and error codes, but I don't have any other idea. Push for integration whenever you like. Cheers, Fred
        Hide
        Jérôme Mouneyrac added a comment -

        Thanks Fred for the review. I'm happy like that, it's simple to define, and I think it looks good and clear on the generated web service documentation. At the end if people use a lot of warnings, any documentation will always look big.

        Note for integrator: I thought to build some description template but the way that assign methods used warnings (not as I expected) convinced me that flexible description was the way to go.

        Show
        Jérôme Mouneyrac added a comment - Thanks Fred for the review. I'm happy like that, it's simple to define, and I think it looks good and clear on the generated web service documentation. At the end if people use a lot of warnings, any documentation will always look big. Note for integrator: I thought to build some description template but the way that assign methods used warnings (not as I expected) convinced me that flexible description was the way to go.
        Hide
        Dan Poltawski added a comment -

        Integrated, thanks Jerome.

        Show
        Dan Poltawski added a comment - Integrated, thanks Jerome.
        Show
        Jérôme Mouneyrac added a comment - Thanks Dan, I updated http://docs.moodle.org/dev/Errors_handling_in_web_services#Format
        Hide
        Rajesh Taneja added a comment -

        Thanks Jerome,

        Description is different for item, itemid and warningcode.

        FYI: Updated test instructions errorcode => warningcode.

        Show
        Rajesh Taneja added a comment - Thanks Jerome, Description is different for item, itemid and warningcode. FYI: Updated test instructions errorcode => warningcode.
        Hide
        Dan Poltawski added a comment -

        Hurray! We did it! Thanks to all the reporters, testers, user and watchers for a bumper week of Moodling!

        Show
        Dan Poltawski added a comment - Hurray! We did it! Thanks to all the reporters, testers, user and watchers for a bumper week of Moodling!

          People

          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: