[DX-981] Update data-graphs-api.md (#3960)

fixed order added sample request ---------
TykTechnologies · Jan 23, 2024 · 52e159f · 52e159f
1 parent 530e6b5
commit 52e159f
Showing 1 changed file with 44 additions and 21 deletions.
diff --git a/tyk-docs/content/tyk-apis/tyk-dashboard-api/data-graphs-api.md b/tyk-docs/content/tyk-apis/tyk-dashboard-api/data-graphs-api.md
@@ -9,12 +9,14 @@ menu:
 weight: 1
 ---
 
-Currently `/api/data-graphs/` has only one endpoint called `/data-sources` with only `POST` HTTP method.
+Currently `/api/data-graphs/` has only one endpoint called `/data-sources` with only a `POST` HTTP method.
 
 ## Import an AsyncAPI Document
 
 The Dashboard exposes the `/api/data-graphs/data-sources/import` Dashboard API which allows you to import an [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0) or [OpenAPI](https://swagger.io/specification/) document.
 
+### Request structure
+
 | **Property** | **Description**                                       |
 |--------------|-------------------------------------------------------|
 | Resource URL | `/api/data-graphs/data-sources/import`                |
@@ -25,6 +27,47 @@ As shown in the table above, you should provide a JSON payload ("body") with the
 * `type` - document type, valid document types are `asyncapi` and `openapi`.
 * `data` - AsyncAPI or OpenAPI document. Note: This string of characters needs to be "[stringified](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify)" (converting an object to its JSON (JavaScript Object Notation) string representation).
 
+#### 
+```curl
+curl --location 'http://tyk-dashboard.localhost:3000/api/data-graphs/data-sources/import' \
+--header 'Accept: application/json' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: <API KAY>' \
+--data '{
+    "type": "asyncapi",
+    "data": "{\"apisync\": \"v3.0.0\", \"info\": {}
+    <TO SIMPLIFY, WE SHOW ONLY THE FIRST FEW LINES FROM THE ASYNC API DOCUMENT>}"
+}'
+```
+
+### Supported AsyncAPI versions
+* 2.0.0
+* 2.1.0
+* 2.3.0
+* 2.4.0
+
+### Supported OpenAPI versions
+* 3.0.0
+
+### Response structure
+The same as in other endpoints
+
+| **Property** | **Description**                                       |
+|--------------|-------------------------------------------------------|
+| Status       | `Error` or `OK`                                       |
+| Message      | Verbal explanation                                    |
+| Meta         | API Id for success and `null` with error (not in use) |
+
+#### Sample Response
+
+```json
+{
+    "Status": "OK",
+    "Message": "Data source imported",
+    "Meta": "64102568f2c734bd2c0b8f99"
+}
+```
+
 ### Suggestion for "stringifying" with *Postman*
 If you use *Postman*, you can write a little Javascript code in the "Pre-request Script" and stringify the document.
 
@@ -50,23 +93,3 @@ console.log(pm.environment.get("asyncapi_document"))
 ```
 "{ \n        \"apisync\": \"v3.0.0\",\n        \"info\": {}\n     }"
 ```
-
-
-### Supported AsyncAPI versions
-* 2.0.0
-* 2.1.0
-* 2.3.0
-* 2.4.0
-
-### Supported OpenAPI versions
-* 3.0.0
-
-### Sample Response
-
-```json
-{
-    "Status": "OK",
-    "Message": "Data source imported",
-    "Meta": "64102568f2c734bd2c0b8f99"
-}
-```