Update Jupyrest connector intro and add new operation (microsoft#2401)

* initial * address comments * address comments * update intro and description * add description and x-ms-summary to all parameters in swagger --------- Co-authored-by: Tianyi Li <tiali@microsoft.com>
Thagod-Dynasty-LLC · Feb 17, 2023 · 2296f9f · 2296f9f
1 parent 652a38e
commit 2296f9f
Show file tree

Hide file tree

Showing 3 changed files with 274 additions and 51 deletions.
diff --git a/certified-connectors/Jupyrest/Readme.md b/certified-connectors/Jupyrest/Readme.md
@@ -1,24 +1,25 @@
-## Jupyrest Connector
-Jupyrest is a service that can turn a notebook into a REST API with predefined input and output contracts.
-
+Jupyrest is a service that can run notebooks with predefined input and output contracts.
 
 ## Prerequisites
 You will need the following to use the connector:
 * A Juprest instance ([Installing the App on Customer Subscription](https://msdata.visualstudio.com/CosmosDB/_git/LivesiteNotebooks?path=/docs/marketplace.md&_a=preview&anchor=installing-the-app-on-customer-subscription))
 * An Azure Active Directory Application
 	* This is your Juprest client AAD app for submitting request to Juprest service, which is also provided when you create your Juprest instance following above doc.
 
+## How to get credentials
+Your AAD client app created in the prerequisites has the access to your Jupyrest instance and will be used to create a connection of Jupyrest connector.
 
-## Getting Started 
+## Getting Started with your connector
 You will need to enter your Jupyrest instance, AAD client ID and client secret to start using the connector. 
-* For the Jupyrest instance, use the url after "https://" like cdbkeplerprod.azurewebsites.net
+* For the Jupyrest instance, use the url of your Function App like https://cdbkeplerprod.azurewebsites.net
 * For the AAD client ID and secret, use the AAD mentioned in the prerequisites.
+* For the ResourceUrl, use the url of your Function App. e.g. https://cdbkeplerprod.azurewebsites.net
 
+## Known issues and limitations
+"Upload a notebook to Synapse" does not support uploading a existing notebook execution given an excutionId.
 
-## Supported Operations
-The connector supports the following operations:
-* `List notebooks`: Lists notebooks in the specified Jupyrest instance
-* `Get notebook metadata`: Gets the notebook metadata including input parameters
-* `Execute a notebook`: Invoke a notebook
-
+## Common errors and remedies
+Contact us via [kepleruser@service.microsoft.com](mailto:kepleruser@service.microsoft.com) in case of errors and questions.
 
+## FAQ
+Contact us via [kepleruser@service.microsoft.com](mailto:kepleruser@service.microsoft.com) in case of errors and questions.