added front matter to saas connectivity

This commit is contained in:
jordan-violet-sp
2022-09-15 15:27:44 -04:00
parent fa72ee5d39
commit d35b3cad6e
5 changed files with 40 additions and 6 deletions

View File

@@ -10,7 +10,7 @@ description: Any time code can fail due to validation issues, connectivity or co
slug: /docs/saas-connectivity/in-depth/error-handling
tags: ["Connectivity"]
---
# Error Handling
Any time code can fail due to validation issues, connectivity or configuration errors, handle the error and provide information back to the user about what went wrong. If you handle your errors properly, it will be easier to debug and pinpoint what happened in your connector when something goes wrong.
## Connector Errors

View File

@@ -1,9 +1,17 @@
---
id: linting
title: Linting
pagination_label: Linting
sidebar_label: Linting
sidebar_position: 4
sidebar_class_name: linting
keywords: ["connectivity", "connectors", "linting"]
description: Automatically check your connector source code for programmatic and stylistic errors.
slug: /docs/saas-connectivity/in-depth/linting
tags: ["Connectivity"]
---
# Linting
To add linting to your project, simple install the linter using NPM:
To add linting to your project, simply install the linter using NPM:
```npm install --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin``

View File

@@ -1,8 +1,15 @@
---
id: logging
title: Logging
pagination_label: Logging
sidebar_label: Logging
sidebar_position: 5
sidebar_class_name: logging
keywords: ["connectivity", "connectors", "logging"]
description: You can use this feature to read the logs of your connectors.
slug: /docs/saas-connectivity/in-depth/logging
tags: ["Connectivity"]
---
# Logging
## Printing Logs with the CLI
Fetch logs from IDN by issuing the ```sp conn logs``` command:

View File

@@ -1,4 +1,16 @@
# Handling Rate Limits
---
id: handling-rate-limits
title: Handling Rate Limits
pagination_label: Handling Rate Limits
sidebar_label: Handling Rate Limits
sidebar_position: 6
sidebar_class_name: handlingRateLimits
keywords: ["connectivity", "connectors", "rate limits"]
description: Rate limiting for SaaS Connectivity.
slug: /docs/saas-connectivity/in-depth/handling-rate-limits
tags: ["Connectivity"]
---
APIs often implement rate limits to prevent any one user from abusing the API or using an unfair amount of resources, limiting what other users of the API can do. The rate limits can manifest in many ways, but one of the most common ways is the 429 (Too Many Requests) HTTP status code. You must check the documentation of the API you are using to see whether it enforces rate limits and how it notifies you when you reach that limit. An example of rate limit documentation for Stripes API can be found [here](https://stripe.com/docs/rate-limits).
If you are using a vendor supplied client library for the API, check the documentation for that client library to see whether it handles rate limits for you. If it does, you do not need to worry about rate limits. If it does not or if you have to implement your own library for interacting with the target API, you must handle rate limiting yourself. If you are implementing your own library for the target API, the easiest way to handle rate limits is to use the [axios-retry](https://www.npmjs.com/package/axios-retry) NPM package in conjunction with the [axios](https://www.npmjs.com/package/axios) HTTP request library. Start by including both packages in the dependencies section of your ```package.json``` file:

View File

@@ -1,8 +1,15 @@
---
id: testing
title: Testing
pagination_label: Testing
sidebar_label: Testing
sidebar_position: 7
sidebar_class_name: testing
keywords: ["connectivity", "connectors", "testing"]
description: Testing SaaS Connectivity.
slug: /docs/saas-connectivity/in-depth/testing
tags: ["Connectivity"]
---
# Testing
## Getting Started