Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

STRF-11315: Add "include_dynamic_target_urls" boolean to Redirect Im/Ex Create Export request body #1505

Merged
merged 1 commit into from
Oct 24, 2023
Merged
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
10 changes: 7 additions & 3 deletions reference/redirects.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,10 @@ paths:
type: integer
default: []
description: A list of the redirect IDs you wish to export. If no redirect IDs are provided, the request exports all redirects for the given site selection.
include_dynamic_target_urls:
type: boolean
default: false
description: If true, the exported CSV will contain an additional read-only column containing the target URL for dynamic redirects.
description: Data necessary to create a new 301 Redirects export job.
required: true
responses:
Expand Down Expand Up @@ -281,13 +285,13 @@ paths:

The headers must be defined as follows:

`Domain,Old Path,New URL/Path,Target Type,Target ID`
`Domain,Old Path,Manual URL/Path,Dynamic Target Type,Dynamic Target ID`

Not every line will have a value for every column.
type: string
format: binary
example: |-
Domain,Old Path,New URL/Path,Target Type,Target ID
Domain,Old Path,Manual URL/Path,Dynamic Target Type,Dynamic Target ID
store.example.com,/old-path,/new-manual-path,,
store.example.com,/old-product,,Product,12
store.example.com,/old-brand,,Brand,34
Expand Down Expand Up @@ -374,7 +378,7 @@ paths:
type: string
format: binary
example: |
Domain,Old Path,New URL/Path,Target Type,Target ID
Domain,Old Path,Manual URL/Path,Dynamic Target Type,Dynamic Target ID
store.example.com,/old-path,/redirect-target,,
'404':
description: The requested export download does not exist.
Expand Down
Loading