diff --git a/README.md b/README.md index 1266899..210d92d 100644 --- a/README.md +++ b/README.md @@ -23,51 +23,57 @@ Also, please bear in mind that B3 is a work in progress and can't (yet) be consi The B3 REST API Extensions plugin enables the following additional endpoints. -To make it easier to tell B3 extensions apart from the other endpoints, all of our additions are prepended by `b3:`. +To make it easier to tell B3 extensions apart from the other endpoints, all of our additions are prepended by `b3_`. ### Comments We provide an alternative implementation of the Comments resource that allows retrieving comments without having to know which post they belong to. -* `GET` `/b3:comments/` -* `GET` `/b3:comments//b3:replies` -* `POST` `/b3:comments//b3:replies` -* `GET` `/media//b3:replies` -* `POST` `/media//b3:replies` -* `GET` `/pages//b3:replies` -* `POST` `/pages//b3:replies` -* `GET` `/posts//b3:replies` -* `POST` `/posts//b3:replies` +* `GET` `/b3_comments/` +* `GET` `/b3_comments//b3_replies` +* `POST` `/b3_comments//b3_replies` +* `GET` `/media//b3_replies` +* `POST` `/media//b3_replies` +* `GET` `/pages//b3_replies` +* `POST` `/pages//b3_replies` +* `GET` `/posts//b3_replies` +* `POST` `/posts//b3_replies` ### Media This endpoint provides a way to fetch a media attachment by its slug. -* `GET` `/media/b3:slug:` +* `GET` `/media/b3_slug:` ### Posts This endpoint provides a way to fetch a post by its slug. -* `GET` `/posts/b3:slug:` +* `GET` `/posts/b3_slug:` ### Menus We provide endpoints to fetch all Menus registered by the theme as well as the menu items configured in the WordPress Admin. -* `GET` `/b3:menus` -* `GET` `/b3:menus/` +* `GET` `/b3_menus` +* `GET` `/b3_menus/` ### Sidebars Similar to Menus, we allow fetching all widget areas registered by the theme as well as their widgets and widget content. -* `GET` `/b3:sidebars` -* `GET` `/b3:sidebars/` +* `GET` `/b3_sidebars` +* `GET` `/b3_sidebars/` ### Settings Finally, this plugin exposes WordPress settings through the API. It wraps the `get_bloginfo()` function but exposes a few additional site options as well as the pretty permalinks table. -* `GET` `/b3:settings` -* `GET` `/b3:settings/