Skip to content

Conversation

@entersoftsa
Copy link
Contributor

@entersoftsa entersoftsa commented Dec 14, 2020


Please check the following conditions for your PR.

  • apiDefinition.swagger.json is validated using paconn validate command.
  • apiProperties.json has a valid brand color. Invalid brand colors are #007ee5 and #ffffff.

calvinleong and others added 4 commits November 5, 2020 11:58
)

* Update apiDefinition.swagger.json

* Add files via upload

* update readme

* Update Get User Info Action and apiProperties file
* Create IN-D KYC India

* Delete IN-D KYC India

* Create apiDefinition.swagger.json

* Add files via upload

* Create README.MD

* Update README.MD

* Delete README.MD

* Delete apiDefinition.swagger.json

* Delete apiProperties.json

* Create IN-D Insurance

* Delete IN-D Insurance

* Create IN-D Insurance

* Delete IN-D Insurance

* Create Readme.md

* Add files via upload

* Add files via upload

* Delete Readme.md

* Delete apiDefinition.swagger.json

* Delete apiProperties.json

* Create Readme.md

* Add files via upload

* Add files via upload
@entersoftsa entersoftsa requested a review from a team as a code owner December 15, 2020 08:04
@ghost
Copy link

ghost commented Dec 15, 2020

CLA assistant check
All CLA requirements met.

Copy link
Contributor

@dougelliott dougelliott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could the description of the connector be expanded a little bit? Even just a sentence or two about very high-level functionality the connector offers would be helpful in users understanding more about the connector.

@entersoftsa
Copy link
Contributor Author

entersoftsa commented Dec 17, 2020 via email

@entersoftsa
Copy link
Contributor Author

entersoftsa commented Dec 17, 2020 via email

@dougelliott
Copy link
Contributor

@entersoftsa First, thanks so much for the changes to the readme! Those are fantastic improvements and will definitely help users of the connector. In relation to my initial feedback, I was actually referring to the description field located in the apiDefinition.swagger.json file, which is the "main" description for the connector. This is one of the first things a customer will likely read when looking at the connector, so it's good for it to not only contain high-level information about the service, but also high-level information about the functionality of the connector. The maximum length of that description field can be 500 characters, so you're more than welcome to use up to that amount to expand on the value the connector offers customers.

@sriyen-msft
Copy link
Contributor

sriyen-msft commented Dec 18, 2020

@entersoftsa The description of connector can be improved, Can you please provide a detailed description which every one can understand about your connector.
Refer - Documentation

@sriyen-msft
Copy link
Contributor

@entersoftsa Summary values of the operations looks like opertaionIds, Can you please provide a valid sentence for every summary value, wherever it applies in the swagger .
Ex.: Line number 25 - "summary": "GetInfo"
Refer - Documentation

@sriyen-msft
Copy link
Contributor

@entersoftsa Please replace all the unicodes used in the artifacts with English language characters.

@sriyen-msft
Copy link
Contributor

@entersoftsa Please note that it is not allowed to have non-English characters in any of the connector artifacts. You can raise a separate request for localization of your connector once it is certified.

Ex: Line number 7399 - EInvoice_\u0391dditionalInterchangeableExpense1_Description":

@sriyen-msft
Copy link
Contributor

@entersoftsa There is a limitation to each connector for having 128 operations and 512 definitions. Please let us know if your connector is exceeding the limitation.

@entersoftsa
Copy link
Contributor Author

All of the issues raised in the previous comments have been resolved with the commit 0.6

Copy link
Contributor Author

@entersoftsa entersoftsa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

dougelliott
dougelliott previously approved these changes Dec 22, 2020
@sriyen-msft
Copy link
Contributor

@entersoftsa There are few operations have description values which looks like operationids. Please replace them with valid sentences as these would be visible to public.

Line number : 459

 "summary": "Add or Update an entity's Related Documents",
"description": "AddOrUpdateAttachedDocument",
"operationId": "ES00Documents_AddOrUpdateAttachedDocument",

@sriyen-msft
Copy link
Contributor

@entersoftsa Few operation summary values are still looking like operation Ids instead of a valid sentence.

Ex.: Line number 609

"summary": "ESBGBudgetSheet", "description": "Get the ESBGBudgetSheetObj", "operationId": "ESBudget_ESBGBudgetSheet",

@sriyen-msft
Copy link
Contributor

@entersoftsa There is no metadata found in the swagger, Can you please go thru the instructions mentioned in the documentation to add metadata to your connector.

@entersoftsa
Copy link
Contributor Author

@entersoftsa There is no metadata found in the swagger, Can you please go thru the instructions mentioned in the documentation to add metadata to your connector.

Hi Srikanth,
According to the documentation that you are referring to, the metadata for publisher and stackOwner should be located in the apiProperties.json file. This is where I have put those metadata (line 36 & 37 in the apiProperties.json file).

Should I also include them in the api Swagger definition file? If so, in which section should be put? There is no documentation for this or I missed it.
Thanks in advance

@sriyen-msft
Copy link
Contributor

@entersoftsa There is no metadata found in the swagger, Can you please go thru the instructions mentioned in the documentation to add metadata to your connector.

Hi Srikanth,
According to the documentation that you are referring to, the metadata for publisher and stackOwner should be located in the apiProperties.json file. This is where I have put those metadata (line 36 & 37 in the apiProperties.json file).

Should I also include them in the api Swagger definition file? If so, in which section should be put? There is no documentation for this or I missed it.
Thanks in advance

Metadata in your connector files looks good. No change is required now.. Thanks

@entersoftsa
Copy link
Contributor Author

Hi Srikanth,
I have uploaded a new version (0.7) of the api definitions, where I have addressed all the Summary / Description issues that you have mentioned in your latest review.

@sriyen-msft sriyen-msft merged commit 6afb118 into microsoft:dev Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants