Included file information for custom connector #4

mamurshe · 2019-03-27T21:58:52Z

No description provided.

tools/paconn-cli/README.md

JatinSanghvi · 2019-03-28T23:13:26Z

tools/paconn-cli/README.md

+
+A custom connector consists of three files. An icon for the connector, an Open API swagger definition, and an API properties file. The files are generally located in a directory with the connector ID as the name of the directory.
+
+Sometimes, the custom connector directory may include a `settings.json` file. Although this file is not part of the connector definition, it can be used as an arguments store for the CLI.


arguments store to argument-store?

JatinSanghvi · 2019-03-28T23:19:10Z

tools/paconn-cli/README.md

+
+### API Definition (Swagger) File
+
+The API definition file describes the API for the custom connector using the OpenAPI specification. It is also known as the swagger file. More information about API definition to write custom connector can be found in [the connector documentation on the subject](https://docs.microsoft.com/en-us/connectors/custom-connectors/define-openapi-definition).


I am not sure if this will be the right link. Also, possibly we can add a link to OpenAPI extensions that we support: https://docs.microsoft.com/en-us/connectors/custom-connectors/openapi-extensions.

JatinSanghvi · 2019-03-28T23:20:13Z

tools/paconn-cli/README.md

+
+### API Properties File
+
+The API properties file contains some properties for the custom connector. These properties are not part of the API definition. It contains information such as the brand color, authentication information etc. A typical API properties file looks like the following:


information etc. -> information, etc..

tools/paconn-cli/README.md

JatinSanghvi · 2019-03-28T23:38:34Z

tools/paconn-cli/README.md

+}
+```
+
+In the settings file the following items are expected. If an option is missing but required the console will prompt for the missing information.


required the -> required, the

JatinSanghvi · 2019-03-28T23:41:04Z

tools/paconn-cli/README.md

+
+In the settings file the following items are expected. If an option is missing but required the console will prompt for the missing information.
+
+* `connectorId`: The connector id string for the custom connector. This parameter is required for download and update, but not for create since a new custom connector with new id will be created. If you need to update a custom connector just created using the same settings file, please make sure the settings file is correctly updated with the new connector id from the create operation.


id -> ID everywhere.
download and update commands / verbs / operations? Similarly for the create.

JatinSanghvi · 2019-03-28T23:42:12Z

tools/paconn-cli/README.md

+
+* `connectorId`: The connector id string for the custom connector. This parameter is required for download and update, but not for create since a new custom connector with new id will be created. If you need to update a custom connector just created using the same settings file, please make sure the settings file is correctly updated with the new connector id from the create operation.
+
+* `environment`: The environment GUID string for the custom connector. This parameter is required for all three operations.


I think we should use environment ID instead of environment GUID everywhere.

JatinSanghvi · 2019-03-28T23:44:52Z

tools/paconn-cli/README.md

+
+* `environment`: The environment GUID string for the custom connector. This parameter is required for all three operations.
+
+* `apiProperties`: The full path to the api properties `apiProperties.json` file. It is required for the create and update operation. When this option is present during the download, the file in the given location will be written to.


api -> API. The end of the sentence seems incomplete. Can it be the file will be created/generated/downloaded in the given location?

JatinSanghvi · 2019-03-28T23:47:06Z

tools/paconn-cli/README.md

+
+* `apiProperties`: The full path to the api properties `apiProperties.json` file. It is required for the create and update operation. When this option is present during the download, the file in the given location will be written to.
+
+* `apiDefinition`: The full path to the swagger file `apiDefinition.swagger.json` file. It is required for the create and update operation. When this option is present during the download, the file in the given location will be written to.


full path or just the path? Can we delete text: apiDefinition.swagger.json file?

JatinSanghvi · 2019-03-28T23:47:54Z

tools/paconn-cli/README.md

+
+* `apiDefinition`: The full path to the swagger file `apiDefinition.swagger.json` file. It is required for the create and update operation. When this option is present during the download, the file in the given location will be written to.
+
+* `icon`: The full path to the icon file `icon.png` file. It is required for the create and update operation. When this option is present during the download, the file in the given location will be written to.


Same comment as above. The wording seems redundant: icon file icon.png file.

tools/paconn-cli/README.md

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release #2 * Encodian - August Release #1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release #2 * Encodian March 22 * Encodian March 22 #2 * Encodian March 22 #3 * Encodian March 22 #4 * Encodian March 22 #5

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release microsoft#2 * Encodian - August Release #1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release microsoft#2 * Encodian March 22 * Encodian March 22 microsoft#2 * Encodian March 22 microsoft#3 * Encodian March 22 microsoft#4 * Encodian March 22 microsoft#5

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release #2 * Encodian - August Release #1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release #2 * Encodian March 22 * Encodian March 22 #2 * Encodian March 22 #3 * Encodian March 22 #4 * Encodian March 22 #5 * March 22 Release (Updated)

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release #2 * Encodian - August Release #1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release #2 * Encodian March 22 * Encodian March 22 #2 * Encodian March 22 #3 * Encodian March 22 #4 * Encodian March 22 #5 * March 22 Release (Updated) * Encodian - July 22

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release #2 * Encodian - August Release #1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release #2 * Encodian March 22 * Encodian March 22 #2 * Encodian March 22 #3 * Encodian March 22 #4 * Encodian March 22 #5 * March 22 Release (Updated) * Encodian Oct 22 Release * Encodian October 22 Release #2 * Updates * Minor update

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release microsoft#2 * Encodian - August Release microsoft#1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release microsoft#2 * Encodian March 22 * Encodian March 22 microsoft#2 * Encodian March 22 microsoft#3 * Encodian March 22 microsoft#4 * Encodian March 22 microsoft#5 * March 22 Release (Updated) * Encodian Oct 22 Release * Encodian October 22 Release microsoft#2 * Updates * Minor update

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release microsoft#2 * Encodian - August Release #1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release microsoft#2 * Encodian March 22 * Encodian March 22 microsoft#2 * Encodian March 22 microsoft#3 * Encodian March 22 microsoft#4 * Encodian March 22 microsoft#5 * March 22 Release (Updated) * Encodian - July 22

* Encodian March 21 Release * Encodian April 21 Release * Encodian May 21 Release * Encodian June 21 Release * Encodian - June 21 Release microsoft#2 * Encodian - August Release #1 * Encodian - Nov 21 Release * Encodian - Nov 21 Release microsoft#2 * Encodian March 22 * Encodian March 22 microsoft#2 * Encodian March 22 microsoft#3 * Encodian March 22 microsoft#4 * Encodian March 22 microsoft#5 * March 22 Release (Updated) * Encodian Oct 22 Release * Encodian October 22 Release microsoft#2 * Updates * Minor update

Send envelope using template versioning and text custom field support

Flow 339 iternation: Get Recipient information

ON-45986 # Added operation to retrieve approval record

* Merge pull request #4 from oneblink/ON-45986 ON-45986 # Added operation to retrieve approval record * MS-591 # Update version --------- Co-authored-by: Matt Carroll <matt@oneblink.io> Co-authored-by: Aaron <aaron@oneblink.io>

…imary Key, fix datasets metadata (#3940) * FLOW-4100 Improve detecting of table primary key (#4) * FLOW-4393 Provide versioning and version identification for Power Apps Connector (#6) * Add Versioning * fix build * FLOW-4102 Fix datasets metadata endpoint to return correct values (#7) * Bump Snowflake Connector version 2.2.0 (#8) * Snowflake V2 Add apidefinition contact and categories --------- Co-authored-by: Piotr Zalas <127133187+sfc-gh-pzalas@users.noreply.github.com>

Included file information for custom connector

2323287

mamurshe requested review from JatinSanghvi and ShyamSunder90 March 27, 2019 21:58