Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
ffd932b
feat: added api routes and modified for optimization reports
sahil9001 Jul 21, 2025
d80de2f
feat: added get all reports route
sahil9001 Jul 22, 2025
81fe98e
Merge remote-tracking branch 'origin/main' into SITES-33657
sahil9001 Jul 25, 2025
6d38781
feat: added api docs and tests
sahil9001 Jul 28, 2025
d43228c
feat: trigger build
sahil9001 Jul 28, 2025
b56caa0
fix: corrected routes
sahil9001 Jul 28, 2025
ace50fd
Merge branch 'main' into SITES-33657
ssilare-adobe Jul 28, 2025
fc9c903
feat: added validation for post report if it already exists
sahil9001 Jul 29, 2025
82a0839
Merge branch 'SITES-33657' of work-github:adobe/spacecat-api-service …
sahil9001 Jul 29, 2025
8c418af
Merge remote-tracking branch 'origin/main' into SITES-33657
sahil9001 Jul 29, 2025
08efa39
feat: trigger build
ssilare-adobe Jul 29, 2025
95e5225
feat: trigger build
ssilare-adobe Jul 29, 2025
20a8a73
feat: added presigned url
sahil9001 Jul 31, 2025
5cd9e7d
feat: added `presignedUrl` data to the reports
sahil9001 Aug 4, 2025
06ab7d6
feat: added deletion for reports
sahil9001 Aug 4, 2025
dee5942
docs: added docs for reports
sahil9001 Aug 4, 2025
3d8c0e9
feat: added expiry time for presigned urls
sahil9001 Aug 5, 2025
8e0e65b
feat: added proper date validation
sahil9001 Aug 5, 2025
a88a0b6
feat: added successful reports filter
sahil9001 Aug 5, 2025
683b5c5
feat: added date validation
sahil9001 Aug 5, 2025
a647a4d
fix: added `status` value from the model and also included `processin…
sahil9001 Aug 6, 2025
a02bdbc
feat: trigger build
sahil9001 Aug 6, 2025
26b6247
Merge remote-tracking branch 'origin/main' into SITES-33657
sahil9001 Aug 10, 2025
af08511
feat: updated deps
sahil9001 Aug 10, 2025
3386d7a
feat: changed the testing env to latest
sahil9001 Aug 10, 2025
2d81f10
docs: added correct status for the reports in docs
sahil9001 Aug 10, 2025
eb2a126
feat: testing PR to verify the queue message
sahil9001 Aug 10, 2025
c801152
feat: added correct env parsing
sahil9001 Aug 10, 2025
abda478
feat: changed the sqs message format
sahil9001 Aug 10, 2025
5959c34
feat: added storage path to the message
sahil9001 Aug 11, 2025
6265601
feat: trigger build
sahil9001 Aug 12, 2025
97335c5
feat: changed the `jobId` to `reportId`
sahil9001 Aug 12, 2025
2e683b3
fix: fixed tests
sahil9001 Aug 12, 2025
f511145
feat: added correct reportPath and used defined getter functions
sahil9001 Aug 12, 2025
b44ec6a
feat: corrected report path by removing forward slash
sahil9001 Aug 12, 2025
0c371db
feat: updated spacecat-shared-data-access to 2.51.0
sahil9001 Aug 12, 2025
804dce1
Merge remote-tracking branch 'origin/main' into SITES-33657
sahil9001 Aug 14, 2025
176d5f0
feat: added patch api endpoint
sahil9001 Aug 14, 2025
1c6bdb8
feat: added update api docs
sahil9001 Aug 14, 2025
b829cb1
feat: added name field in reports
sahil9001 Aug 21, 2025
fcf5b62
Merge remote-tracking branch 'origin/main' into SITES-33657
sahil9001 Aug 26, 2025
ecab31d
chore: minor fixes
sahil9001 Aug 26, 2025
d15ea13
chore: added status from enum
sahil9001 Aug 26, 2025
edc5ec4
chore: changed `jobId` to `reportId`
sahil9001 Aug 26, 2025
3d58ee9
test: fixed tests
sahil9001 Aug 26, 2025
c3cf0ca
feat: added `createResponse` for 409 code
sahil9001 Aug 26, 2025
5666960
feat: added reports enum
sahil9001 Aug 26, 2025
a24afa0
feat: added report status
sahil9001 Aug 26, 2025
a5d41e7
chore: updated package.json
sahil9001 Aug 26, 2025
e41ab69
feat: added response for existing report
sahil9001 Aug 26, 2025
30fc40a
feat: changed to deploy to custom namespace
sahil9001 Aug 26, 2025
f942240
docs: added api docs
sahil9001 Aug 26, 2025
fe0f7d8
Merge remote-tracking branch 'origin/main' into SITES-33657
sahil9001 Aug 26, 2025
a8ec935
Merge remote-tracking branch 'origin/main' into SITES-33657
sahil9001 Aug 27, 2025
a052cb7
chore: update `package-lock.json` from main branch
sahil9001 Aug 27, 2025
31aa583
fix: corrected the deployed version to `latest`
sahil9001 Aug 27, 2025
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
150 changes: 150 additions & 0 deletions docs/index.html

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions docs/openapi/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ tags:
description: LLMO (Large Language Model Optimizer) operations
- name: sandbox
description: Sandbox audit operations
- name: reports
description: Report generation and management operations

paths:
/audits/latest/{auditType}:
Expand Down Expand Up @@ -239,6 +241,10 @@ paths:
$ref: './llmo-api.yaml#/llmo-cdn-logs-filter'
/sites/{siteId}/sandbox/audit:
$ref: './sandbox-audit-api.yaml#/sandbox-audit'
/sites/{siteId}/reports:
$ref: './site-api.yaml#/site-reports'
/sites/{siteId}/reports/{reportId}:
$ref: './site-api.yaml#/site-report'

components:
securitySchemes:
Expand Down
89 changes: 89 additions & 0 deletions docs/openapi/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3575,3 +3575,92 @@ SandboxAuditResponse:
description: Array of audit results
items:
$ref: '#/SandboxAuditResult'

Report:
type: object
properties:
id:
$ref: '#/Id'
description: Unique identifier for the report
siteId:
$ref: '#/Id'
description: The site ID this report belongs to
reportType:
type: string
enum: [performance, accessibility, seo, security, conversion, cwv, optimization]
description: The type of report generated
example: 'performance'
status:
type: string
enum: [processing, success, failed]
description: Current status of the report
example: 'success'
reportPeriod:
type: object
properties:
startDate:
type: string
format: date
description: Start date for the report period
example: '2024-01-01'
endDate:
type: string
format: date
description: End date for the report period
example: '2024-01-31'
required: [startDate, endDate]
comparisonPeriod:
type: object
properties:
startDate:
type: string
format: date
description: Start date for comparison period
example: '2023-12-01'
endDate:
type: string
format: date
description: End date for comparison period
example: '2023-12-31'
required: [startDate, endDate]
storagePath:
type: string
description: Storage path for the report files
example: 'reports/550e8400-e29b-41d4-a716-446655440000/performance/550e8400-e29b-41d4-a716-446655440001/'
createdAt:
$ref: '#/DateTime'
description: When the report was initially created
updatedAt:
$ref: '#/DateTime'
description: When the report was last updated
updatedBy:
type: string
description: User or system that last updated the report
example: '[email protected]'
data:
type: object
description: Optional data containing presigned URLs for downloading reports (only present for successful reports)
properties:
rawPresignedUrl:
type: string
format: uri
description: Presigned URL for downloading the raw report data
example: 'https://s3.amazonaws.com/bucket/reports/raw/report.json?signature=...'
rawPresignedUrlExpiresAt:
type: string
format: date-time
description: Expiration time for the raw report presigned URL
example: '2024-01-22T10:30:00Z'
mystiquePresignedUrl:
type: string
format: uri
description: Presigned URL for downloading the enhanced report with AI insights
example: 'https://s3.amazonaws.com/bucket/reports/mystique/report.json?signature=...'
mystiquePresignedUrlExpiresAt:
type: string
format: date-time
description: Expiration time for the enhanced report presigned URL
example: '2024-01-22T10:30:00Z'
additionalProperties: false
required: [id, siteId, reportType, status, reportPeriod, createdAt, updatedAt]
additionalProperties: false
Loading