documentation improvements (#46)

PayHelper · Dec 5, 2017 · e8dedb5 · e8dedb5
1 parent 940ba68
commit e8dedb5
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/docs/api/source/includes/api/_auth.md b/docs/api/source/includes/api/_auth.md
@@ -31,7 +31,7 @@ This endpoint will return a json response with the token.
 
 ```shell
 curl -X GET \
-  https://localhost/api/v1/orders/
+  https://localhost/api/v1/subscriptions/
    -H "Authorization: Bearer key"\
   -H 'content-type: application/json'
 '

diff --git a/docs/api/source/includes/api/_subscriptions.md b/docs/api/source/includes/api/_subscriptions.md
@@ -425,6 +425,16 @@ Returns a list of all subscriptions.
 
 > Example Request
 
+```shell
+curl -X GET \
+  https://localhost/api/v1/subscriptions/
+   -H "Authorization: Bearer key"\
+  -H 'content-type: application/json'
+'
+```
+
+> Example Response (200)
+
 ```json
 {
     "page": 1,

diff --git a/docs/api/source/includes/api/_webhooks.md b/docs/api/source/includes/api/_webhooks.md
@@ -2,7 +2,7 @@
 
 These endpoints will allow you to easily manage webhooks.
 
-For example, imagine you want to send order's details to 3rd party application once the order has been created, or updated. Thanks to webhooks you can achieve it by creating a new webhook with the destination url to which the payload will be submitted.
+For example, imagine you want to send subscription's details to 3rd party application once the subscription has been created, or updated. Thanks to webhooks you can achieve it by creating a new webhook with the destination url to which the payload will be submitted.
 
 ## The webhook object
 
@@ -173,7 +173,7 @@ Returns an empty response if a valid identifier was provided, and returns an err
 DELETE https://localhost/api/v1/webhooks/{id}
 ```
 
-Deletes a webhook object. You need only supply the unique webhook identifier that was generated upon order creation in order to remove webhook.
+Deletes a webhook object. You need only supply the unique webhook identifier that was generated upon subscription creation in order to remove webhook.
 
 > Example Request
 

diff --git a/docs/api/source/includes/public_api/_payment_methods.md b/docs/api/source/includes/public_api/_payment_methods.md
@@ -35,7 +35,7 @@ These endpoints will allow you to list available payment methods.
 Field | Type | Description
 --------- | ------- | -------
 id | integer | Unique identifier for the object.
-code | string | Client facing order code
+code | string | Client facing method code
 position | integer | Position of payment method.
 supports_recurring | boolean | This boolean represents whether or not payment method supports recurring payments, `false` by default.
 translations | array | Translations.