xdrm-brackets
/
xdrm-framework
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

upd: notice.api:3.0 (updated links (to test))

This commit is contained in:
xdrm-brackets 2017-12-12 23:57:19 +01:00
parent a23fbce67d
commit 712de89e4b
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
notice/api/3.0.md
View File

@ -16,15 +16,24 @@ Plan
[**II.** Usage](#ii-usage) [**II.** Usage](#ii-usage)
- [**1** Setup](#1-setup) - [**1** REST API](#1-rest-api)
- [**2** Php requirements](#2-php-requirements) - [**2** Internal use (PHP)](#2-internal-use)
- [**3** From php internally](#3-from-php-internally)
- [**4** From HTTP requests](#4-from-http-requests)
[**III.** Configuration](#iii-configuration) [**III.** Configuration](#iii-configuration)
- [**1** Basic usage](#1-basic-usage) - [**1** Configuration format](#1---configuration-format)
- [**2** Advanced usage](#2-advanced-usage) - [**2** Method definition](#2---methoddefinition)
- [**2.1** Method description](#21---methoddescription)
- [**2.2** Method permissions](#22---methodpermissions)
- [**2.3** Method parameters](#23---methodparameters)
- [parameter name](#parametername)
- [parameter description](#parameterdescription)
- [parameter type](#parameterchecker_type)
- [parameter optional vs. required](#parameteris_optional)
- [parameter rename](#parameterrename)
- [parameter default value](#parameterdefault_value)
- [**2.4** Method output format](#24---methodoutput_format)
- [**2.5** Method options](#25---methodoptions)
[**IV.** Implementation](#iv-implementation) [**IV.** Implementation](#iv-implementation)