Skip to content
This repository was archived by the owner on Oct 16, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 10 additions & 10 deletions docs/draft/change-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To get a single **user** representation:
.. code-block:: http

GET /users/42 HTTP/1.1
Host: api.compat.mozilla.org
Host: developer.mozilla.org/compat/api
Accept: application/vnd.api+json

A sample response is:
Expand All @@ -58,7 +58,7 @@ A sample response is:
},
"links": {
"users.changesets": {
"href": "https://api.compat.mozilla.org/changesets/{users.changesets}",
"href": "https://developer.mozilla.org/compat/api/changesets/{users.changesets}",
"type": "changesets"
}
}
Expand All @@ -69,7 +69,7 @@ If a client is authenticated, the logged-in user's account can be retrieved with
.. code-block:: http

GET /users/me HTTP/1.1
Host: api.compat.mozilla.org
Host: developer.mozilla.org/compat/api
Accept: application/vnd.api+json

Changesets
Expand Down Expand Up @@ -113,7 +113,7 @@ To get a single **changeset** representation:
.. code-block:: http

GET /changeset/73 HTTP/1.1
Host: api.compat.mozilla.org
Host: developer.mozilla.org/compat/api
Accept: application/vnd.api+json

A sample response is:
Expand Down Expand Up @@ -143,27 +143,27 @@ A sample response is:
},
"links": {
"changesets.user": {
"href": "https://api.compat.mozilla.org/users/{changesets.user}",
"href": "https://developer.mozilla.org/compat/api/users/{changesets.user}",
"type": "users"
},
"changesets.browsers-history": {
"href": "https://api.compat.mozilla.org/browsers-history/{changesets.browsers-history}",
"href": "https://developer.mozilla.org/compat/api/browsers-history/{changesets.browsers-history}",
"type": "browsers-history"
},
"changesets.browser-versions-history": {
"href": "https://api.compat.mozilla.org/browser-versions-history/{changesets.browser-versions-history}",
"href": "https://developer.mozilla.org/compat/api/browser-versions-history/{changesets.browser-versions-history}",
"type": "browser-versions-history"
},
"changesets.features-history": {
"href": "https://api.compat.mozilla.org/features-history/{changesets.features-history}",
"href": "https://developer.mozilla.org/compat/api/features-history/{changesets.features-history}",
"type": "features-history"
},
"changesets.feature-sets-history": {
"href": "https://api.compat.mozilla.org/feature-sets-history/{changesets.feature-sets-history}",
"href": "https://developer.mozilla.org/compat/api/feature-sets-history/{changesets.feature-sets-history}",
"type": "feature-sets-history"
},
"changesets.browser-version-features-history": {
"href": "https://api.compat.mozilla.org/browser-version-features-history/{changesets.browser-version-features-history}",
"href": "https://developer.mozilla.org/compat/api/browser-version-features-history/{changesets.browser-version-features-history}",
"type": "browser-version-features-history"
}
}
Expand Down
8 changes: 4 additions & 4 deletions docs/draft/entrypoints.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Entrypoints
-----------

The API will be reachable at https://api.compat.mozilla.org. A non-SSL
version will be reachable at http://api.compat.mozilla.org, and will
The API will be reachable at https://developer.mozilla.org/compat/api. A non-SSL
version will be reachable at http://developer.mozilla.org/compat/api, and will
redirect to the SSL version. This site is for applications that read,
create, update, and delete compatibility resources. It includes a
browsable API to ease application development, but not full documentation.
Expand All @@ -18,8 +18,8 @@ The API supports user accounts with Persona_ authentication. Persona
credentials can be exchanged for an `OAuth 2.0`_ token for server-side code
changes.

A developer-centered website will be available at <https://compat.mozilla.org>.
A non-SSL version will be available at <http://compat.mozilla.org> and will
A developer-centered website will be available at <https://developer.mozilla.org/compat>.
A non-SSL version will be available at <http://developer.mozilla.org/compat> and will
redirect to the HTTPS version. This site is for documentation, example code,
and example presentations.

Expand Down
6 changes: 3 additions & 3 deletions docs/draft/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To get a single **browsers-history** representation:
.. code-block:: http

GET /browsers-history/1002 HTTP/1.1
Host: api.compat.mozilla.org
Host: developer.mozilla.org/compat/api
Accept: application/vnd.api+json

A sample response is:
Expand Down Expand Up @@ -70,11 +70,11 @@ A sample response is:
},
"links": {
"browsers-history.browser": {
"href": "https://api.compat.mozilla.org/browser-history/{browsers-history.browser}",
"href": "https://developer.mozilla.org/compat/api/browser-history/{browsers-history.browser}",
"type": "browsers"
},
"browsers-history.changeset": {
"href": "https://api.compat.mozilla.org/changesets/{browsers-history.changeset}",
"href": "https://developer.mozilla.org/compat/api/changesets/{browsers-history.changeset}",
"type": "changeset"
}
}
Expand Down
17 changes: 7 additions & 10 deletions docs/draft/issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,16 +125,13 @@ Unresolved Issues
test conflicts, etc. It might be easier to move all those wishlist items to
a different project, that talks to this API when it's ready to assert
browser support for a feature.
* groovecoder says that api.compat.mozilla.org is a non-starter with Mozilla
IT - too hard to provision a new domain. He suggests a subpath under
developer.mozilla.org. Should we go with:

1. https://api.compat.mozila.org and https://compat.mozilla.org
2. https://developer.mozilla.org/compat-api and
https://developer.mozilla.org/en-US/compat-api
3. https://api.compat.developer.mozilla.org and
https://compat.developer.mozilla.org
4. Something else?
* groovecoder says that api.compat.mozilla.org is harder to coordinate with
Mozilla IT. He suggests a subpath under developer.mozilla.org like the
`django-rest-framework search API
<https://developer.mozilla.org/en-US/docs/MDN/User_guide/Advanced_search>`_:

https://developer.mozilla.org/en-US/compat/api



Interesting MDN Pages
Expand Down
Loading