diff --git a/docs/geting_further/endpoints_structure.md b/docs/geting_further/endpoints_structure.md new file mode 100644 index 0000000..cefa1c2 --- /dev/null +++ b/docs/geting_further/endpoints_structure.md @@ -0,0 +1,45 @@ +--- +layout: page +title: Endpoints Structure +permalink: /getting-further/endpoints/ +parent: Getting Further +nav_order: 1 +--- + +| Name | Desc | Examples | +|-------------------|---------------------|-------------------------------------------| +| protocol | Endpoint's protocol | http | +| method | Endpoint's Method | POST | +| url | Base URL + Path | https://testapp.internal.domains/comments | +| params | Parameters (Array) | [] | +| params.name | Parameter's name | title | +| params.param_type | Parameter's type | json | +| params.value | Parameter's value | this_is_value | + +```json +[ + ... + { + "method": "POST", + "params": [ + { + "name": "article_slug", + "param_type": "json", + "value": "" + }, + { + "name": "title", + "param_type": "json", + "value": "" + }, + { + "name": "id", + "param_type": "json", + "value": "" + } + ], + "protocol": "http", + "url": "https://testapp.internal.domains/comments" + } +] +``` \ No newline at end of file diff --git a/docs/geting_further/json.md b/docs/geting_further/json.md deleted file mode 100644 index c2a2540..0000000 --- a/docs/geting_further/json.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: page -title: JSON Structure -permalink: /getting-further/json/ -parent: Getting Further -nav_order: 1 ---- - -```json -[ - ... - { - "headers": [], - "method": "POST", - "params": [ - { - "name": "article_slug", - "param_type": "json", - "value": "" - }, - { - "name": "title", - "param_type": "json", - "value": "" - }, - { - "name": "id", - "param_type": "json", - "value": "" - } - ], - "protocol": "http", - "url": "https://testapp.internal.domains/comments" - } -] -``` \ No newline at end of file