Skip to content
This repository has been archived by the owner on Aug 14, 2019. It is now read-only.

Add "dashboard" namespace prefix #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

rmccue
Copy link
Member

@rmccue rmccue commented May 10, 2017

For Dashboard-specific endpoints, we should add a new namespace prefix of dashboard/

Proposal

@rmccue
Copy link
Member Author

rmccue commented May 10, 2017

Discussion in Slack for the API meeting.

  • wp/dashboard/v1 fits with the existing reserved namespace of wp, but doesn't fit with precedent
  • wp/ is a strong signal that the endpoints are part of core, but we already have oembed/
  • dashboard/ would be for internal, dashboard-only endpoints not for use by general API clients
  • Core is basically split into two parts, core stuff, and "Dashboard App" specific pieces
  • Dashboard endpoints will probably be used outside of dashboard context no matter what we do
  • wp/ can be too strong a signal, since we're not modelling core data types and it might not be RESTful anyway
  • "admin" vs "dashboard": "dashboard" is an intentionally broader term, covers things like the Customiser which aren't in the admin, but are part of the "Dashboard App"

@rmccue
Copy link
Member Author

rmccue commented May 17, 2017

WP40748 tracks the addition of an endpoint for the Community Events data in the dashboard, which would use this namespace.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant