Page MenuHomeDevCentral
Files F3767502

D2991.id7642.diff
No OneTemporary
Actions

D2991.id7642.diff
View Options

diff --git a/nasqueron-api-alkane.spec.yaml b/nasqueron-api-alkane.spec.yaml
new file mode 100644
--- /dev/null
+++ b/nasqueron-api-alkane.spec.yaml
@@ -0,0 +1,112 @@
+openapi: '3.0.3'
+
+info:
+ title: Nasqueron Alkane HTTP API
+ version: 0.1.0
+ description: |
+ Alkane is the Nasqueron PaaS to host static and PHP sites.
+
+ This API allows to check if a site is present on the PaaS,
+ or to trigger a new deployment, initializing or updating an existing site.
+
+ Some useful links:
+ - [Operations grimoire :: Alkane](https://agora.nasqueron.org/Operations_grimoire/Alkane)
+ - [DevCentral :: Alkane](https://devcentral.nasqueron.org/tag/alkane/)
+ license:
+ name: BSD-2-Clause
+ url: https://devcentral.nasqueron.org/source/alkane/browse/main/LICENSE
+
+servers:
+ - url: http://172.27.27.10:10206
+
+defaultContentType: application/json
+
+tags:
+ - name: monitoring
+ description: Useful to monitor the application
+ - name: alkane
+ description: Access to Alkane features
+
+paths:
+ /status:
+ get:
+ tags:
+ - monitoring
+ summary: Health status
+ description: Determine if the API is alive
+ operationId: status
+ responses:
+ '200':
+ description: Successful operation
+
+ /init/{siteName}:
+ post:
+ tags:
+ - alkane
+ summary: Initialize a new site on Alkane
+ description: Notify Alkane to run the build script "init"
+ operationId: init
+ parameters:
+ - name: siteName
+ in: path
+ description: The name of the site to deploy, generally its fully qualified domain name (FQDN). For example, "sub.domain.tld".
+ required: true
+ schema:
+ type: string
+ requestBody:
+ required: false
+ content:
+ "*/*":
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Successful operation
+
+ /update/{siteName}:
+ post:
+ tags:
+ - alkane
+ summary: Update an existing site on Alkane
+ description: Notify Alkane to run the build script "update"
+ operationId: update
+ parameters:
+ - name: siteName
+ in: path
+ description: The name of the site to deploy, generally its fully qualified domain name (FQDN). For example, "sub.domain.tld".
+ required: true
+ schema:
+ type: string
+ requestBody:
+ required: false
+ content:
+ "*/*":
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Successful operation
+
+ /deploy/{siteName}:
+ post:
+ tags:
+ - alkane
+ summary: Deploy a site on Alkane
+ description: Initialize a site if does not exist; otherwise, update it
+ operationId: deploy
+ parameters:
+ - name: siteName
+ in: path
+ description: The name of the site to deploy, generally its fully qualified domain name (FQDN). For example, "sub.domain.tld".
+ required: true
+ schema:
+ type: string
+ requestBody:
+ required: false
+ content:
+ "*/*":
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Successful operation

File Metadata

Mime Type
text/plain
Expires
Sun, Nov 24, 00:49 (16 h, 12 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2258862
Default Alt Text
D2991.id7642.diff (3 KB)

Event Timeline

Nasqueron DevCentral · If it had been much bigger the moon would have had a core of ice. · Powered by Phabricator