TenantAtlas/specs/401-tenantial-platform-page/contracts/public-routes.openapi.yaml
Ahmed Darrazi b83049462c
Some checks failed
PR Fast Feedback / fast-feedback (pull_request) Failing after 1m21s
refactor(website): rename product page to platform and update navigation
2026-05-19 23:25:59 +02:00

93 lines
2.9 KiB
YAML

openapi: 3.1.0
info:
title: Tenantial Platform Public Route Contract
version: 0.1.0
description: >
Static public website route contract for Spec 401. These are HTML page
routes, not backend application APIs.
servers:
- url: https://tenantial.example
paths:
/platform:
get:
summary: Render the canonical Tenantial Platform page
operationId: getTenantialPlatformPage
tags:
- Public Website
responses:
"200":
description: Canonical Platform page renders successfully.
content:
text/html:
schema:
type: string
examples:
requiredContent:
summary: Required visible content signals
value: >
TENANTIAL PLATFORM. Govern Microsoft tenants through
evidence, drift context, and reviewable decisions.
x-route-contract:
canonicalPath: /platform
sitemap: true
requiredVisibleText:
- TENANTIAL PLATFORM
- Govern Microsoft tenants through evidence
- Backup
- Restore
- Drift Detection
- Findings
- Evidence
- Audit Trail
- Exceptions
- Governance Reviews
- Built for governance of record
forbiddenVisibleText:
- AstroDeck
- TemplateDeck
- Open Source
- MIT
- TenantAtlas
- TenantPilot
- TenantCTRL
requiredMetadata:
titleIncludes:
- Tenantial Platform
- Evidence-first governance
descriptionIncludes:
- backup
- restore
- drift detection
- findings
- evidence
- audit trails
- exceptions
- reviews
requiredAccessibility:
onePrimaryHeading: true
keyboardAccessibleCtas: true
noColorOnlyMeaning: true
noBodyHorizontalOverflow: true
/product:
get:
summary: Redirect product route compatibility to the canonical Platform page
operationId: getProductCompatibilityRoute
tags:
- Public Website
responses:
"301":
description: Compatibility route redirects permanently to /platform.
"302":
description: Compatibility route redirects temporarily to /platform if the current static build cannot emit a permanent redirect.
x-route-contract:
canonicalPath: /platform
primaryNavigationTarget: false
allowedBehaviors:
- redirectToPlatform
forbiddenBehavior:
- renderEquivalentPlatformContentWithCanonicalPlatformMetadata
- exposeStaleProductCopy
- exposeConflictingCanonicalMetadata
- remainPrimaryPlatformNavigationTarget
smokeCoverageRequired: true