copenhagentruckwash/api
1
0
Fork 0
Code Issues Pull Requests 1 Actions 2 Packages Projects Releases Wiki Activity

Add API reference topics for XLVask OpenAPI v1

Browse Source 
Added documentation topics for API endpoints related to `/Customers` and `/Vehicles` with GET, POST, PUT, and DELETE methods. Included a general API Reference topic and updated redirection rules for removed structure pages.
This commit is contained in:
Jepp9350
2025-05-06 12:13:47 +02:00
parent b1ba8a2e34
commit 22562be135
11 changed files with 115 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Writerside/redirection-rules.xml
+25
View File
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
<rules>
<!-- format is as follows
<rule id="<unique id>">
<accepts>page.html</accepts>
</rule>
-->
<rule id="68cd8f01">
<description>Created after removal of "Handeling requests" from Structure</description>
<accepts>Handeling-requests.html</accepts>
</rule>
<rule id="72f29644">
<description>Created after removal of "About Structure" from Structure</description>
<accepts>starter-topic.html</accepts>
</rule>
<rule id="6c0dc0c9">
<description>Created after removal of "Overview" from Structure</description>
<accepts>Overview.html</accepts>
</rule>
<rule id="4c54f647">
<description>Created after removal of "XLVASK V1" from Structure</description>
<accepts>XLVASK-V1.html</accepts>
</rule>
</rules>
Writerside/topics/XLVask_OpenAPIv1/API_Reference.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic id="API_Reference"
title="API Reference"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd">
<p>XLVask API OpenAPI 1.0.0</p>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Customers_GET.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Customers GET" id="Customers_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="GET" endpoint="/Customers"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Customers_POST.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Customers POST" id="Customers_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="POST" endpoint="/Customers"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Customers_PUT.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Customers PUT" id="Customers_PUT">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="PUT" endpoint="/Customers"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Customers_id_DELETE.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Customers/{id} DELETE" id="Customers_id_DELETE">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="DELETE" endpoint="/Customers/{id}"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/UsageLog_GET.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/UsageLog GET" id="UsageLog_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="GET" endpoint="/UsageLog"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Vehicles_GET.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Vehicles GET" id="Vehicles_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="GET" endpoint="/Vehicles"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Vehicles_POST.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Vehicles POST" id="Vehicles_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="POST" endpoint="/Vehicles"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Vehicles_PUT.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Vehicles PUT" id="Vehicles_PUT">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="PUT" endpoint="/Vehicles"/>
</topic>
Writerside/topics/XLVask_OpenAPIv1/Vehicles_id_DELETE.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/Vehicles/{id} DELETE" id="Vehicles_id_DELETE">
<api-endpoint openapi-path="../../../services/nginx/app/modules/xlvask/XLVask_OpenAPIv1.json" method="DELETE" endpoint="/Vehicles/{id}"/>
</topic>