Skip to content

Commit

Permalink
fix(sites-28811): [xwalk] - support xwalk in spacecat-api-service
Browse files Browse the repository at this point in the history
* updates for import apis
  • Loading branch information
Ben Helleman committed Feb 18, 2025
1 parent 9c41942 commit 4d65e8a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/index.html

Large diffs are not rendered by default.

39 changes: 33 additions & 6 deletions docs/openapi/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1544,21 +1544,48 @@ PageMetricList:
items:
oneOf:
- $ref: './schemas.yaml#/PageOrganicKeywords'
ImportOptions:
type: object
DocImportData:
title: "Doc Import"
description: "There are no data properties available for doc based imports."
properties: {}
XWalkImportData:
title: "Xwalk Import"
type:
enum: ['xwalk']
properties:
siteName:
type: string
assetFolder:
type: string
required:
- siteName
- assetFolder
ImportOptionsBase:
properties:
pageLoadTimeout:
description: The time in milliseconds to wait for the page to load
type: integer
enableJavascript:
description: Whether to enable JavaScript on the page
type: boolean
type:
description: The type of import job. Options are 'doc' or 'xwalk'. Defaults to 'doc' if not specified.
type: string
example:
pageLoadTimeout: 100
enableJavascript: true
ImportOptions:
allOf: #/ImportOptionsBase
- $ref: '#/ImportOptionsBase'
properties:
type:
enum: ['doc', 'xwalk']
description: The type of import job. Options are 'doc' or 'xwalk'.
type: string
default: 'doc'
data:
description: Optional data to pass to the import job.
type: object
oneOf:
- $ref: '#/DocImportData'
- $ref: '#/XWalkImportData'
ImportJobRequest:
type: object
required:
Expand Down Expand Up @@ -1672,7 +1699,7 @@ ScrapeRequest:
$ref: '#/Id'
options:
description: Optional configuration params, defined as a JSON object
$ref: '#/ImportOptions'
$ref: '#/ImportOptionsBase'
customHeaders:
description: Optional custom headers to send with each HTTP request
type: object
Expand Down

0 comments on commit 4d65e8a

Please sign in to comment.