lib/dor/services/client/accession.rb in dor-services-client-10.0.0 vs lib/dor/services/client/accession.rb in dor-services-client-10.1.0
- old
+ new
@@ -13,13 +13,13 @@
@object_identifier = object_identifier
end
# Start accession on an object (start specified workflow, assemblyWF by default, and version if needed)
# @param params [Hash<Symbol,String>] optional parameter hash
- # @option params [String] :significance set significance (major/minor/patch) of version change
- # @option params [String] :description set description of version change
- # @option params [String] :opening_user_name add opening username to the events datastream
- # @option params [String] :workflow the workflow to start (defaults to 'assemblyWF')
+ # @option params [String] :significance set significance (major/minor/patch) of version change - required
+ # @option params [String] :description set description of version change - required
+ # @option params [String] :opening_user_name add opening username to the events datastream - optional
+ # @option params [String] :workflow the workflow to start - defaults to 'assemblyWF'
# @return [Boolean] true on success
# @raise [NotFoundResponse] when the response is a 404 (object not found)
# @raise [UnexpectedResponse] when the response is not successful.
def start(params = {})
resp = connection.post do |req|