Skip to content

Commit

Permalink
chore: Remove V2 migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dsinghvi authored Nov 19, 2024
1 parent 7c7bb43 commit 0d715fd
Showing 1 changed file with 0 additions and 28 deletions.
28 changes: 0 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,6 @@ The SDK contains typings and request builders for the Webflow Data API.

Explore the [API reference documentation](https://developers.webflow.com/reference/rest-introduction).

## V2 Migration Guide

> The SDK was rewritten in V2 and is now programatically generated from our OpenAPI spec. As part of this release there are some breaking changes.
#### Client Instantiation
The SDK exports `WebflowClient` instead of `Webflow`. The client now takes `accessToken` instead of `token`.

```ts
const webflow = new WebflowClient({ accessToken: "..." });
```

#### Oauth
The `WebflowClient` exports static methods that you can use for OAuth. These were previously on `Webflow`.

`webflow.authorizeUrl` -> `WebflowClient.authorizeURL`

`webflow.accessToken` -> `WebflowClient.getAccessToken`

`webflow.revokeToken` -> `WebflowClient.revokeToken`

#### HTTP Client
The SDK no longer uses Axios and defaults to fetch. The SDK supports multiple runtimes and will handle
using a fetch implementation if available or will default to `node-fetch`.

### Resources
Previously the SDK only supported the most important resources, such as site and user. Now the SDK supports
methods on a variety of different endpoints such as `collections`, `assets`, `forms`, `inventory`, `orders`, etc.

## Installation

Add this dependency to your project's package.json file:
Expand Down

1 comment on commit 0d715fd

@Maxwell2022
Copy link

Choose a reason for hiding this comment

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

@dsinghvi Why is this been removed from the doc? The V1 API is sunsetting on Jan 1st and I'm guessing customers will rush to this repo when their app will break. I believe this is still helpful

Please sign in to comment.