Deployed 5c94550 with MkDocs version: 1.5.3

api_spec/http-rest-api.yml

@@ -0,0 +1,229 @@
+# Copyright The PFDL Contributors
+#
+# Licensed under the MIT License.
+# For details on the licensing terms, see the LICENSE file.
+# SPDX-License-Identifier: MIT
+
+openapi: 3.0.3
+info:
+  title: PFDL Scheduler Backend API
+  description: This is a HTTP REST Backend API for the Production Flow Description Language (PFDL)
+  version: 0.1.0a
+
+tags:
+  - name: pfdl_order
+    description: Create, update and receive PFDL orders
+  - name: petri_net
+    description: Send status updates of the Petri Net
+  - name: log_event
+    description: Send status updates of the Scheduler
+
+paths:
+  /pfdl_order:
+    post:
+      tags:
+        - pfdl_order
+      summary: Creates a new order
+      description: Creates a new order
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PFDLOrder'
+          application/xml:
+            schema:
+              $ref: '#/components/schemas/PFDLOrder'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PFDLOrder'
+        required: true
+      responses:
+          '200':
+            description: Successful operation
+    get:
+      tags:
+        - pfdl_order
+      summary: Get all orders
+      description: Get all orders
+      responses:
+          '200':
+            description: Successful operation
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/PFDLOrder'          
+              application/xml:
+                schema:
+                  $ref: '#/components/schemas/PFDLOrder'
+  /pfdl_order/{order_id}:
+    post:
+      tags:
+        - pfdl_order
+      summary: Update an existing order
+      description: Updates the order with the given id.
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          description: The id of the order to retrieve
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PFDLOrder'
+          application/xml:
+            schema:
+              $ref: '#/components/schemas/PFDLOrder'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PFDLOrder'
+        required: true
+      responses:
+          '200':
+            description: Successful operation
+
+    get:
+      tags:
+        - pfdl_order
+      summary: Get order by id
+      description: Get the order corresponding to the given id.
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          description: The id of the order to retrieve
+          schema:
+            type: string
+      responses:
+          '200':
+            description: Successful operation
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/PFDLOrder'          
+              application/xml:
+                schema:
+                  $ref: '#/components/schemas/PFDLOrder'
+  /petri_net:
+    post:
+      tags:
+        - petri_net
+      summary: Submit a new petri net
+      description: Submit a new petri net
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PetriNet'
+          application/xml:
+            schema:
+              $ref: '#/components/schemas/PetriNet'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PetriNet'
+        required: true
+      responses:
+        '200':
+          description: Successful operation
+  /log_event:
+    post:
+      tags:
+        - log_event
+      summary: Submit a new log entry
+      description: Submit a new log entry
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/LogEvent'
+          application/xml:
+            schema:
+              $ref: '#/components/schemas/LogEvent'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/LogEvent'
+        required: true
+      responses:
+        '200':
+          description: Successful operation
+
+components:
+  schemas:
+    PFDLOrder:
+      type: object
+      properties:
+        order_id:
+          type: string
+          description: id of the order as uuid
+          example: 8bf4eb6a-74df-427c-a475-532392465f70
+        starting_date:
+          type: integer
+          description: Timestamp of the start of the order
+          example: 1276451619
+        last_update:
+          type: integer
+          description: Timestamp of the last update
+          example: 1676541642
+        status:
+          type: integer
+          description: The status of the order represents as integer. created -> 0, started -> 1, ....
+          example: started
+          enum: ["created", "started", "finished", "error", "unknown"]
+
+      xml:
+        name: order
+    PetriNet:
+      type: object
+      properties:
+        order_id:
+          type: string
+          description: id of the corresponding order as uuid
+          example: 8bf4eb6a-74df-427c-a475-532392465f70
+        content:
+          type: string
+          description: representation of the petri net (type is specified by `format`)
+          example: digraph {...}
+        format:
+          type: string
+          example: dot
+          enum:
+            - "dot"
+            - "png"
+      xml:
+        name: customer
+    LogEvent:
+      type: object
+      properties:
+        order_id:
+          type: string
+          description: id of the corresponding order as uuid
+          example: 8bf4eb6a-74df-427c-a475-532392465f70
+        log_date:
+          type: integer
+          description: timestamp of the date of the log entry.
+          example: 2376545712
+        log_message:
+          type: string
+          description: Content of the log entry
+          example: Task started...
+        log_level:
+          type: integer
+          description: The level of the log event corresponding to https://docs.python.org/3/library/logging.html#logging-levels
+          example: 20
+      xml:
+        name: customer
+  securitySchemes:
+    petstore_auth:
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: https://petstore3.swagger.io/oauth/authorize
+          scopes:
+            write:pets: modify pets in your account
+            read:pets: read your pets
+    api_key:
+      type: apiKey
+      name: api_key
+      in: header

assets/_mkdocstrings.css

@@ -0,0 +1,109 @@
+
+/* Avoid breaking parameter names, etc. in table cells. */
+.doc-contents td code {
+  word-break: normal !important;
+}
+
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+  display: inline;
+}
+
+/* Max width for docstring sections tables. */
+.doc .md-typeset__table,
+.doc .md-typeset__table table {
+  display: table !important;
+  width: 100%;
+}
+
+.doc .md-typeset__table tr {
+  display: table-row;
+}
+
+/* Defaults in Spacy table style. */
+.doc-param-default {
+  float: right;
+}
+
+/* Symbols in Navigation and ToC. */
+:root,
+[data-md-color-scheme="default"] {
+  --doc-symbol-attribute-fg-color: #953800;
+  --doc-symbol-function-fg-color: #8250df;
+  --doc-symbol-method-fg-color: #8250df;
+  --doc-symbol-class-fg-color: #0550ae;
+  --doc-symbol-module-fg-color: #5cad0f;
+
+  --doc-symbol-attribute-bg-color: #9538001a;
+  --doc-symbol-function-bg-color: #8250df1a;
+  --doc-symbol-method-bg-color: #8250df1a;
+  --doc-symbol-class-bg-color: #0550ae1a;
+  --doc-symbol-module-bg-color: #5cad0f1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --doc-symbol-attribute-fg-color: #ffa657;
+  --doc-symbol-function-fg-color: #d2a8ff;
+  --doc-symbol-method-fg-color: #d2a8ff;
+  --doc-symbol-class-fg-color: #79c0ff;
+  --doc-symbol-module-fg-color: #baff79;
+
+  --doc-symbol-attribute-bg-color: #ffa6571a;
+  --doc-symbol-function-bg-color: #d2a8ff1a;
+  --doc-symbol-method-bg-color: #d2a8ff1a;
+  --doc-symbol-class-bg-color: #79c0ff1a;
+  --doc-symbol-module-bg-color: #baff791a;
+}
+
+code.doc-symbol {
+  border-radius: .1rem;
+  font-size: .85em;
+  padding: 0 .3em;
+  font-weight: bold;
+}
+
+code.doc-symbol-attribute {
+  color: var(--doc-symbol-attribute-fg-color);
+  background-color: var(--doc-symbol-attribute-bg-color);
+}
+
+code.doc-symbol-attribute::after {
+  content: "attr";
+}
+
+code.doc-symbol-function {
+  color: var(--doc-symbol-function-fg-color);
+  background-color: var(--doc-symbol-function-bg-color);
+}
+
+code.doc-symbol-function::after {
+  content: "func";
+}
+
+code.doc-symbol-method {
+  color: var(--doc-symbol-method-fg-color);
+  background-color: var(--doc-symbol-method-bg-color);
+}
+
+code.doc-symbol-method::after {
+  content: "meth";
+}
+
+code.doc-symbol-class {
+  color: var(--doc-symbol-class-fg-color);
+  background-color: var(--doc-symbol-class-bg-color);
+}
+
+code.doc-symbol-class::after {
+  content: "class";
+}
+
+code.doc-symbol-module {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
+}
+
+code.doc-symbol-module::after {
+  content: "mod";
+}