-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8b5c900
commit f782ccd
Showing
57 changed files
with
2,744 additions
and
184 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,190 @@ | ||
imports: | ||
root: __package__.yml | ||
service: | ||
auth: false | ||
base-path: '' | ||
endpoints: | ||
get: | ||
path: /sites/{site_id}/redirects | ||
method: GET | ||
auth: true | ||
docs: > | ||
Fetch a list of all URL redirect rules configured for a specific site. | ||
Use this endpoint to review, audit, or manage the redirection rules that | ||
control how traffic is rerouted on your site. | ||
Required scope: `sites:read` | ||
source: | ||
openapi: ../../../referenced-specs/v2.yml | ||
path-parameters: | ||
site_id: | ||
type: string | ||
docs: Unique identifier for a Site | ||
display-name: Get URL redirects | ||
response: | ||
docs: Request was successful | ||
type: root.Redirects | ||
errors: | ||
- root.BadRequestError | ||
- root.UnauthorizedError | ||
- root.NotFoundError | ||
- root.TooManyRequestsError | ||
- root.InternalServerError | ||
examples: | ||
- path-parameters: | ||
site_id: 580e63e98c9a982ac9b8b741 | ||
response: | ||
body: | ||
redirects: | ||
- id: 42e1a2b7aa1a13f768a0042a | ||
fromUrl: /mostly-harmless | ||
toUrl: /earth | ||
- id: 6x9e7f8d9a4b1c2d3e4f5678 | ||
fromUrl: /babel-fish | ||
toUrl: /translate | ||
pagination: | ||
limit: 100 | ||
offset: 0 | ||
total: 2 | ||
create: | ||
path: /sites/{site_id}/redirects | ||
method: POST | ||
auth: true | ||
docs: > | ||
Add a new URL redirection rule to a site. | ||
This endpoint allows you to define a source path (`fromUrl`) and its | ||
corresponding destination path (`toUrl`), which will dictate how traffic | ||
is rerouted on your site. This is useful for managing site changes, | ||
restructuring URLs, or handling outdated links. | ||
Required scope: `sites:write` | ||
source: | ||
openapi: ../../../referenced-specs/v2.yml | ||
path-parameters: | ||
site_id: | ||
type: string | ||
docs: Unique identifier for a Site | ||
display-name: Create a URL redirect | ||
request: | ||
body: root.Redirect | ||
content-type: application/json | ||
response: | ||
docs: Request was successful | ||
type: root.Redirect | ||
errors: | ||
- root.BadRequestError | ||
- root.UnauthorizedError | ||
- root.NotFoundError | ||
- root.TooManyRequestsError | ||
- root.InternalServerError | ||
examples: | ||
- path-parameters: | ||
site_id: 580e63e98c9a982ac9b8b741 | ||
request: | ||
id: 42e1a2b7aa1a13f768a0042a | ||
fromUrl: /mostly-harmless | ||
toUrl: /earth | ||
response: | ||
body: | ||
id: 42e1a2b7aa1a13f768a0042a | ||
fromUrl: /mostly-harmless | ||
toUrl: /earth | ||
delete: | ||
path: /sites/{site_id}/redirects/{redirect_id} | ||
method: DELETE | ||
auth: true | ||
docs: > | ||
Remove a URL redirection rule from a site. | ||
This is useful for cleaning up outdated or unnecessary redirects, | ||
ensuring that your site's routing behavior remains efficient and | ||
up-to-date. | ||
Required scope: `sites:write` | ||
source: | ||
openapi: ../../../referenced-specs/v2.yml | ||
path-parameters: | ||
site_id: | ||
type: string | ||
docs: Unique identifier for a Site | ||
redirect_id: | ||
type: string | ||
docs: Unique identifier site rediect | ||
display-name: Delete URL redirects | ||
response: | ||
docs: Request was successful | ||
type: root.Redirects | ||
errors: | ||
- root.BadRequestError | ||
- root.UnauthorizedError | ||
- root.NotFoundError | ||
- root.TooManyRequestsError | ||
- root.InternalServerError | ||
examples: | ||
- path-parameters: | ||
site_id: 580e63e98c9a982ac9b8b741 | ||
redirect_id: 66c4cb9a20cac35ed19500e6 | ||
response: | ||
body: | ||
redirects: | ||
- id: 42e1a2b7aa1a13f768a0042a | ||
fromUrl: /mostly-harmless | ||
toUrl: /earth | ||
- id: 6x9e7f8d9a4b1c2d3e4f5678 | ||
fromUrl: /babel-fish | ||
toUrl: /translate | ||
pagination: | ||
limit: 100 | ||
offset: 0 | ||
total: 2 | ||
patch: | ||
path: /sites/{site_id}/redirects/{redirect_id} | ||
method: PATCH | ||
auth: true | ||
docs: | | ||
Update a URL redirection rule from a site. | ||
Required scope: `sites:write` | ||
source: | ||
openapi: ../../../referenced-specs/v2.yml | ||
path-parameters: | ||
site_id: | ||
type: string | ||
docs: Unique identifier for a Site | ||
redirect_id: | ||
type: string | ||
docs: Unique identifier site rediect | ||
display-name: Update URL redirect | ||
request: | ||
body: root.Redirect | ||
content-type: application/json | ||
response: | ||
docs: Request was successful | ||
type: root.Redirect | ||
errors: | ||
- root.BadRequestError | ||
- root.UnauthorizedError | ||
- root.NotFoundError | ||
- root.TooManyRequestsError | ||
- root.InternalServerError | ||
examples: | ||
- path-parameters: | ||
site_id: 580e63e98c9a982ac9b8b741 | ||
redirect_id: 66c4cb9a20cac35ed19500e6 | ||
request: | ||
id: 42e1a2b7aa1a13f768a0042a | ||
fromUrl: /mostly-harmless | ||
toUrl: /earth | ||
response: | ||
body: | ||
id: 42e1a2b7aa1a13f768a0042a | ||
fromUrl: /mostly-harmless | ||
toUrl: /earth | ||
source: | ||
openapi: ../../../referenced-specs/v2.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
imports: | ||
root: __package__.yml | ||
service: | ||
auth: false | ||
base-path: '' | ||
endpoints: | ||
get: | ||
path: /sites/{site_id}/plan | ||
method: GET | ||
auth: true | ||
docs: | | ||
Get site plan details for the specified Site. | ||
Required scope | `sites:read` | ||
source: | ||
openapi: ../../../referenced-specs/v2.yml | ||
path-parameters: | ||
site_id: | ||
type: string | ||
docs: Unique identifier for a Site | ||
display-name: Get Site Plan | ||
response: | ||
docs: Request was successful | ||
type: root.SitePlan | ||
errors: | ||
- root.BadRequestError | ||
- root.UnauthorizedError | ||
- root.NotFoundError | ||
- root.TooManyRequestsError | ||
- root.InternalServerError | ||
examples: | ||
- path-parameters: | ||
site_id: 580e63e98c9a982ac9b8b741 | ||
response: | ||
body: | ||
id: hosting-business-v4 | ||
name: Business Hosting | ||
pricingInfo: https://webflow.com/pricing | ||
source: | ||
openapi: ../../../referenced-specs/v2.yml |
Oops, something went wrong.