From def0b152a642c3fb92e900855c7df5d260bc5ab1 Mon Sep 17 00:00:00 2001 From: erickson Date: Fri, 26 Mar 2010 19:27:29 +0000 Subject: [PATCH] Bugfix: param should be params, and notes has issues. Notes cannot coexist well w/ signature desc (notes is ignored). git-svn-id: svn://svn.open-ils.org/ILS/trunk@16012 dcc99617-32d9-48b4-a31d-7c20da2025e4 --- .../src/perlmods/OpenILS/Application/Acq/EDI.pm | 8 +-- .../src/perlmods/OpenILS/Application/Acq/Order.pm | 18 ++--- .../src/perlmods/OpenILS/Application/Circ/Holds.pm | 76 +++++++++++----------- 3 files changed, 51 insertions(+), 51 deletions(-) diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Acq/EDI.pm b/Open-ILS/src/perlmods/OpenILS/Application/Acq/EDI.pm index 2e3bfe6c21..aebd43af85 100644 --- a/Open-ILS/src/perlmods/OpenILS/Application/Acq/EDI.pm +++ b/Open-ILS/src/perlmods/OpenILS/Application/Acq/EDI.pm @@ -58,10 +58,10 @@ __PACKAGE__->register_method( method => 'retrieve', api_name => 'open-ils.acq.edi.retrieve', signature => { - desc => 'Fetch incoming message(s) from EDI accounts. ' . - 'Optional arguments to restrict to one vendor and/or a max number of messages. ' . - 'Note that messages are not parsed or processed here, just fetched and translated.', - param => [ + desc => 'Fetch incoming message(s) from EDI accounts. ' . + 'Optional arguments to restrict to one vendor and/or a max number of messages. ' . + 'Note that messages are not parsed or processed here, just fetched and translated.', + params => [ {desc => 'Authentication token', type => 'string'}, {desc => 'Vendor ID (undef for "all")', type => 'number'}, {desc => 'Date Inactive Since', type => 'string'}, diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Acq/Order.pm b/Open-ILS/src/perlmods/OpenILS/Application/Acq/Order.pm index 2df2bab22a..3bea6cf1c4 100644 --- a/Open-ILS/src/perlmods/OpenILS/Application/Acq/Order.pm +++ b/Open-ILS/src/perlmods/OpenILS/Application/Acq/Order.pm @@ -2470,8 +2470,8 @@ __PACKAGE__->register_method( api_name => 'open-ils.acq.user_request.retrieve.by_user_id', stream => 1, signature => { - desc => 'Retrieve fleshed user requests and related data for a given user.', - param => [ + desc => 'Retrieve fleshed user requests and related data for a given user.', + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'User ID of the owner, or array of IDs', }, { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)', @@ -2490,8 +2490,8 @@ __PACKAGE__->register_method( api_name => 'open-ils.acq.user_request.retrieve.by_home_ou', stream => 1, signature => { - desc => 'Retrieve fleshed user requests and related data for a given org unit or units.', - param => [ + desc => 'Retrieve fleshed user requests and related data for a given org unit or units.', + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'Org unit ID, or array of IDs', }, { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)', @@ -2571,9 +2571,9 @@ __PACKAGE__->register_method ( api_name => 'open-ils.acq.user_request.cancel.batch', stream => 1, signature => { - desc => 'If given a cancel reason, will update the request with that reason, otherwise, this will delete the request altogether. The ' . - 'intention is for staff interfaces or processes to provide cancel reasons, and for patron interfaces to just delete the requests.' , - param => [ + desc => 'If given a cancel reason, will update the request with that reason, otherwise, this will delete the request altogether. The ' . + 'intention is for staff interfaces or processes to provide cancel reasons, and for patron interfaces to just delete the requests.' , + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'ID or array of IDs for the user requests to cancel' }, { desc => 'Cancel Reason ID (optional)', type => 'string' } @@ -2588,8 +2588,8 @@ __PACKAGE__->register_method ( api_name => 'open-ils.acq.user_request.set_no_hold.batch', stream => 1, signature => { - desc => 'Remove the hold from a user request or set of requests', - param => [ + desc => 'Remove the hold from a user request or set of requests', + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'ID or array of IDs for the user requests to modify' } ], diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm index 90716d9dc3..bad8946a3b 100644 --- a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm +++ b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm @@ -42,25 +42,25 @@ __PACKAGE__->register_method( method => "create_hold", api_name => "open-ils.circ.holds.create", signature => { - desc => "Create a new hold for an item. From a permissions perspective, " . - "the login session is used as the 'requestor' of the hold. " . - "The hold recipient is determined by the 'usr' setting within the hold object. ", - param => [ + desc => "Create a new hold for an item. From a permissions perspective, " . + "the login session is used as the 'requestor' of the hold. " . + "The hold recipient is determined by the 'usr' setting within the hold object. " . + 'First we verify the requestor has holds request permissions. ' . + 'Then we verify that the recipient is allowed to make the given hold. ' . + 'If not, we see if the requestor has "override" capabilities. If not, ' . + 'a permission exception is returned. If permissions allow, we cycle ' . + 'through the set of holds objects and create. ' . + 'If the recipient does not have permission to place multiple holds ' . + 'on a single title and said operation is attempted, a permission ' . + 'exception is returned', + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'Hold object for hold to be created', type => 'object' } ], return => { desc => 'Undef on success, -1 on missing arg, event (or ref to array of events) on error(s)', }, - }, - notes => 'First we verify the requestor has holds request permissions. ' . - 'Then we verify that the recipient is allowed to make the given hold. ' . - 'If not, we see if the requestor has "override" capabilities. If not, ' . - 'a permission exception is returned. If permissions allow, we cycle ' . - 'through the set of holds objects and create. ' . - 'If the recipient does not have permission to place multiple holds ' . - 'on a single title and said operation is attempted, a permission ' . - 'exception is returned' + } ); __PACKAGE__->register_method( @@ -70,7 +70,7 @@ __PACKAGE__->register_method( signature => { desc => "If the recipient is not allowed to receive the requested hold, " . "call this method to attempt the override", - param => [ + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'Hold object for hold to be created', type => 'object' } ], @@ -255,8 +255,8 @@ __PACKAGE__->register_method( method => "retrieve_holds_by_id", api_name => "open-ils.circ.holds.retrieve_by_id", signature => { - desc => "Retrieve the hold, with hold transits attached, for the specified ID. $ses_is_req_note", - param => [ + desc => "Retrieve the hold, with hold transits attached, for the specified ID. $ses_is_req_note", + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'Hold ID', type => 'number' } ], @@ -294,8 +294,8 @@ __PACKAGE__->register_method( method => "retrieve_holds", api_name => "open-ils.circ.holds.retrieve", signature => { - desc => "Retrieves all the holds, with hold transits attached, for the specified user. $ses_is_req_note", - param => [ + desc => "Retrieves all the holds, with hold transits attached, for the specified user. $ses_is_req_note", + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'User ID', type => 'integer' } ], @@ -310,8 +310,8 @@ __PACKAGE__->register_method( api_name => "open-ils.circ.holds.id_list.retrieve", authoritative => 1, signature => { - desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note", - param => [ + desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note", + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'User ID', type => 'integer' } ], @@ -326,8 +326,8 @@ __PACKAGE__->register_method( api_name => "open-ils.circ.holds.canceled.retrieve", authoritative => 1, signature => { - desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note", - param => [ + desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note", + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'User ID', type => 'integer' } ], @@ -342,8 +342,8 @@ __PACKAGE__->register_method( api_name => "open-ils.circ.holds.canceled.id_list.retrieve", authoritative => 1, signature => { - desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note", - param => [ + desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note", + params => [ { desc => 'Authentication token', type => 'string' }, { desc => 'User ID', type => 'integer' } ], @@ -653,8 +653,8 @@ __PACKAGE__->register_method( method => "update_hold", api_name => "open-ils.circ.hold.update", signature => { - desc => "Updates the specified hold. $update_hold_desc", - param => [ + desc => "Updates the specified hold. $update_hold_desc", + params => [ {desc => 'Authentication token', type => 'string'}, {desc => 'Hold Object', type => 'object'}, {desc => 'Hash of values to be applied', type => 'object'} @@ -671,8 +671,8 @@ __PACKAGE__->register_method( api_name => "open-ils.circ.hold.update.batch", stream => 1, signature => { - desc => "Updates the specified hold(s). $update_hold_desc", - param => [ + desc => "Updates the specified hold(s). $update_hold_desc", + params => [ {desc => 'Authentication token', type => 'string'}, {desc => 'Array of hold obejcts', type => 'array' }, {desc => 'Array of hashes of values to be applied', type => 'array' } @@ -1063,9 +1063,9 @@ __PACKAGE__->register_method( method => "hold_pull_list", api_name => "open-ils.circ.hold_pull_list.retrieve", signature => { - desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' . - 'The location is determined by the login session.', - param => [ + desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' . + 'The location is determined by the login session.', + params => [ { desc => 'Limit (optional)', type => 'number'}, { desc => 'Offset (optional)', type => 'number'}, ], @@ -1079,9 +1079,9 @@ __PACKAGE__->register_method( method => "hold_pull_list", api_name => "open-ils.circ.hold_pull_list.id_list.retrieve", signature => { - desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' . - 'The location is determined by the login session.', - param => [ + desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' . + 'The location is determined by the login session.', + params => [ { desc => 'Limit (optional)', type => 'number'}, { desc => 'Offset (optional)', type => 'number'}, ], @@ -1095,9 +1095,9 @@ __PACKAGE__->register_method( method => "hold_pull_list", api_name => "open-ils.circ.hold_pull_list.retrieve.count", signature => { - desc => 'Returns a count of holds that need to be "pulled" by a given location. ' . - 'The location is determined by the login session.', - param => [ + desc => 'Returns a count of holds that need to be "pulled" by a given location. ' . + 'The location is determined by the login session.', + params => [ { desc => 'Limit (optional)', type => 'number'}, { desc => 'Offset (optional)', type => 'number'}, ], @@ -1497,7 +1497,7 @@ __PACKAGE__->register_method( 'The named paramaters of the second argument include: ' . 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' . 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' , - param => [ + params => [ { desc => 'Authentication token', type => 'string'}, { desc => 'Hash of named parameters', type => 'object'}, ], -- 2.11.0