Merge pull request #689 from seamuslee001/api_menu_restructure

Refactor the API menu structure in preparation for APIv4 docs

docs/api/index.md

@@ -53,4 +53,4 @@ From CiviCRM v5.8 the APIv3 explorer will now be able to show examples that are
 
 ## Changelog
 
-All important changes made to the API are recorded in [API changes](/api/changes.md).
+All important changes made to the APIv3 are recorded in [APIv3 changes](/api/v3/changes.md).

docs/api/interfaces.md

@@ -75,7 +75,7 @@ The recommended AJAX interface has changed between CiviCRM versions as follows:
 * version 4.3.x - `CRM.api(...)`
 * version 4.4.x onwards - `CRM.api3()`
 
-For details see [API changes](/api/changes.md).
+For details see [APIv3 changes](/api/v3/changes.md).
 
 ### Javascript AngularJS crmAPI {:#angularjs}
 

docs/api/changes.md → docs/api/v3/changes.md

@@ -338,7 +338,7 @@ When creating a new Case record, the "create" API previously accepted `case_type
 
 ### 4.3.0: Deprecate Constant API
 
-Most `CRM_*_Pseudoconstant methods` (which the 'constant' api is a wrapper for) are deprecated in 4.3 and many are removed in 4.4. To future-proof your code, use the [api.getoptions](/api/actions.md#getoptions) method instead of the constant api. See [Pseudoconstant (option list) Reference](/framework/pseudoconstant.md)
+Most `CRM_*_Pseudoconstant methods` (which the 'constant' api is a wrapper for) are deprecated in 4.3 and many are removed in 4.4. To future-proof your code, use the [api.getoptions](/api/v3/actions.md#getoptions) method instead of the constant api. See [Pseudoconstant (option list) Reference](/framework/pseudoconstant.md)
 
 ### 4.3.0: Contact get API now respects ACLS
 

docs/api/joins.md → docs/api/v3/joins.md

@@ -7,7 +7,7 @@ addresses, you may want to return the name of the associated contact from the
 Contact entity.
 
 The CiviCRM API supports two methods of returning data from associated entities;
-API Joins and [API Chaining](/api/chaining.md).  API joins provide higher
+API Joins and [APIv3 Chaining](/api/v3/chaining.md).  API joins provide higher
 performance by making a single SQL query with a
 [SQL join](https://dev.mysql.com/doc/refman/5.7/en/join.html), and are
 generally preferable to API chaining where available.
@@ -43,8 +43,8 @@ $result = civicrm_api3('Event', 'get', array(
 ));
 ```
 !!! tip
-    Joins are available only with the [get](/api/actions.md#getfields),
-    [getsingle](/api/actions.md#getsingle), and [getcount](/api/actions.md#getcount)
+    Joins are available only with the [get](/api/v3/actions.md#getfields),
+    [getsingle](/api/v3/actions.md#getsingle), and [getcount](/api/v3/actions.md#getcount)
     actions.
 
 ## Identifying fields eligible for a join
@@ -52,7 +52,7 @@ $result = civicrm_api3('Event', 'get', array(
 It is possible to join an entity to any other entity if the
 [xml schema](/framework/database/schema-definition.md)
 identifies a [foreign key](/framework/database/schema-definition.md#table-foreignKey) or
-a [pseudoconstant](/framework/database/schema-definition.md#table-field-pseudoconstant).  The [getfields](/api/actions.md#getfields) action identifies
+a [pseudoconstant](/framework/database/schema-definition.md#table-field-pseudoconstant).  The [getfields](/api/v3/actions.md#getfields) action identifies
 fields that are eligible for an API join.
 
 !!! warning

docs/api/options.md → docs/api/v3/options.md

 # API Options
 
-There are many API Options accepted by the CiviCRM API. These options allow the developer to add in more parameters to the resulting Query that is run against the database. E.g. Limit, Sort. You can explore these options using the the [API Explorer](/api/index.md#api-explorer) and the [API Examples](/api/examples.md) However, some parameters are particularly dynamic or generic; these may not be explained well by the auto-generated documentation. The format for passing options as parameters using the REST interface is explained at [REST interface](/api/interfaces.md#rest).
+There are many API Options accepted by the CiviCRM API. These options allow the developer to add in more parameters to the resulting Query that is run against the database. E.g. Limit, Sort. You can explore these options using the the [API Explorer](/api/index.md#api-explorer) and the [APIv3 Examples](/api/v3/examples.md) However, some parameters are particularly dynamic or generic; these may not be explained well by the auto-generated documentation. The format for passing options as parameters using the REST interface is explained at [REST interface](/api/interfaces.md#rest).
 
 
 ## sequential

docs/hooks/hook_civicrm_apiWrappers.md

@@ -18,7 +18,7 @@ Introduced in CiviCRM 4.4.0.
 ## Parameters
 
 - API_Wrapper[] $wrappers - an array of objects which implement the [`API_Wrapper`](#wrapper-class) interface.
-- array $apiRequest - contains keys 'entity', 'action', and params; see [API Usage](/api/usage.md).
+- array $apiRequest - contains keys 'entity', 'action', and params; see [APIv3 Usage](/api/v3/usage.md).
 
 ## Returns
 

mkdocs.yml

@@ -46,16 +46,26 @@ pages:
     - Creating a Payment Processor: extensions/payment-processors/create.md
   - CMS-specific development: extensions/cms-specific.md
 - API:
-  - APIv3 Intro: api/index.md
-  - APIv3 Usage: api/usage.md
-  - APIv3 Actions: api/actions.md
-  - APIv3 Options: api/options.md
-  - APIv3 Joins: api/joins.md
-  - APIv3 Chaining: api/chaining.md
-  - APIv3 Custom Data: api/custom-data.md
-  - APIv3 Examples: api/examples.md
-  - APIv3 Interfaces: api/interfaces.md
-  - APIv3 Changes: api/changes.md
+  - API Intro: api/index.md
+  - API Interfaces: api/interfaces.md
+  #- APIv4:
+  #  - APIv4 Usage: api/v4/usage.md
+  #  - APIv4 Actions: api/v4/actions.md
+  #  - APIv4 Options: api/v4/options.md
+  #  - APIv4 Joins: api/v4/joins.md
+  #  - APIv4 Chaining: api/v4/chaining.md
+  #  - APIv4 Custom Data: api/v4/custom-data.md
+  #  - APIv4 Examples: api/v4/examples.md
+  #  - APIv4 Changes: api/v4/changes.md
+  - APIv3:
+    - APIv3 Usage: api/v3/usage.md
+    - APIv3 Actions: api/v3/actions.md
+    - APIv3 Options: api/v3/options.md
+    - APIv3 Joins: api/v3/joins.md
+    - APIv3 Chaining: api/v3/chaining.md
+    - APIv3 Custom Data: api/v3/custom-data.md
+    - APIv3 Examples: api/v3/examples.md
+    - APIv3 Changes: api/v3/changes.md
 - Hooks:
   - Hooks Introduction: hooks/index.md
   - Usage: