Fill the title and the description of the request respectively in the title and the content of the page.
Choose the “REST API docs” as parent.
Choose the “API” as template.
Choose the order value regarding the API page lists.

Then you have to fill some “WordPress Custom Fields”:

Method

  • HTTP Method: POST | GET | DELETE | PUT
  • HTTP URI: URI of the resource with parameter in bracets
    • (e.g. “/rest/experiment/{expId}”)
  • URI Parameter: URI parameter name and description separated with “:”
    • (e.g. “expId : Experiment ID”)
    • multiple custom field allowed
  • Authentication: admin | user | none


  • Request Input Type: text | JSON | JSON File (only for multipart requests)
  • Request Input: exemple of request input value
    • (e.g. the JSON as string)
  • Request Input Note: request input description
  • Request is Multipart (only for multipart requests): true
  • File Input Type (only for multipart requests): Firmware File | Firmware File(s)
  • File Input Note (only for multipart requests): file(s) content description


  • Response Type: JSON | text
  • Response: exemple of response value
    • (e.g. the JSON as string)
  • Response Note: response description
  • HTTP Response: HTTP response number, name and description separated with “:”
    • (e.g. “400 : BAD REQUEST : Syntax problem with the JSON representing the list of nodes”)
    • multiple custom field allowed

Here is an exemple to show where and how values are displayed:


Page title

Page content

‘HTTP Method’ ‘HTTP URI’

URI Parameters

Property Description
‘URI Parameter’ 1 (part before the “:”) ‘URI Parameter’ 1 (part after the “:”)
‘URI Parameter’ 2 (part before the “:”) ‘URI Parameter’ 2 (part after the “:”)
‘URI Parameter’ 3 (part before the “:”) ‘URI Parameter’ 3 (part after the “:”)

Authentication

  • ‘Authentication’

Request input(s)

  • ‘Request Input Type’
'Request Input'

‘Request Input Note’


  • ‘File Input Type’ (only if ‘Request is Multipart’ is set to ‘true’)

‘File Input Note’ (only if ‘Request is Multipart’ is set to ‘true’)

Response

  • ‘Response Type’
'Response'

‘Response Note’

HTTP Responses

HTTP Status Name Description
‘HTTP Response’ 1
(part before the first “:”)
‘HTTP Response’ 1
(part between the first “:” and the second)
‘HTTP Response’ 1
(part after the second “:” if exists)
‘HTTP Response’ 2
(part before the first “:”)
‘HTTP Response’ 2
(part between the first “:” and the second)
‘HTTP Response’ 2
(part after the second “:” if exists)