Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix(connect): document connect ui, add apiURL param #2912

Merged
merged 8 commits into from
Oct 29, 2024

Conversation

bodinsamuel
Copy link
Collaborator

Describe your changes

Contributes https://linear.app/nango/issue/NAN-1923/make-nango-connect-the-only-way-to-create-connection-in-nango-ui

  • Document connect ui as the main way to consume Nango
    The old doc has been moved to advanced.
  • Add ApiURL param so people can self-host

@bodinsamuel bodinsamuel self-assigned this Oct 28, 2024
@@ -100,7 +136,7 @@ const result = nango.auth('<INTEGRATION-ID>', '<CONNECTION-ID>', {
The integration ID that you can find in the integration settings on the Nango UI.
</ResponseField>

<ResponseField name="connectionId" type="string" required>
<ResponseField name="connectionId" type="string">
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we need to also update the docs-v2/spec.yaml file to make the connection_id field not required for the POST /connection endpoint

```js
const result = await nango.auth('<INTEGRATION-ID>', '<CONNECTION-ID>');
```

Copy link
Collaborator

Choose a reason for hiding this comment

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

do we even document this option or not?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

For legacy reason, I think it's somewhat required

@bodinsamuel bodinsamuel enabled auto-merge (squash) October 29, 2024 13:45
@bodinsamuel bodinsamuel merged commit 3846cd5 into master Oct 29, 2024
21 checks passed
@bodinsamuel bodinsamuel deleted the sam/doc/connect-main branch October 29, 2024 13:52
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants