Correct Job class method PHPDoc data types#47
Open
hhovakimyan wants to merge 2 commits intoNeverBounce:masterfrom
Open
Correct Job class method PHPDoc data types#47hhovakimyan wants to merge 2 commits intoNeverBounce:masterfrom
hhovakimyan wants to merge 2 commits intoNeverBounce:masterfrom
Conversation
The PHPDoc data types of Jobs class "create" method arguments are fixed: - $input argument can be as "string" type when creating a job from file URL, also an "array" type when creating job from supplied data. - $runsample, $autoparse, $autostart, $allowManualReview, $callbackUrl, $callbackHeaders arguments' PHPDocs are fixed to mention they are nullable arguments.
As mentioned in API documentation the job id is an `int32` type value, and so in PHP it is more correct to specify its data type as `int` and not `string`. So appropriate corrections are done in Job class methods receiving $jobId argument.
Author
|
@georgenov can you please take a look at these changes? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The PHPDoc data types of Jobs class "create" method arguments are
fixed:
file URL, also an "array" type when creating job from supplied data.
$callbackHeaders arguments' PHPDocs are fixed to mention they are
nullable arguments.
As mentioned in API documentation the job id is an
int32typevalue, and so in PHP it is more correct to specify its data type as
intand notstring. So appropriate corrections are done in Jobclass methods receiving $jobId argument.