Skip to content

Commit

Permalink
Create Well-Known-Specification.md (GoogleChrome#121)
Browse files Browse the repository at this point in the history
* Create Well-Known-Specification.md
  • Loading branch information
sjledoux authored and cfredric committed Mar 11, 2024
1 parent 2ea2472 commit a20c07f
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions Well-Known-Specification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# The "related-website-set.json" Well-Known Resource Identifier

This page describes the use and content of URIs with the path
`/.well-known/related-website-set.json`.
## Use

A site may demonstrate intentional opt-in to participation in a Related Website
Set (RWS) by hosting a specific JSON file at the URI with a path of
`/.well-known/related-website-set.json`.
## Content

The `/.well-known/related-website-set.json` file for the set primary of an RWS
must follow the schema specified below:
```json
{
"type": "object",
"properties": {
"ccTLDs": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"primary": { "type": "string" },
"associatedSites": {
"type": "array",
"items": {
"type": "string"
}
},
"serviceSites": {
"type": "array",
"items": {
"type": "string"
}
},
"rationaleBySite": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": ["primary"],
"dependentRequired": {
"associatedSites": ["An explanation of how you clearly present the
affiliation across domains to users and why users would expect your
domains to be affiliated"],
"serviceSites": ["An explanation of how each domain in this subset
supports functionality or security needs."]
}
}
```
The `/.well-known/related-website-set.json` file for non-primary members of an
RWS must follow the schema specified below:
```json
{
"type": "object",
"properties": {
"primary": { "type": "string" }
},
"required": ["primary"]
}
```

0 comments on commit a20c07f

Please sign in to comment.