PowerPlatformConnectors icon indicating copy to clipboard operation
PowerPlatformConnectors copied to clipboard

Proposal - GitHub Repo Files (Independent Publisher)

Open Nathalie-Leenders opened this issue 11 months ago • 12 comments


When submitting a connector, please make sure that you follow the requirements below, otherwise your PR might be rejected. We want to make you have a well-built connector, a smooth certification experience, and your users are happy :)

If this is your first time submitting to GitHub and you need some help, please sign up for this session.

  • [X ] I attest that the connector doesn't exist on the Power Platform today. I've verified by checking the pull requests in GitHub and by searching for the connector on the platform or in the documentation.
  • [ X] I attest that the connector works and I verified by deploying and testing all the operations.
  • [ X] I attest that I have added detailed descriptions for all operations and parameters in the swagger file.
  • [ X] I attest that I have added response schemas to my actions, unless the response schema is dynamic.
  • [ X] I validated the swagger file, apiDefinition.swagger.json, by running paconn validate command.
  • [X ] If this is a certified connector, I confirm that apiProperties.json has a valid brand color and doesn't use an invalid brand color, #007ee5 or #ffffff. If this is an independent publisher connector, I confirm that I am not submitting a connector icon.

If you are an Independent Publisher, you must also attest to the following to ensure a smooth publishing process:

  • [X ] I have named this PR after the pattern of "Connector Name (Independent Publisher)" ex: HubSpot Marketing (Independent Publisher)
  • [ ] Within this PR markdown file, I have pasted screenshots that show: 3 unique operations (actions/triggers) working within a Flow. This can be in one flow or part of multiple flows. For each one of those flows, I have pasted in screenshots of the Flow succeeding.
  • [ X] Within this PR markdown file, I have pasted in a screenshot from the Test operations section within the Custom Connector UI.
  • Githubdatarunsusccesful
  • [ N/A] If the connector uses OAuth, I have provided detailed steps on how to create an app in the readme.md.

Nathalie-Leenders avatar Mar 09 '24 16:03 Nathalie-Leenders

@microsoft-github-policy-service agree [company="{none}"]

Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: microsoft-github-policy-service[bot] @.> Sent: Saturday, March 9, 2024 8:53:18 AM To: microsoft/PowerPlatformConnectors @.> Cc: Nathalie Leenders @.>; Mention @.> Subject: Re: [microsoft/PowerPlatformConnectors] Requesting new custom connector - github as a datasource (PR #3290)

@Nathalie-Leendershttps://github.com/Nathalie-Leenders please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.orghttp://www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
  3. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/PowerPlatformConnectors/pull/3290#issuecomment-1986915903, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A3N5N4PKGMSKADNPH64NNRTYXM475AVCNFSM6AAAAABEOHSGHWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBWHEYTKOJQGM. You are receiving this because you were mentioned.Message ID: @.***>

Nathalie-Leenders avatar Mar 09 '24 17:03 Nathalie-Leenders

@microsoft-github-policy-service agree

Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: microsoft-github-policy-service[bot] @.> Sent: Saturday, March 9, 2024 9:07:50 AM To: microsoft/PowerPlatformConnectors @.> Cc: Nathalie Leenders @.>; Mention @.> Subject: Re: [microsoft/PowerPlatformConnectors] Requesting new custom connector - github as a datasource (PR #3290)

@Nathalie-Leendershttps://github.com/Nathalie-Leenders the command you issued was incorrect. Please try again.

Examples are:

@microsoft-github-policy-service agree

and

@microsoft-github-policy-service agree company="your company"

— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/PowerPlatformConnectors/pull/3290#issuecomment-1986919239, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A3N5N4PWZXKYIBCECSDJRZLYXM6WNAVCNFSM6AAAAABEOHSGHWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBWHEYTSMRTHE. You are receiving this because you were mentioned.Message ID: @.***>

Nathalie-Leenders avatar Mar 09 '24 17:03 Nathalie-Leenders

Hi!

I did, what is missing from the request? It's my first time so I probably did something wrong somewhere.

I appreciate any help you can provide.

Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: vmanoharas @.> Sent: Tuesday, March 12, 2024 7:45:18 AM To: microsoft/PowerPlatformConnectors @.> Cc: Nathalie Leenders @.>; Mention @.> Subject: Re: [microsoft/PowerPlatformConnectors] Requesting new custom connector - github as a datasource (PR #3290)

@vmanoharas commented on this pull request.

Hello @Nathalie-Leendershttps://github.com/Nathalie-Leenders,

Can you please go through this document and submit your Independent Publisher Connector?

https://learn.microsoft.com/en-us/connectors/custom-connectors/certification-submission-ip

— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/PowerPlatformConnectors/pull/3290#pullrequestreview-1931283671, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A3N5N4NYS75S6KO4AW5RWKTYX4IH5AVCNFSM6AAAAABEOHSGHWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTSMZRGI4DGNRXGE. You are receiving this because you were mentioned.Message ID: @.***>

Nathalie-Leenders avatar Mar 12 '24 14:03 Nathalie-Leenders

Hi @Nathalie-Leenders, Greetings from the airport. Let me try to assist with some suggested changes to resolve issues I see in your submitted PR:

  • Please change your PR title to Proposal - GitHub Repo Files (Independent Publisher).
  • When you believe all issues have been resolved, remove Proposal - from the title.
  • In apiProperties.json, please change: -- Per the February change for OAuth, please update the redirect Model to GlobalPerConnector. The following line 11 for redirectURL is then unnecessary. -- Please change the OAuth identity provider to github, as found in the fourth example here -- Please change stackOwner to GitHub, Inc. -- Remove the closing curly bracket on the final line and reformat file to correct JSON tab spacing.
  • In apiDefinition.swagger.json, please change: -- For all strings, double quotation marks (") are used, not single quotation marks('). Please change all. -- There is a mix of YAML and JSON in this file. All JSON object key lines do not start with "- ", e.g. line 36: - "name": ... Also, all JSON object lines need to end with a comma. The pac CLI should have caught those errors, but I would suggest VS Code or an online JSON validator to fix issues. -- Line 19 for consumes should be an array with the single item application/json. The following produces also needs to be an array. -- The current line 23 has an unused action path - this must be removed. -- Your action path is set to require both folder name and folder name 2 - If you want both (or neither?), you could create separate actions. Path parameters are always required based on the defined path. -- Your path parameters need to include both both x-ms-summary and description. Please review this doc. -- Your response needs to be changed from default to 200. The description can stay the same, and since the response is the markdown file content, you can change the schema to string. -- At the end of the file, you must also include the connector metadata

After you make those changes and include them in your branch, please let me know and I can review again.

CC: @ShefaaliP

troystaylor avatar Mar 16 '24 03:03 troystaylor

@troystaylor I have made changes to the files, can you please help in checking if they're ok now?

Nathalie-Leenders avatar Mar 19 '24 16:03 Nathalie-Leenders

Hello @Nathalie-Leenders,

I am following up on this PR, kindly resolve review comments mentioned by Troy.

vmanoharas avatar Jun 19 '24 14:06 vmanoharas

Hello @Nathalie-Leenders,

I am following up on this PR, kindly resolve review comments mentioned by Troy.

@Nathalie-Leenders, I am happy to collaborate on this connector to resolve the comments if you need assistance.

troystaylor avatar Jun 19 '24 14:06 troystaylor

Hi all,

Thank you! Due to life getting crazy busy I had to put this one on the backburner, I will definitely retry in getting my manifest ok and reach out to you Troy if I need any help (which I'm pretty sure I will, but will let you know) Thanks again for following up

Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: Troy Taylor @.> Sent: Wednesday, June 19, 2024 4:43:37 PM To: microsoft/PowerPlatformConnectors @.> Cc: Nathalie Leenders @.>; Mention @.> Subject: Re: [microsoft/PowerPlatformConnectors] Proposal - GitHub Repo Files (Independent Publisher) (PR #3290)

Hello @Nathalie-Leendershttps://github.com/Nathalie-Leenders,

I am following up on this PR, kindly resolve review comments mentioned by Troy.

@Nathalie-Leendershttps://github.com/Nathalie-Leenders, I am happy to collaborate on this connector to resolve the comments if you need assistance.

— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/PowerPlatformConnectors/pull/3290#issuecomment-2178886645, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A3N5N4PHWXZOPNJ42Q2Y4NLZIGKJTAVCNFSM6AAAAABEOHSGHWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZYHA4DMNRUGU. You are receiving this because you were mentioned.Message ID: @.***>

Nathalie-Leenders avatar Jun 19 '24 15:06 Nathalie-Leenders

Hi @troystaylor and @vmanoharas I think I got it (or at least visual studio code copilot helped) I really hope this is OK, can you please check for me? 🙏 I really appreciate the help, this is really not my forte

Nathalie-Leenders avatar Jun 20 '24 13:06 Nathalie-Leenders

Hi @troystaylor and @vmanoharas I think I got it (or at least visual studio code copilot helped) I really hope this is OK, can you please check for me? 🙏 I really appreciate the help, this is really not my forte

Thank you @Nathalie-Leenders, I will wait @troystaylor to respond, if he has any comments before I review your files.

vmanoharas avatar Jun 21 '24 14:06 vmanoharas

Hi @troystaylor and @vmanoharas I think I got it (or at least visual studio code copilot helped) I really hope this is OK, can you please check for me? 🙏 I really appreciate the help, this is really not my forte

Hi Nathalie, Happy to provide some assistance here. First thing I did was run the paconn CLI tool (or pac works too) against the apiDefinition.swagger.json file: image You've defined one path parameter, but not the other 3-4. As I mentioned previously, path parameters are required, so with the single action you've defined, users will be required to give a folder and subfolder name, which I wouldn't do. The easiest way would be to give two different actions, with one having the single folder and a second action to put the file in a subfolder. I've also thought about this and you could use custom code if you set the folder name parameters to query parameters (which don't have to be required). You also need to define Reponame and Markdownfile - those are required. The second major error is the summary length, it cannot be over 80 characters. I would suggest 'Get GitHub file' and 'Get GitHub file in subfolder', fixing the additional error that summaries cannot end in punctuation. Next, the connector metadata property 'Privacy policy' is missing. The final error is the missing key for each path parameters - "x-ms-url-encoding": "single" The CLI tool doesn't catch it, but GitHub should have the correct capitalization for every instance. Another suggestion I would use is to use either camelcase or PascalCase for all your parameter - it makes the code easier to read. I was also thinking about the usefulness of the connector and while I think being able to directly return markdown as a string to Power Automate is useful, I think being able to retrieve any file raw is more useful, so I've changed the produces to application/vnd.github.raw+json. In looking at your apiProperties file, I don't understand what providing the OAuth setting as part of the URL path is suppose to do. The more I thought about with the host you are using, I realized that you would only be able to retrieve public files, because the OAuth would never be valid against that host - the OAuth settings need to be removed. To make this connector work with OAuth, it needs to properly call the api.github.com host and use the correct endpoint: https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content . I'm going to work on the actions using OAuth and I'll share my suggestions soon. @vmanoharas the current artifacts are not ready for certification.

troystaylor avatar Jun 21 '24 22:06 troystaylor

Hi Nathalie, Please review the files I've created that have passed CLI validation: https://github.com/troystaylor/Testing/tree/main/GitHub%20Data As I mentioned, this action will work will any public repo. I am going to continue to investigate the endpoints for the Repositories API and will submit them for a separate connector.

troystaylor avatar Jun 22 '24 15:06 troystaylor