Template: SwaggerAPI

Usage

Syntax

{{SwaggerAPI|Method=<method>|Resource=<resource>}}

Important

If your Resource ends with a curly brace, please include a space before closing the template with two curly braces (}}). This Template ends as soon as it sees two consecutive curly braces, and any characters after that are assumed to be outside the SwaggerAPI template. Illustrated in examples, below.

Supported Methods

• POST
• GET
• PATCH
• PUT
• DELETE

Examples

{{SwaggerAPI|Method=POST|Resource=/api/v2/knowledge/knowledgebases/{knowledgebaseId} }} {{SwaggerAPI|Method=GET|Resource=/api/v2/knowledge/knowledgebases/{knowledgebaseId} }} {{SwaggerAPI|Method=PATCH|Resource=/api/v2/knowledge/knowledgebases/{knowledgebaseId} }} {{SwaggerAPI|Method=PUT|Resource=/api/v2/knowledge/knowledgebases/{knowledgebaseId} }} {{SwaggerAPI|Method=DELETE|Resource=/api/v2/knowledge/knowledgebases/{knowledgebaseId} }}

Results

POST

/api/v2/knowledge/knowledgebases/{knowledgebaseId}

GET

/api/v2/knowledge/knowledgebases/{knowledgebaseId}

PATCH

/api/v2/knowledge/knowledgebases/{knowledgebaseId}

PUT

/api/v2/knowledge/knowledgebases/{knowledgebaseId}

DELETE

/api/v2/knowledge/knowledgebases/{knowledgebaseId}

Underlying Wikitext

{{#switch: {{{Method}}}
 | POST = {{{!}} class="wikitable" style="border-style:solid; border-width: 2px; border-color: #49cc90; background: rgba(73,204,144,.1);" 
{{!}}-
{{!}} style="color: #fff; background-color: #49cc90; text-align: left" {{!}}'''{{{Method}}}'''<br />
{{!}}-
{{!}}'''{{{Resource}}}'''<br />
{{!}}}
 | GET = {{{!}} class="wikitable" style="border-style:solid; border-width: 2px; border-color: #61affe; background: rgba(97,175,254,.1);" 
{{!}}-
{{!}} style="color: #fff; background-color: #61affe; text-align: left" {{!}}'''{{{Method}}}'''<br />
{{!}}-
{{!}}'''{{{Resource}}}'''<br />
{{!}}}
 | PATCH = {{{!}} class="wikitable" style="border-style:solid; border-width: 2px; border-color: #50e3c2; background: rgba(80,227,194,.1);" 
{{!}}-
{{!}} style="color: #fff; background-color: #50e3c2; text-align: left" {{!}}'''{{{Method}}}'''<br />
{{!}}-
{{!}}'''{{{Resource}}}'''<br />
{{!}}}
 | PUT = {{{!}} class="wikitable" style="border-style:solid; border-width: 2px; border-color: #fca130; background: rgba(252,161,48,.1);" 
{{!}}-
{{!}} style="color: #fff; background-color: #fca130; text-align: left" {{!}}'''{{{Method}}}'''<br />
{{!}}-
{{!}}'''{{{Resource}}}'''<br />
{{!}}}
 | DELETE = {{{!}} class="wikitable" style="border-style:solid; border-width: 2px; border-color: #f93e3e; background: rgba(249,62,62,.1);" 
{{!}}-
{{!}} style="color: #fff; background-color: #f93e3e; text-align: left" {{!}}'''{{{Method}}}'''<br />
{{!}}-
{{!}}'''{{{Resource}}}'''<br />
{{!}}}
}}