docs: API docs page outline #3093
Conversation
bastienbeurier
commented
Dec 2, 2024
bastienbeurier
commented
- Example API page
- New edits based on feedback
There was a problem hiding this comment.
@bastienbeurier I left some comments on wording, let me know what you think!
| | - | - | | ||
| | Pre-built authorization (OAuth 2) | ✅ | | ||
| | Credentials auto-refresh | ✅ | | ||
| | Authorization input validation | ✅ | |
There was a problem hiding this comment.
Not 100% sure which feature you refer to, is it the automatic credentials validation?
If you also mean the additional parameters, I think we should mention them explicitly as a separate feature?
Suggestion:
Automatic credentials validation
Automatic auth-parameters validation
| | Pre-built authorization (OAuth 2) | ✅ | | ||
| | Credentials auto-refresh | ✅ | | ||
| | Authorization input validation | ✅ | | ||
| | Pre-built authorization UI | ✅ | |
There was a problem hiding this comment.
Pre-built Connect UI?
To stay in line with our wording of this feature elsewhere
| | Authorization input validation | ✅ | | ||
| | Pre-built authorization UI | ✅ | | ||
| | Custom authorization UI | ✅ | | ||
| | End-user authorization guidelines | ✅ | |
There was a problem hiding this comment.
End-user authorization guide
=> IMO we should only mark it as checked where we actually have it. For OAuth ones, we could mark as "not required"?
| | Pre-built authorization UI | ✅ | | ||
| | Custom authorization UI | ✅ | | ||
| | End-user authorization guidelines | ✅ | | ||
| | Invalid credentials detection | ✅ | |
There was a problem hiding this comment.
Broken credentials detection
I would use this wording to differentiate between the validation at connect time, and detection of broken credentials down the road
| | - | - | | ||
| | HTTP request logging | ✅ | | ||
| | End-to-type type safety | ✅ | | ||
| | Data runtime validation | ✅ | |
There was a problem hiding this comment.
@bastienbeurier Since we mention some platform level features here, IMO we could add:
- OpenTelemetry export
- Slack Alerts on errors
- Integration status API
|
|
||
| <Tip>Not seeing the use-case you need? [Build your own](https://nango.dev/slack) independently.</Tip> | ||
|
|
||
| ## Pre-requisites |
There was a problem hiding this comment.
I never heard of pre-requisites before. I think it would be good to find a more descriptive title
Suggestion:
Requirements & Review Process
Also open to other suggestions!
| | Pre-Requisites | Status | Comment| | ||
| | - | - | - | | ||
| | Paid dev account | ✅ Not required | Free, self-signup [here](https://developers.hubspot.com/). | | ||
| | Paid test account | ✅ Not required | Free, self-signup [here](https://hubspot.com/). | |
There was a problem hiding this comment.
Nit: Once you have a dev account you can create a free Enterprise HubSpot account. That will be more realistic account for testing than the free account.
I would change the comment to "Create free Enterprise account for testing from your developer account"
| | Paid dev account | ✅ Not required | Free, self-signup [here](https://developers.hubspot.com/). | | ||
| | Paid test account | ✅ Not required | Free, self-signup [here](https://hubspot.com/). | | ||
| | Partnership | ✅ Not required | | | ||
| | App review | ✅ Not required | | |
There was a problem hiding this comment.
I would add in comment "Only required for marketplace listing, not for integration distribution"
