You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -3,16 +3,16 @@ Wordpress Multisite JSON API
3
3
============================
4
4
This is a Wordpress Plugin that adds JSON endpoints for creating, listing, and deleting sites on multisite.
5
5
6
-
This plugin aims to be simple to make Wordpress polyglot environments not only possible, but practical. I'm not the best at PHP, ruby and Go are more my thing, hence why I'm making this API. Contributions are greatly appreciated.
6
+
This plugin aims to be simple to make Wordpress polyglot environments not only possible, but practical. I'm not the best at PHP, Ruby and Go are more my thing, hence why I'm making this API. Contributions are greatly appreciated.
7
7
8
8
Status
9
9
------
10
-
***TODO**: Add some configuration options
11
-
***TODO**: Add `full-stack-test.php` to make a MySQL connection and verify the whole stack loads, faster and more efficient than trying to do a full page rendering for your uptime checks.
10
+
***TODO**: Add some configuration options.
11
+
***TODO**: Add `full-stack-test.php` to make a MySQL connection and verify the whole stack loads faster and more efficient than trying to do a full page rendering for your uptime checks.
12
12
13
13
PHP Versions
14
14
------------
15
-
This is theoretically compatible with PHP 5.4 and higher. However, upgrading to phpunit 8 required that I make tests require PHP 7.2+. So its probably still fine to run this on something less than 7.2, but since I can't get working tests on that version, I don't recommend it.
15
+
This is theoretically compatible with PHP 5.4 and higher. However, upgrading to phpunit 8 required that I make tests require PHP 7.2+. So, it's probably still fine to run this on something less than 7.2, but since I can't get working tests on that version, I don't recommend it.
Also, as of right now all user names and password are passed through http Headers. That means SSL is pretty much mandatory.
41
+
Also, as of right now all user names and passwords are passed through HTTP headers. That means SSL is pretty much mandatory.
42
42
43
43
API Documentation
44
44
=================
@@ -47,14 +47,14 @@ Authentication
47
47
--------------
48
48
All of the enpoints require you to authenticate with an existing wordpress user. Currently all require the superadmin role, but that may change.
49
49
50
-
Username and password are passed with the HTTP Headers`User` and `Password` respectively. These are plain text so you need to be using SSL (which you are doing already right?).
50
+
Username and password are passed with the HTTP headers`User` and `Password` respectively. These are plain text so you need to be using SSL (which you are doing already right?).
-**Description:** Creates a site. If the email address does not exist this will create a new user with that email address. The `site_name` is the path or subdomain you would like to use, password os optional, if not set will fallback to a random generated one.
57
+
-**Description:** Creates a site. If the email address does not exist this will create a new user with that email address. The `site_name` is the path or subdomain you would like to use, password is optional, if not set will fallback to a random generated one.
-**Description:** Deletes a site. If `drop` is set to `true` wordpress will remove the site from the database completely. Otherwise the only thing this does is set the `deleted` attribute on the site to `true`.
72
+
-**Description:** Deletes a site. If `drop` is set to `true`, wordpress will remove the site from the database completely. Otherwise, the only thing this does is to set the `deleted` attribute on the site to `true`.
0 commit comments