Template:Web API - Revision history

WikiSysop at 15:38, November 6, 2023

2023-11-06T15:38:55Z

WikiSysop at 15:36, November 6, 2023

2023-11-06T15:36:04Z

WikiSysop at 15:35, November 6, 2023

2023-11-06T15:35:01Z

WikiSysop: Created page with " == Usage == Use this template to build page content via Cargo queries for a specific Web API. {{Web_API |name= Name of API |category= (optional) category to sort..."

2023-11-06T15:33:50Z

Created page with "<noinclude> == Usage == Use this template to build page content via Cargo queries for a specific Web API. {{Web_API |name= Name of API |category= (optional) category to sort..."

New page

<noinclude>
== Usage ==
Use this template to build page content via Cargo queries for a specific Web API.

{{Web_API
|name= Name of API
|category= (optional) category to sort API queries into
|apibasepath= base URL used for API requests
}}

Cargo queries will return all API requests and related info for the matching API name and category (if provided; otherwise category is ignored and all API requests are returned).

Swagger content API definition is broken into three parts for Cargo storage: API request details; API request parameters; API request responses.

<nowiki>
{{Web_API_Request
|apibasepath= base URL used for API requests
|apipath= added to base path to create the full API request URL
|apitype= DELETE, GET, POST, PUT
|category= (optional) category to sort API queries into
|summary= short description used in abbreviated form
|description= long description
|usage=
}}

{{Web_API_Parameter
|apibasepath= base URL used for API requests
|apipath= added to base path to create the full API request URL
|apitype= DELETE, GET, POST, PUT
|name=
|default=
|description=
|parametertype=
|datatype=
|required=
|example=
}}

{{Web_API_Response
|apibasepath= base URL used for API requests
|apipath= added to base path to create the full API request URL
|apitype= DELETE, GET, POST, PUT
|code=
|reason=
|example=
}}
</nowiki>

</noinclude>

=={{#if: {{{category}}} | {{{category}}} | {{{name}}} }}==
===Base path: {{apibasepath}}===

@@ Line 53: / Line 53: @@
 <includeonly>
 =={{#if: {{{category}}} | {{{category}}} | {{{name}}} }}==
-===Base path: {{apibasepath}}===
+===Base path: {{{apibasepath}}}===
 <!--

@@ Line 3: / Line 3: @@
 Use this template to build page content via Cargo queries for a specific Web API.
 {{Web_API
 |name= Name of API
@@ Line 8: / Line 9: @@
 |apibasepath= base URL used for API requests
 }}
 Cargo queries will return all API requests and related info for the matching API name and category (if provided; otherwise category is ignored and all API requests are returned).
@@ Line 13: / Line 15: @@
 Swagger content API definition is broken into three parts for Cargo storage: API request details; API request parameters; API request responses.
-<nowiki>
+<source>
 {{Web_API_Request
 |apibasepath= base URL used for API requests
@@ Line 45: / Line 47: @@
 |example=
 }}
-</nowiki>
+</source>
 </noinclude>