Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Well-known warg path #236

Open
lann opened this issue Dec 21, 2023 · 0 comments
Open

Well-known warg path #236

lann opened this issue Dec 21, 2023 · 0 comments

Comments

@lann
Copy link
Collaborator

lann commented Dec 21, 2023

RFC 8615 specifies a pattern for HTTP-based service discovery in the form of "well known" paths like /.well-known/<service name>.

Warg API services can use this mechanism to a) help clients positively identify a domain as being a Warg host and b) provide endpoint configuration.

Akin to RFC 8555's "Directory object" we can specify that a domain hosting a Warg service must serve https://<domain>/.well-known/warg/endpoints.json with a JSON document containing a set of endpoint URLs. The set of endpoints would be TBD but for example:

GET https://registry.example.com/.well-known/warg/endpoints.json

{
  // Transparency services with base URL `https://registry.example.com/warg/v1/transparency/...`
  "transparency": "/warg/v1/transparency",
  // Content services with base URL `https://warg-content.example.com/v1/...`
  "content": "https://warg-content.example.com/v1"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant