Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

🌿 Fern Regeneration -- December 17, 2024 #193

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 144 additions & 35 deletions .mock/definition/__package__.yml

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions .mock/definition/collections/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ types:
- Color
- File
docs: Choose these appropriate field type for your collection data
inline: true
source:
openapi: ../../../referenced-specs/v2.yml
imports:
Expand Down
4 changes: 2 additions & 2 deletions .mock/definition/collections/items.yml
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ service:


To create items across multiple locales, please use [this
endpoint.](/data/v2.0.0/reference/cms/collection-items/bulk-items/create-items)
endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items)


Required scope | `CMS:write`
Expand Down Expand Up @@ -605,7 +605,7 @@ service:


To create items across multiple locales, [please use this
endpoint.](/v2.0.0/data/reference/cms/collection-items/bulk-items/create-items)
endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items)



Expand Down
1 change: 1 addition & 0 deletions .mock/definition/inventory.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,6 @@ types:
- infinite
- finite
docs: infinite or finite
inline: true
source:
openapi: ../../../referenced-specs/v2.yml
1 change: 1 addition & 0 deletions .mock/definition/orders.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ types:
- fraudulent
- requested
docs: The reason for the refund
inline: true
source:
openapi: ../../../referenced-specs/v2.yml
imports:
Expand Down
190 changes: 190 additions & 0 deletions .mock/definition/redirects.yml
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
40 changes: 40 additions & 0 deletions .mock/definition/sitePlan.yml
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
Loading
Loading