383850 - email_in.pl documentation does not contain all required fields for new bug creation

Status: RESOLVED FIXED

(Bugzilla :: Incoming Email, defect)

Description

[Daniel]

User-Agent:       Mozilla/5.0 (Windows NT 6.0; U; en; rv:1.8.0) Gecko/20060728 Firefox/1.5.0 Opera 9.21
Build Identifier: version 3.0

http://www.bugzilla.org/docs/3.0/html/api/email_in.html
The documentation reads "The script expects to read an email with the following format:"
Then proceeds to list several required fields. However, there are two which are not listed which are required for the script to work.
@op_sys and @rep_platform

the documentation should be updated to reflect this

Reproducible: Always

Steps to Reproduce:
1. copy the example in the documentation into a file and modify as necessary
2. cat file | /path/to/email_in.pl



Expected Results:  
Got somewhat cryptic error messages in that they didn't tell me what the field names missing ought to be.
Missing op_sys => A legal OS/Version was not set.
Missing rep_platform => A legal Platform was not set.

Should have said: A legal OS/Version was not set. (@op_sys missing)
A legal Platform was not set. (@rep_platform missing)

Comment 1

[Daniel]

I missed one. @version is also required.

Comment 2

[Max Kanat-Alexander]

It should probably link to the documentation for WebService::Bug::create, because that lists all the required fields.

Comment 3

[fedor ezeev]

(In reply to comment #0)
> Reproducible: Always
Probably you have not set a default values for this parameters?
Parameters - Bug fields:
defaultpriority, defaultseverity, defaultplatform and defaultopsys.

Set this to your preferences and the code

    $fields{'rep_platform'} ||= Bugzilla->params->{'defaultplatform'};
    $fields{'op_sys'}   ||= Bugzilla->params->{'defaultopsys'};
    $fields{'priority'} ||= Bugzilla->params->{'defaultpriority'};
    $fields{'bug_severity'} ||= Bugzilla->params->{'defaultseverity'};

in email_in.pl::post_bug() will work for you.

Comment 4

[fedor ezeev]

Attachment: proposed patch for documentation

Comment 5

[Max Kanat-Alexander]

Comment on attachment 288534 [details] [diff] [review]
proposed patch for documentation

That's not true. It doesn't show all the required fields. Also, you don't *have* to set the parameters, if you set them. This is described fairly well at:

http://www.bugzilla.org/docs/3.0/html/api/Bugzilla/WebService/Bug.html#create

Comment 6

[fedor ezeev]

Attachment: proposed patch for documentation v.2

Unfortunately, I don't know, how to link to the anchor inside the documentation, so I link to the whole page with a point to the article name.

BTW, there are many of blind links in the api docs. Is it a blank for future? Or they needs to be fixed?

Comment 7

[Max Kanat-Alexander]

Comment on attachment 289314 [details] [diff] [review]
proposed patch for documentation v.2

>+L<Bugzilla::WebService::Bug>, "Create" article. For the list of all 

  You can do L<Bugzilla::WebService::Bug/create>. Except that some of the names of the input fields there are different than the input fields for email_in, unfortunately, so if any are different, you'll have to note that here.

Comment 8

[fedor ezeev]

Attachment: v.3

I hope, that there is no need to point again to the difference between "summary" vs. "Subject" and "description" vs. main mail text :)

Comment 9

[Max Kanat-Alexander]

Comment on attachment 291689 [details] [diff] [review]
v.3


>+C<platform> in web is C<@rep_platform> label in email

  Just remove "label"

>+C<severity> in web is C<@bug_severity> label in email

  And here too.

  We can fix that on checkin.

Comment 10

[fedor ezeev]

Attachment: v.4

On the safe side, here is the patch without "label" words.

Comment 11

[Frédéric Buclin]

tip:

Checking in email_in.pl;
/cvsroot/mozilla/webtools/bugzilla/email_in.pl,v  <--  email_in.pl
new revision: 1.11; previous revision: 1.10
done

3.0.2:

Checking in email_in.pl;
/cvsroot/mozilla/webtools/bugzilla/email_in.pl,v  <--  email_in.pl
new revision: 1.5.2.4; previous revision: 1.5.2.3
done