Hi Krishantha,

Please note the finalized method list.

Thx Chan for quick feedback.


On Tue, May 13, 2014 at 7:44 AM, Chan <[email protected]> wrote:

> My comments are inline. As for the overall method selection I am +1.
>
> Cheers~
>
>
> On Tue, May 13, 2014 at 7:34 AM, Malaka Silva <[email protected]> wrote:
>
>> Hi All,
>>
>> There are 100+ methods available. Since we cannot have all for this
>> version I'm suggesting the following.
>>
>> @Chan since you have experience with working with the api let us know
>> your feedback with method selection?
>>
>> Method summary suggesting.
>>
>> *Git Data*
>>
>> getBlob                 - Retrieves a blob.
>> createBlob              - Uploads a blob.
>> getACommit
>> createCommit            - Creates a comment.
>> getATags
>>
>
> ​This should be getATag (since it's singular). ​
>
>
>>
>> *Issues*
>>
>> listRepositoryIssues    - Lists issues for a repository.
>> getIssue                - Retrieves a single issue.
>> createIssue             - Any user with pull access to a repository can
>> create an
>> issue.
>> editIssue               - Issue owners and users with push access can
>> edit an issue.
>> listIssueComments       - This lists comments on an issue.
>> createIssueComment      - Allows to create a comment on an issue.
>>
>>
>> *Repositories*
>>
>> ListForks
>> Perform a merge
>>
>
> ​Proper error handling should be done for this since merging conflicts are
> normal in git. ​
>
>
>
>> List collaborators
>>
>> *Pull Requests*
>>
>> listPullRequests        - Lists all the pull requests.
>> getPullRequest          - Retrieves a single pull request.
>> listPullRequestCommits  - It list commits on a pull request.
>> getMergeStatus          - Retrieve the status as to if a pull request has
>> been
>> merged.
>> mergePullRequest        - This merges a pull request.
>>
>
> ​If the PR cannot be directly merge due to conflicts - the PR will fail.
> This also has to be handled gracefully.
>
>
>
>>
>> *Search*
>>
>> searchIssues            - Find issues by state and keyword. (This method
>> returns up to
>> 100 results per page.)
>>
>> *Users*
>>
>> getUser                 - Retrieves a single user
>>
>> *Activity*
>>
>> getnotifications
>> getRepositoryNotifications
>>
>>
>> On Mon, May 12, 2014 at 8:36 AM, Malaka Silva <[email protected]> wrote:
>>
>>> Hi Chan,
>>>
>>> Thx for your feedback.
>>>
>>> Yes there are quite a lot methods in the api. But we have limited set
>>> for this version.
>>>
>>> We have focused more on issues and pull requests for this version.
>>>
>>> Do you foresee a scenario with those methods? Also let us know if we
>>> missed anything else?
>>>
>>> Best Regards,
>>> Malaka
>>>
>>>
>>> On Mon, May 12, 2014 at 7:40 AM, Chan <[email protected]> wrote:
>>>
>>>> Hi folks,
>>>> As a person who has worked with the Github API, I think few important
>>>> methods are not covered -
>>>>
>>>>    - get a tags -https://developer.github.com/v3/git/tags/#get-a-tag
>>>>    - get a commit -
>>>>    https://developer.github.com/v3/git/commits/#get-a-commit
>>>>
>>>>
>>>>  Cheers~
>>>>
>>>>
>>>> On Thu, May 8, 2014 at 4:51 PM, Malaka Silva <[email protected]> wrote:
>>>>
>>>>> Hi,
>>>>>
>>>>> Since there are 100+ methods available with api we will go ahead with
>>>>> this methods selection for this version.
>>>>>
>>>>> Best Regards,
>>>>> Malaka
>>>>>
>>>>>
>>>>> On Thu, May 8, 2014 at 9:03 AM, Malaka Silva <[email protected]> wrote:
>>>>>
>>>>>>
>>>>>> Hi,
>>>>>>
>>>>>> In my opinion this only covers subset of modules.
>>>>>>
>>>>>> If we compare this with other connector vendors this does not contain
>>>>>> enough method coverage.
>>>>>>
>>>>>> Others can also add your thoughts?
>>>>>>
>>>>>>
>>>>>>  On Tue, Apr 29, 2014 at 5:52 PM, krishantha <[email protected]>wrote:
>>>>>>
>>>>>>> Introduction
>>>>>>>
>>>>>>> GitHub is a web-based hosting service for software development
>>>>>>> projects that
>>>>>>> use the Git revision control system. GitHub offers both paid plans
>>>>>>> for
>>>>>>> private repositories, and free accounts for open source projects.
>>>>>>>
>>>>>>> API
>>>>>>>
>>>>>>> https://developer.github.com/v3/
>>>>>>>
>>>>>>> GitHub Connector Summery
>>>>>>>
>>>>>>> • Connector Name:  GitHub-connector-1.0.0
>>>>>>> • Version: 1.0.0
>>>>>>> • Technology:  REST
>>>>>>>
>>>>>>> Authentication
>>>>>>>
>>>>>>> GitHub use oAuth2 based access token
>>>>>>>
>>>>>>> Method summary
>>>>>>>
>>>>>>> Git Data
>>>>>>>
>>>>>>> getBlob                 - Retrieves a blob.
>>>>>>> createBlob              - Uploads a blob.
>>>>>>> createCommit            - Creates a comment.
>>>>>>>
>>>>>>>
>>>>>>> Issues
>>>>>>>
>>>>>>> listRepositoryIssues    - Lists issues for a repository.
>>>>>>> getIssue                - Retrieves a single issue.
>>>>>>> createIssue             - Any user with pull access to a repository
>>>>>>> can create an
>>>>>>> issue.
>>>>>>> editIssue               - Issue owners and users with push access
>>>>>>> can edit an issue.
>>>>>>> listIssueAssignees      - This call lists all the available
>>>>>>> assignees (owner +
>>>>>>> collaborators) to which issues may be assigned.
>>>>>>> listIssueComments       - This lists comments on an issue.
>>>>>>> createIssueComment      - Allows to create a comment on an issue.
>>>>>>> editIssueComment        - Allows to edit a comment on an issue.
>>>>>>> deleteIssueComment      - Allows to delete a comment on an issue.
>>>>>>>
>>>>>>> Pull Requests
>>>>>>>
>>>>>>> listPullRequests        - Lists all the pull requests.
>>>>>>> getPullRequest          - Retrieves a single pull request.
>>>>>>> createPullRequest       - Creates a pull request.
>>>>>>> updatePullRequest       - Updates a pull request.
>>>>>>> listPullRequestCommits  - It list commits on a pull request.
>>>>>>> listPullRequestsFiles   - This lists pull request files.
>>>>>>> getMergeStatus          - Retrieve the status as to if a pull
>>>>>>> request has been
>>>>>>> merged.
>>>>>>> mergePullRequest        - This merges a pull request.
>>>>>>>
>>>>>>> Search
>>>>>>>
>>>>>>> searchIssues            - Find issues by state and keyword. (This
>>>>>>> method returns up to
>>>>>>> 100 results per page.)
>>>>>>>
>>>>>>> Users
>>>>>>>
>>>>>>> getUser                 - Retrieves a single user
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> View this message in context:
>>>>>>> http://wso2-oxygen-tank.10903.n7.nabble.com/Connector-github-tp95932.html
>>>>>>> Sent from the WSO2 Architecture mailing list archive at Nabble.com.
>>>>>>> _______________________________________________
>>>>>>> Architecture mailing list
>>>>>>> [email protected]
>>>>>>> https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
>>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>> --
>>>>>>
>>>>>> Best Regards,
>>>>>>
>>>>>> Malaka Silva
>>>>>> Senior Tech Lead
>>>>>> M: +94 777 219 791
>>>>>> Tel : 94 11 214 5345
>>>>>> Fax :94 11 2145300
>>>>>> Skype : malaka.sampath.silva
>>>>>> LinkedIn : http://www.linkedin.com/pub/malaka-silva/6/33/77
>>>>>> Blog : http://mrmalakasilva.blogspot.com/
>>>>>>
>>>>>> WSO2, Inc.
>>>>>> lean . enterprise . middleware
>>>>>> http://www.wso2.com/
>>>>>> http://www.wso2.com/about/team/malaka-silva/<http://wso2.com/about/team/malaka-silva/>
>>>>>>
>>>>>> Save a tree -Conserve nature & Save the world for your future. Print
>>>>>> this email only if it is absolutely necessary.
>>>>>>
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>>
>>>>> Best Regards,
>>>>>
>>>>> Malaka Silva
>>>>> Senior Tech Lead
>>>>> M: +94 777 219 791
>>>>> Tel : 94 11 214 5345
>>>>> Fax :94 11 2145300
>>>>> Skype : malaka.sampath.silva
>>>>> LinkedIn : http://www.linkedin.com/pub/malaka-silva/6/33/77
>>>>> Blog : http://mrmalakasilva.blogspot.com/
>>>>>
>>>>> WSO2, Inc.
>>>>> lean . enterprise . middleware
>>>>> http://www.wso2.com/
>>>>> http://www.wso2.com/about/team/malaka-silva/<http://wso2.com/about/team/malaka-silva/>
>>>>>
>>>>> Save a tree -Conserve nature & Save the world for your future. Print
>>>>> this email only if it is absolutely necessary.
>>>>>
>>>>> _______________________________________________
>>>>> Architecture mailing list
>>>>> [email protected]
>>>>> https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
>>>>>
>>>>>
>>>>
>>>>
>>>> --
>>>> Chan (Dulitha Wijewantha)
>>>> Software Engineer - Mobile Development
>>>>  WSO2Mobile
>>>> Lean.Enterprise.Mobileware
>>>>  * ~Email       [email protected] <[email protected]>*
>>>> *  ~Mobile     +94712112165 <%2B94712112165>*
>>>> *  ~Website   dulitha.me <http://dulitha.me>*
>>>> *  ~Twitter     @dulitharw <https://twitter.com/dulitharw>*
>>>>   *~Github     @dulichan <https://github.com/dulichan>*
>>>>   *~SO     @chan <http://stackoverflow.com/users/813471/chan>*
>>>>
>>>> _______________________________________________
>>>> Architecture mailing list
>>>> [email protected]
>>>> https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
>>>>
>>>>
>>>
>>>
>>> --
>>>
>>> Best Regards,
>>>
>>> Malaka Silva
>>> Senior Tech Lead
>>> M: +94 777 219 791
>>> Tel : 94 11 214 5345
>>> Fax :94 11 2145300
>>> Skype : malaka.sampath.silva
>>> LinkedIn : http://www.linkedin.com/pub/malaka-silva/6/33/77
>>> Blog : http://mrmalakasilva.blogspot.com/
>>>
>>> WSO2, Inc.
>>> lean . enterprise . middleware
>>> http://www.wso2.com/
>>> http://www.wso2.com/about/team/malaka-silva/<http://wso2.com/about/team/malaka-silva/>
>>>
>>> Save a tree -Conserve nature & Save the world for your future. Print
>>> this email only if it is absolutely necessary.
>>>
>>
>>
>>
>> --
>>
>> Best Regards,
>>
>> Malaka Silva
>> Senior Tech Lead
>> M: +94 777 219 791
>> Tel : 94 11 214 5345
>> Fax :94 11 2145300
>> Skype : malaka.sampath.silva
>> LinkedIn : http://www.linkedin.com/pub/malaka-silva/6/33/77
>> Blog : http://mrmalakasilva.blogspot.com/
>>
>> WSO2, Inc.
>> lean . enterprise . middleware
>> http://www.wso2.com/
>> http://www.wso2.com/about/team/malaka-silva/<http://wso2.com/about/team/malaka-silva/>
>>
>> Save a tree -Conserve nature & Save the world for your future. Print this
>> email only if it is absolutely necessary.
>>
>
>
>
> --
> Chan (Dulitha Wijewantha)
> Software Engineer - Mobile Development
> WSO2Mobile
> Lean.Enterprise.Mobileware
>  * ~Email       [email protected] <[email protected]>*
> *  ~Mobile     +94712112165 <%2B94712112165>*
> *  ~Website   dulitha.me <http://dulitha.me>*
> *  ~Twitter     @dulitharw <https://twitter.com/dulitharw>*
>   *~Github     @dulichan <https://github.com/dulichan>*
>   *~SO     @chan <http://stackoverflow.com/users/813471/chan>*
>



-- 

Best Regards,

Malaka Silva
Senior Tech Lead
M: +94 777 219 791
Tel : 94 11 214 5345
Fax :94 11 2145300
Skype : malaka.sampath.silva
LinkedIn : http://www.linkedin.com/pub/malaka-silva/6/33/77
Blog : http://mrmalakasilva.blogspot.com/

WSO2, Inc.
lean . enterprise . middleware
http://www.wso2.com/
http://www.wso2.com/about/team/malaka-silva/<http://wso2.com/about/team/malaka-silva/>

Save a tree -Conserve nature & Save the world for your future. Print this
email only if it is absolutely necessary.
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to