Template:REST Operations

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
Line 6: Line 6:
 
|REST_op_description=
 
|REST_op_description=
 
|REST_op_method=
 
|REST_op_method=
 +
|REST_resource=
 
|REST_op_uri=
 
|REST_op_uri=
 
|REST_op_params=
 
|REST_op_params=
Line 21: Line 22:
 
! Description
 
! Description
 
| {{{REST_op_description|}}}
 
| {{{REST_op_description|}}}
 +
|-
 +
! Resource
 +
| {{{REST_resource|}}}
 
|-
 
|-
 
! Method
 
! Method
Line 47: Line 51:
 
|}
 
|}
  
{{#if: {{PAGENAME}} == {{FULLPAGENAME}} |
+
{{#if: {{PAGENAME}} == "API_{{{REST_resource|}}}" |
 
   {{#if:{{{REST_op_status|}}} |
 
   {{#if:{{{REST_op_status|}}} |
 
     {{#set: |Has status code={{{REST_op_status|}}} }}
 
     {{#set: |Has status code={{{REST_op_status|}}} }}
Line 53: Line 57:
 
   {{#set: |Has output media type={{{REST_op_mime_output|}}} }}
 
   {{#set: |Has output media type={{{REST_op_mime_output|}}} }}
 
| }}
 
| }}
 +
 +
Resource: [API_{{{REST_resource|}}}]
  
 
[[Category:REST_API]]
 
[[Category:REST_API]]

Revision as of 11:16, 7 October 2011

This is the "REST_Operations" template. It should be called in the following format:

{{REST_Operations
|REST_op_description=
|REST_op_method=
|REST_resource=
|REST_op_uri=
|REST_op_params=
|REST_header_param=subjectid:SECURITY-TOKEN
|REST_op_result=
|REST_op_status=
|REST_op_mime_input=
|REST_op_mime_output=
|REST_op_example=
}}

Edit the page to see the template text.

Personal tools