From 622aa57d0b1c1680a0edd934b1903ee7d86c6b30 Mon Sep 17 00:00:00 2001
From: Justin Campbell <campb303@purdue.edu>
Date: Tue, 3 Aug 2021 00:13:25 -0400
Subject: [PATCH] Update docs

---
 docs/404.html                                 |  18 +-
 docs/Dev Environment Setup Guide/index.html   |  18 +-
 docs/Installation/index.html                  |  18 +-
 .../Material for mkdocs Formatting/index.html |  18 +-
 docs/api/Authentication/index.html            |  18 +-
 docs/api/Getting Started/index.html           |  18 +-
 docs/api/Items/index.html                     |  18 +-
 docs/api/Queues/index.html                    |  18 +-
 docs/api/Simulating Responses/index.html      |  18 +-
 docs/index.html                               |  18 +-
 docs/search/search_index.json                 |   2 +-
 docs/sitemap.xml                              |   5 +
 docs/sitemap.xml.gz                           | Bin 415 -> 425 bytes
 .../Configuration/index.html                  |  22 +-
 .../Deployment/index.html                     | 594 ++++++++++++++++++
 .../Getting Started/index.html                |  18 +-
 .../Package Structure/index.html              |  22 +-
 .../Section Parsing Definitions/index.html    |  18 +-
 docs/webqueue2api Package/awesome-pages.yaml  |   1 +
 19 files changed, 815 insertions(+), 47 deletions(-)
 create mode 100644 docs/webqueue2api Package/Deployment/index.html

diff --git a/docs/404.html b/docs/404.html
index 8b9621e..d6fc76e 100644
--- a/docs/404.html
+++ b/docs/404.html
@@ -385,6 +385,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="/ECN/webqueue2-api/webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="/ECN/webqueue2-api/webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -401,14 +413,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/Dev Environment Setup Guide/index.html b/docs/Dev Environment Setup Guide/index.html
index 611e1cb..2cd615b 100644
--- a/docs/Dev Environment Setup Guide/index.html	
+++ b/docs/Dev Environment Setup Guide/index.html	
@@ -568,6 +568,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -584,14 +596,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/Installation/index.html b/docs/Installation/index.html
index 32f7f8c..9aca934 100644
--- a/docs/Installation/index.html
+++ b/docs/Installation/index.html
@@ -402,6 +402,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -418,14 +430,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/Material for mkdocs Formatting/index.html b/docs/Material for mkdocs Formatting/index.html
index 55cfa28..5312f09 100644
--- a/docs/Material for mkdocs Formatting/index.html	
+++ b/docs/Material for mkdocs Formatting/index.html	
@@ -392,6 +392,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -408,14 +420,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/api/Authentication/index.html b/docs/api/Authentication/index.html
index e642e97..b0d18a4 100644
--- a/docs/api/Authentication/index.html
+++ b/docs/api/Authentication/index.html
@@ -487,6 +487,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -503,14 +515,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/api/Getting Started/index.html b/docs/api/Getting Started/index.html
index 1a9c323..5bfdc7c 100644
--- a/docs/api/Getting Started/index.html	
+++ b/docs/api/Getting Started/index.html	
@@ -434,6 +434,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -450,14 +462,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/api/Items/index.html b/docs/api/Items/index.html
index 0ba5f3e..ce84a7b 100644
--- a/docs/api/Items/index.html
+++ b/docs/api/Items/index.html
@@ -593,6 +593,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -609,14 +621,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/api/Queues/index.html b/docs/api/Queues/index.html
index ebadc83..d243007 100644
--- a/docs/api/Queues/index.html
+++ b/docs/api/Queues/index.html
@@ -495,6 +495,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -511,14 +523,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/api/Simulating Responses/index.html b/docs/api/Simulating Responses/index.html
index 5d2abae..591eb1b 100644
--- a/docs/api/Simulating Responses/index.html	
+++ b/docs/api/Simulating Responses/index.html	
@@ -450,6 +450,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -466,14 +478,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/index.html b/docs/index.html
index 10aa18a..84c45fd 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -395,6 +395,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="webqueue2api%20Package/Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="webqueue2api%20Package/Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -411,14 +423,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
index bebc660..b32bc75 100644
--- a/docs/search/search_index.json
+++ b/docs/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"See the API Docs . See the Python Package Docs","title":"Home"},{"location":"Dev%20Environment%20Setup%20Guide/","text":"Dev Environment Setup Guide \u2693\ufe0e This document will walk you through the setup and configuration of a development environment for webqueue2 using the provided development machines, SSH authentication, GitHub and VS Code. Prerequisites \u2693\ufe0e On Your Computer \u2693\ufe0e VS Code Cisco AnyConnect for WebVPN On The Development Computer \u2693\ufe0e Note These are already installed on the provided development machines. git Python >= 3.6.9 Configuring Your SSH Keys \u2693\ufe0e We will be using SSH keys to authenticate to both the development machines and GitHub. In either PowerShell on Windows or bash on macOS/Linux, run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in the .ssh folder inside your user's folder. Your user's folder can usually be found at: Windows C:\\Users\\<user_name> macOS /Users/<user_name> Linux /home/<user_name> Note Most CLI shells like PowerShell and bash use the ~ (tilda) key as a shortcut for your user's folder. You can confirm these files were created by running: ls ~/.ssh/ Configuring SSH \u2693\ufe0e In your editor of choice, create the file ~/.ssh/config and add this: Tip Replace campb303 with your career account username and replace w2vm1 with the name of the provided development machine you're connecting to. Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 The configuration above will allow you to connect to the development machine and automatically forward ports for development tools to work. Here's a bit more detail about what's going on: Key Value Host A friendly name to identify an SSH host by. This can be anything. HostName The DNS name or IP address of the computer you're connecting to. User The name of your user on the computer you're connecting to. LocalForward Forwards a port on your computer to a port on the computer you're connecting to. Development machines are not publicly accessible. You'll need to be connected to WebVPN to connect to them. SSH Jump Hosts WebVPN works on all platforms but requires an extra step to get to work. On macOS/Linux, pier.ecn.purdue.edu can be used as an SSH jump host allowing for development machines to be connected to automatically when openning VS Code. Assuming you already have an SSH key configured for pier.ecn.purdue.edu , you can use a jump host by adding the following to ~/.ssh/config : Host campb303-pier HostName pier.ecn.purdue.edu User campb303 Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu ProxyJump campb303-pier User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 To test your configuration, run ssh followed by the Host value. When prompted for your password, enter your career account password and press Enter . Warning Most shell environemnts like PowerShell and bash do not show your password being typed but it is being typed. For the configuration above you would run: ssh campb303-w2vm1 campb303@w2vm1's password: Adding SSH Keys \u2693\ufe0e Now that we've generated SSH keys and configured our host entries, we need to add our SSH key to the host. This will allow us to connect to these machines without passwords later. Tip Replace HOST below with the value from above. Example: campb303-w2vm1 PowerShell on Windows type $env:USERPROFILE \\. ssh \\ id_rsa . pub | ssh HOST \"cat >> .ssh/authorized_keys\" bash on macOS/Linux ssh-copy-id HOST If the key was added successfully, you can login without entering a password by running: ssh HOST Installing VS Code \u2693\ufe0e Download and install VS Code . Be sure to add code to your PATH. Windows Adding code to your PATH on Windows is a checkbox in the installer: Image from this article on Techomoro macOS/Linux Adding code to your PATH on macOS/Linux is accessible by searching for \"PATH\" in the Command Pallete. You can access the Command Pallete with the keyboard shortcut Command / Ctrl + Shift + P : Image from this StackOverflow thread Connecting To The Development Machine \u2693\ufe0e Install the Remote - SSH plugin. After installation a new icon will appear in the sidebar: Click on the Remote SSH icon and you'll see the SSH host you just defined Select the host and click the New Window icon to connect. A new window connected to that host will appear Note This may take a couple of minutes on the first connection while VS Code installs its server. If prompted for a platform, select Linux: Adding Your SSH Keys to GitHub \u2693\ufe0e Because the development machine will be the computer that connects to GitHub, we need to create another SSH key and add it to our GitHub profile: First, open VS Code's integrated terminal by pressing Control + ~ (tilda) Now run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in ~/.ssh/ . You can confirm this by running: ls ~/.ssh/ Now copy the public key from id_rsa.pub by openning the file in VS Code, selecting its contents and copying it. You can open the file in VS Code by running the following in the integrated terminal: Danger Do not copy your private key from id_rsa ! This key should never leave your machine. code ~/.ssh/id_rsa.pub Now go to github.itap.purdue.edu/settings/keys . You may be prompted to login using your career account username and password. Click the \"New SSH Key\" button Give the key a title that tells you what device the key is from (e.g. Desktop or Dev Machine) Paste the contents of id_rsa.pub into the key box Click the \"Add SSH Key\" button Cloning and Opening the Repository \u2693\ufe0e Using the integrated terminal in VS Code, run: git clone git@github.itap.purdue.edu:ECN/webqueue2-api.git This will create a webqueue2-api folder in your user's home directory. Open this directory using the \"Open Folder\" button: Note VS Code will automatically reconnect to the last remote host used when it reopens. Tip If you need to reconnect manually, there will now be an option to open the webqueue2-api folder directly from the Remote Hosts menu: Configuring VS Code \u2693\ufe0e Installing Extensions \u2693\ufe0e Pylance for Python language support, IntelliSense, virtual environments and debugging Git Graph for a more detailed view of git info Markdown Preview GitHub Styling for previewing Markdown as it will appear on GitHub Python Docstring Generator for generating Google style docstrings according to section 3.8 of Google's Python style guide Configuring Extensions \u2693\ufe0e Python \u2693\ufe0e The Python extension supports virtual environments but needs to be told where the virtual environment is. Create or modify the file .vscode/settings.json and add the following: \"python.defaultInterpreterPath\": \"./venv/bin/python3\" Tip The Python extension may complain and tell you to select another interpreter. Ignore this warning for now. Python Docstring Generator \u2693\ufe0e For consistentcy, we'll use a docstring template. Create or modify the file .vscode/settings.json and add the following: \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" At this point, your .vscode/settings.json file should look like this: { \"python.pythonPath\": \"./venv/bin/python3\", \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" } Setting Up the Virtual Environment \u2693\ufe0e For development, we'll use a Python Virtual Environment to isolate out changes and have a reproducible dev environment. In VS Code's integrated terminal: Create a virtual environment at ./venv/ : python3 -m venv venv Activate the virtual environment: source venv/bin/activate Tip To deactivate the virtual environment and use your system's Python interpreter, run: deactivate Update pip within the virtual environment: pip install -U pip Install the webqueue2 API within the virtual environemt: pip install -e .[all] -e installs a package in editable mode which allows code changes to take effect without reinstalling a package. webqueue2 API has multiple conditional dependencies : Condition Installation Command Description Production pip install . For use in production. Only installed needed packages. Development pip install .[dev] For use in development. Installs everything for production and extra packages for development. Documentation pip install .[docs] For use in creating documentation. Installs everything for production and extra packages for documentation. All pip install .[all] A shortcut for installing production, development and documentation dependencies. API Commands \u2693\ufe0e Command Description gunicorn webqueue2api.api:app This will start a local server on localhost:8000 to access the API. mkdocs serve This will start a local server on localhost:6060 to access the API docs. As you change API documentation files in ./docs/ you'll see your changes in the browser. mkdocs build This will output a static bundle of the API documentation in ./site/ that can be put on any webserver.","title":"Dev Environment Setup Guide"},{"location":"Dev%20Environment%20Setup%20Guide/#dev-environment-setup-guide","text":"This document will walk you through the setup and configuration of a development environment for webqueue2 using the provided development machines, SSH authentication, GitHub and VS Code.","title":"Dev Environment Setup Guide"},{"location":"Dev%20Environment%20Setup%20Guide/#prerequisites","text":"","title":"Prerequisites"},{"location":"Dev%20Environment%20Setup%20Guide/#on-your-computer","text":"VS Code Cisco AnyConnect for WebVPN","title":"On Your Computer"},{"location":"Dev%20Environment%20Setup%20Guide/#on-the-development-computer","text":"Note These are already installed on the provided development machines. git Python >= 3.6.9","title":"On The Development Computer"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-your-ssh-keys","text":"We will be using SSH keys to authenticate to both the development machines and GitHub. In either PowerShell on Windows or bash on macOS/Linux, run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in the .ssh folder inside your user's folder. Your user's folder can usually be found at: Windows C:\\Users\\<user_name> macOS /Users/<user_name> Linux /home/<user_name> Note Most CLI shells like PowerShell and bash use the ~ (tilda) key as a shortcut for your user's folder. You can confirm these files were created by running: ls ~/.ssh/","title":"Configuring Your SSH Keys"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-ssh","text":"In your editor of choice, create the file ~/.ssh/config and add this: Tip Replace campb303 with your career account username and replace w2vm1 with the name of the provided development machine you're connecting to. Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 The configuration above will allow you to connect to the development machine and automatically forward ports for development tools to work. Here's a bit more detail about what's going on: Key Value Host A friendly name to identify an SSH host by. This can be anything. HostName The DNS name or IP address of the computer you're connecting to. User The name of your user on the computer you're connecting to. LocalForward Forwards a port on your computer to a port on the computer you're connecting to. Development machines are not publicly accessible. You'll need to be connected to WebVPN to connect to them. SSH Jump Hosts WebVPN works on all platforms but requires an extra step to get to work. On macOS/Linux, pier.ecn.purdue.edu can be used as an SSH jump host allowing for development machines to be connected to automatically when openning VS Code. Assuming you already have an SSH key configured for pier.ecn.purdue.edu , you can use a jump host by adding the following to ~/.ssh/config : Host campb303-pier HostName pier.ecn.purdue.edu User campb303 Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu ProxyJump campb303-pier User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 To test your configuration, run ssh followed by the Host value. When prompted for your password, enter your career account password and press Enter . Warning Most shell environemnts like PowerShell and bash do not show your password being typed but it is being typed. For the configuration above you would run: ssh campb303-w2vm1 campb303@w2vm1's password:","title":"Configuring SSH"},{"location":"Dev%20Environment%20Setup%20Guide/#adding-ssh-keys","text":"Now that we've generated SSH keys and configured our host entries, we need to add our SSH key to the host. This will allow us to connect to these machines without passwords later. Tip Replace HOST below with the value from above. Example: campb303-w2vm1 PowerShell on Windows type $env:USERPROFILE \\. ssh \\ id_rsa . pub | ssh HOST \"cat >> .ssh/authorized_keys\" bash on macOS/Linux ssh-copy-id HOST If the key was added successfully, you can login without entering a password by running: ssh HOST","title":"Adding SSH Keys"},{"location":"Dev%20Environment%20Setup%20Guide/#installing-vs-code","text":"Download and install VS Code . Be sure to add code to your PATH. Windows Adding code to your PATH on Windows is a checkbox in the installer: Image from this article on Techomoro macOS/Linux Adding code to your PATH on macOS/Linux is accessible by searching for \"PATH\" in the Command Pallete. You can access the Command Pallete with the keyboard shortcut Command / Ctrl + Shift + P : Image from this StackOverflow thread","title":"Installing VS Code"},{"location":"Dev%20Environment%20Setup%20Guide/#connecting-to-the-development-machine","text":"Install the Remote - SSH plugin. After installation a new icon will appear in the sidebar: Click on the Remote SSH icon and you'll see the SSH host you just defined Select the host and click the New Window icon to connect. A new window connected to that host will appear Note This may take a couple of minutes on the first connection while VS Code installs its server. If prompted for a platform, select Linux:","title":"Connecting To The Development Machine"},{"location":"Dev%20Environment%20Setup%20Guide/#adding-your-ssh-keys-to-github","text":"Because the development machine will be the computer that connects to GitHub, we need to create another SSH key and add it to our GitHub profile: First, open VS Code's integrated terminal by pressing Control + ~ (tilda) Now run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in ~/.ssh/ . You can confirm this by running: ls ~/.ssh/ Now copy the public key from id_rsa.pub by openning the file in VS Code, selecting its contents and copying it. You can open the file in VS Code by running the following in the integrated terminal: Danger Do not copy your private key from id_rsa ! This key should never leave your machine. code ~/.ssh/id_rsa.pub Now go to github.itap.purdue.edu/settings/keys . You may be prompted to login using your career account username and password. Click the \"New SSH Key\" button Give the key a title that tells you what device the key is from (e.g. Desktop or Dev Machine) Paste the contents of id_rsa.pub into the key box Click the \"Add SSH Key\" button","title":"Adding Your SSH Keys to GitHub"},{"location":"Dev%20Environment%20Setup%20Guide/#cloning-and-opening-the-repository","text":"Using the integrated terminal in VS Code, run: git clone git@github.itap.purdue.edu:ECN/webqueue2-api.git This will create a webqueue2-api folder in your user's home directory. Open this directory using the \"Open Folder\" button: Note VS Code will automatically reconnect to the last remote host used when it reopens. Tip If you need to reconnect manually, there will now be an option to open the webqueue2-api folder directly from the Remote Hosts menu:","title":"Cloning and Opening the Repository"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-vs-code","text":"","title":"Configuring VS Code"},{"location":"Dev%20Environment%20Setup%20Guide/#installing-extensions","text":"Pylance for Python language support, IntelliSense, virtual environments and debugging Git Graph for a more detailed view of git info Markdown Preview GitHub Styling for previewing Markdown as it will appear on GitHub Python Docstring Generator for generating Google style docstrings according to section 3.8 of Google's Python style guide","title":"Installing Extensions"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-extensions","text":"","title":"Configuring Extensions"},{"location":"Dev%20Environment%20Setup%20Guide/#python","text":"The Python extension supports virtual environments but needs to be told where the virtual environment is. Create or modify the file .vscode/settings.json and add the following: \"python.defaultInterpreterPath\": \"./venv/bin/python3\" Tip The Python extension may complain and tell you to select another interpreter. Ignore this warning for now.","title":"Python"},{"location":"Dev%20Environment%20Setup%20Guide/#python-docstring-generator","text":"For consistentcy, we'll use a docstring template. Create or modify the file .vscode/settings.json and add the following: \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" At this point, your .vscode/settings.json file should look like this: { \"python.pythonPath\": \"./venv/bin/python3\", \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" }","title":"Python Docstring Generator"},{"location":"Dev%20Environment%20Setup%20Guide/#setting-up-the-virtual-environment","text":"For development, we'll use a Python Virtual Environment to isolate out changes and have a reproducible dev environment. In VS Code's integrated terminal: Create a virtual environment at ./venv/ : python3 -m venv venv Activate the virtual environment: source venv/bin/activate Tip To deactivate the virtual environment and use your system's Python interpreter, run: deactivate Update pip within the virtual environment: pip install -U pip Install the webqueue2 API within the virtual environemt: pip install -e .[all] -e installs a package in editable mode which allows code changes to take effect without reinstalling a package. webqueue2 API has multiple conditional dependencies : Condition Installation Command Description Production pip install . For use in production. Only installed needed packages. Development pip install .[dev] For use in development. Installs everything for production and extra packages for development. Documentation pip install .[docs] For use in creating documentation. Installs everything for production and extra packages for documentation. All pip install .[all] A shortcut for installing production, development and documentation dependencies.","title":"Setting Up the Virtual Environment"},{"location":"Dev%20Environment%20Setup%20Guide/#api-commands","text":"Command Description gunicorn webqueue2api.api:app This will start a local server on localhost:8000 to access the API. mkdocs serve This will start a local server on localhost:6060 to access the API docs. As you change API documentation files in ./docs/ you'll see your changes in the browser. mkdocs build This will output a static bundle of the API documentation in ./site/ that can be put on any webserver.","title":"API Commands"},{"location":"Installation/","text":"Installation \u2693\ufe0e The webqueue2 API is publicly available at https://engineering.purdue.edu/webqueue/webqueue2/build/api but you can install it on your own machine if you'd like. The code is available on GitHub . Available package versions can be seen on the releases page and can be installed via pip, a requirements file, or downloaded and installed manually. pip available on ECN machines needs updated. Installation via pip is possible through pip's VCS support which was introduced in pip 19. The version of pip available on ECN supported machines is too old and needs updated. To update pip, run: pip install -U pop Using a virtual environment is recommended for reproducibility. Create a virtual environment called __venv__ : python3 -m venv __venv__ Activate the virtual environment: source __venv__/bin/activate Update pip: pip install -U pip Install via pip To install webqueue2-api 1.0.0, you can run: pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api Install via requirements file To install webqueue2-api 1.0.0, place the following line your requirements file: echo \"git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api\" >> requirements.txt pip install -r requirements.txt If you'd like a version other than 1.0.0 simply replace the that version number with a different version listed on the releases page . To start the server, run the following while your virtual environment is activated: gunicorn webqueue2api.api:app","title":"Installation"},{"location":"Installation/#installation","text":"The webqueue2 API is publicly available at https://engineering.purdue.edu/webqueue/webqueue2/build/api but you can install it on your own machine if you'd like. The code is available on GitHub . Available package versions can be seen on the releases page and can be installed via pip, a requirements file, or downloaded and installed manually. pip available on ECN machines needs updated. Installation via pip is possible through pip's VCS support which was introduced in pip 19. The version of pip available on ECN supported machines is too old and needs updated. To update pip, run: pip install -U pop Using a virtual environment is recommended for reproducibility. Create a virtual environment called __venv__ : python3 -m venv __venv__ Activate the virtual environment: source __venv__/bin/activate Update pip: pip install -U pip Install via pip To install webqueue2-api 1.0.0, you can run: pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api Install via requirements file To install webqueue2-api 1.0.0, place the following line your requirements file: echo \"git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api\" >> requirements.txt pip install -r requirements.txt If you'd like a version other than 1.0.0 simply replace the that version number with a different version listed on the releases page . To start the server, run the following while your virtual environment is activated: gunicorn webqueue2api.api:app","title":"Installation"},{"location":"Material%20for%20mkdocs%20Formatting/","text":"Material for mkdocs Formatting \u2693\ufe0e Admonitions \u2693\ufe0e See: Material for mkdocs: Admonitions Note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Summary Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Info Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Custom Title Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Code Blocks \u2693\ufe0e See: Material for mkdocs: Code Blocks # This is a Python code block. print ( \"Hello world!\" ) if __name__ == \"__main__\" 1 2 # This is a JavaScript code block with line numbers . ( _ => console . log ( \"Hello world!\" ))(); # This is a Markdown code block with line highlights and nested code block. ``` js ( _ => console.log(\"Hello world!\"))(); ``` This is an inline Java highlight system . out . println ( \"Hello world!\" ) Content Tabs \u2693\ufe0e See: Material for mkdocs: Content Tabs Basic Tabs \u2693\ufe0e === \"Tab 1\" Hello === \"Tab 2\" World Tab 1 Hello Tab 2 World Tabs in Admonitions with Code Blocks \u2693\ufe0e !!! example \"Hello world\" in many languages: === \"Python\" ```python print ( \"Hello world!\" ) if __name__ == \"__main__\" ``` === \"JavaScript\" ```js ( _ => console . log ( \"Hello world!\" ))(); ``` Example \"Hello world\" in many languages: Python print ( \"Hello world!\" ) if __name__ == \"__main__\" JavaScript ( _ => console . log ( \"Hello world!\" ))(); Data Tables \u2693\ufe0e See: Material for mkdocs: Data Tables | Method | Description | | ----------- | ------------------------------------ | | `GET` | :material-check: Fetch resource | | `PUT` | :material-check-all: Update resource | | `DELETE` | :material-close: Delete resource | Method Description GET Fetch resource PUT Update resource DELETE Delete resource","title":"Material for mkdocs Formatting"},{"location":"Material%20for%20mkdocs%20Formatting/#material-for-mkdocs-formatting","text":"","title":"Material for mkdocs Formatting"},{"location":"Material%20for%20mkdocs%20Formatting/#admonitions","text":"See: Material for mkdocs: Admonitions Note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Summary Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Info Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Custom Title Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.","title":"Admonitions"},{"location":"Material%20for%20mkdocs%20Formatting/#code-blocks","text":"See: Material for mkdocs: Code Blocks # This is a Python code block. print ( \"Hello world!\" ) if __name__ == \"__main__\" 1 2 # This is a JavaScript code block with line numbers . ( _ => console . log ( \"Hello world!\" ))(); # This is a Markdown code block with line highlights and nested code block. ``` js ( _ => console.log(\"Hello world!\"))(); ``` This is an inline Java highlight system . out . println ( \"Hello world!\" )","title":"Code Blocks"},{"location":"Material%20for%20mkdocs%20Formatting/#content-tabs","text":"See: Material for mkdocs: Content Tabs","title":"Content Tabs"},{"location":"Material%20for%20mkdocs%20Formatting/#basic-tabs","text":"=== \"Tab 1\" Hello === \"Tab 2\" World Tab 1 Hello Tab 2 World","title":"Basic Tabs"},{"location":"Material%20for%20mkdocs%20Formatting/#tabs-in-admonitions-with-code-blocks","text":"!!! example \"Hello world\" in many languages: === \"Python\" ```python print ( \"Hello world!\" ) if __name__ == \"__main__\" ``` === \"JavaScript\" ```js ( _ => console . log ( \"Hello world!\" ))(); ``` Example \"Hello world\" in many languages: Python print ( \"Hello world!\" ) if __name__ == \"__main__\" JavaScript ( _ => console . log ( \"Hello world!\" ))();","title":"Tabs in Admonitions with Code Blocks"},{"location":"Material%20for%20mkdocs%20Formatting/#data-tables","text":"See: Material for mkdocs: Data Tables | Method | Description | | ----------- | ------------------------------------ | | `GET` | :material-check: Fetch resource | | `PUT` | :material-check-all: Update resource | | `DELETE` | :material-close: Delete resource | Method Description GET Fetch resource PUT Update resource DELETE Delete resource","title":"Data Tables"},{"location":"api/Authentication/","text":"Authentication \u2693\ufe0e The webqueue2 API uses a two stage authentication system combining Active Directory and HTTP Token (or \"bearer\") authentication. Getting an Access Token \u2693\ufe0e All API calls require an access token. You can get an access token by making a POST request to the /api/login endpoint containing the JSON encoded username and password of a valid user. Who is a valid user? A valid user is a non-admin BoilerAD user who is in the 00000227-ECN-webqueue group. Users cannot be added directly to this group. To be included in this group, a user must exist in one of the following groups: 00000227-ECNStaff 00000227-ECNStuds 00000227-ECN-webqueue-misc Example \u2693\ufe0e Get an access token. fetch ( \"https://engineering.purdue.edu/webqueue/webqueue2/build/api/login\" , { method : \"POST\" , headers : { 'Content-Type' : 'application/json' }, body : JSON . stringify ({ \"username\" : USERNAME , \"password\" : PASSWORD }) } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )) // Expected Output \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" Making Calls With Access Token \u2693\ufe0e To interact with the API, add an Authorization header to your request with a value of Bearer TOKEN where TOKEN is your access token. Example: \u2693\ufe0e Get item CE 100. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 100 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data )); // Expected Output { queue : \"ce\" , number : 100 , lastUpdated : \"2021-03-11T07:24:00-0500\" ... } Refreshing Access Tokens \u2693\ufe0e When you login, you'll receive an access token that expires 15 minutes after creation as well as two cookies needed to get a new access token. Those cookies are: Name Value Path Expiration SameSite refresh_token_cookie Your refresh token. /api/tokens/refresh 30 Days Yes csrf_refresh_token Additional verification data. (e.g. 7b7c1ea8-f6bb-4204-99af-cd4124a69d89 ) / Session Yes The refresh_token_cookie is used to generate a new access token and will be sent back to the server with every request automatically. It expires 30 days after login. The csrf_refresh_token is used to verify the refresh_token_cookie and needs sent back as an X-CSRF-TOKEN header. To refresh your access token, make a POST request to the /api/tokens/refresh endpoint with the value of the csrf_refresh_token cookies inside a X-CSRF-TOKEN header: Example \u2693\ufe0e Get a new refresh token. // Get this value from your cookies. const csrf_refresh_token = \"7b7c1ea8-f6bb-4204-99af-cd4124a69d89\" fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/tokens/refresh` , { method : \"POST\" , headers : { 'X-CSRF-TOKEN' : csrf_refresh_token } } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )); // Expected Output eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 . eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ .6 z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE","title":"Authentication"},{"location":"api/Authentication/#authentication","text":"The webqueue2 API uses a two stage authentication system combining Active Directory and HTTP Token (or \"bearer\") authentication.","title":"Authentication"},{"location":"api/Authentication/#getting-an-access-token","text":"All API calls require an access token. You can get an access token by making a POST request to the /api/login endpoint containing the JSON encoded username and password of a valid user. Who is a valid user? A valid user is a non-admin BoilerAD user who is in the 00000227-ECN-webqueue group. Users cannot be added directly to this group. To be included in this group, a user must exist in one of the following groups: 00000227-ECNStaff 00000227-ECNStuds 00000227-ECN-webqueue-misc","title":"Getting an Access Token"},{"location":"api/Authentication/#example","text":"Get an access token. fetch ( \"https://engineering.purdue.edu/webqueue/webqueue2/build/api/login\" , { method : \"POST\" , headers : { 'Content-Type' : 'application/json' }, body : JSON . stringify ({ \"username\" : USERNAME , \"password\" : PASSWORD }) } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )) // Expected Output \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\"","title":"Example"},{"location":"api/Authentication/#making-calls-with-access-token","text":"To interact with the API, add an Authorization header to your request with a value of Bearer TOKEN where TOKEN is your access token.","title":"Making Calls With Access Token"},{"location":"api/Authentication/#example_1","text":"Get item CE 100. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 100 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data )); // Expected Output { queue : \"ce\" , number : 100 , lastUpdated : \"2021-03-11T07:24:00-0500\" ... }","title":"Example:"},{"location":"api/Authentication/#refreshing-access-tokens","text":"When you login, you'll receive an access token that expires 15 minutes after creation as well as two cookies needed to get a new access token. Those cookies are: Name Value Path Expiration SameSite refresh_token_cookie Your refresh token. /api/tokens/refresh 30 Days Yes csrf_refresh_token Additional verification data. (e.g. 7b7c1ea8-f6bb-4204-99af-cd4124a69d89 ) / Session Yes The refresh_token_cookie is used to generate a new access token and will be sent back to the server with every request automatically. It expires 30 days after login. The csrf_refresh_token is used to verify the refresh_token_cookie and needs sent back as an X-CSRF-TOKEN header. To refresh your access token, make a POST request to the /api/tokens/refresh endpoint with the value of the csrf_refresh_token cookies inside a X-CSRF-TOKEN header:","title":"Refreshing Access Tokens"},{"location":"api/Authentication/#example_2","text":"Get a new refresh token. // Get this value from your cookies. const csrf_refresh_token = \"7b7c1ea8-f6bb-4204-99af-cd4124a69d89\" fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/tokens/refresh` , { method : \"POST\" , headers : { 'X-CSRF-TOKEN' : csrf_refresh_token } } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )); // Expected Output eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 . eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ .6 z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE","title":"Example"},{"location":"api/Getting%20Started/","text":"Getting Started \u2693\ufe0e The webqueue2 API is organized around REST . The API has resource oriented URLs, accepts and returns JSON encoded request bodies, can be modified via the query string and uses standard HTTP response codes and verbs. You can use the webqueue2 API hosted at https://engineering.purdue.edu/webqueue/webqueue2/build/api or install it on your own machine . Basic Usage \u2693\ufe0e Get the first item in CE queue. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data [ 0 ]. items [ 0 ] )); // Expected Output { queue : \"ce\" , number : 17 , lastUpdated : \"2021-03-29T17:12:00-0400\" ... } Get the subject of an CE 1. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 1 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data . subject )); // Expected Output \"Linux Server Purchase\"","title":"Getting Started"},{"location":"api/Getting%20Started/#getting-started","text":"The webqueue2 API is organized around REST . The API has resource oriented URLs, accepts and returns JSON encoded request bodies, can be modified via the query string and uses standard HTTP response codes and verbs. You can use the webqueue2 API hosted at https://engineering.purdue.edu/webqueue/webqueue2/build/api or install it on your own machine .","title":"Getting Started"},{"location":"api/Getting%20Started/#basic-usage","text":"Get the first item in CE queue. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data [ 0 ]. items [ 0 ] )); // Expected Output { queue : \"ce\" , number : 17 , lastUpdated : \"2021-03-29T17:12:00-0400\" ... } Get the subject of an CE 1. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 1 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data . subject )); // Expected Output \"Linux Server Purchase\"","title":"Basic Usage"},{"location":"api/Items/","text":"Items \u2693\ufe0e An item is a chronological representation of an interaction with a user. Endpoint \u2693\ufe0e GET /api/data/{queue}/{number} Parameters \u2693\ufe0e Name Value queue The queue of the item. number The number of the item. Query String Options \u2693\ufe0e Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"False\" .) \"True\" | \"False\" Return Codes \u2693\ufe0e Code Description 200 - Ok On success. 404 - Not Found When the Item does not exist. 500 - Internal Service Error On failure. Properties \u2693\ufe0e Item.assigned_to : \u2693\ufe0e Type Description String The Purdue career account alias of the person this item is assigned to. Example console . log ( Item . assigned_to ) // Expexted Output \"sundeep\" Item.building \u2693\ufe0e Type Description String The building a particular Item is related to. Example console . log ( Item . building ) // Expexted Output \"ME\" Item.content \u2693\ufe0e Type Description Array<Object> A chronological array of objects representing 1 of 9 possible actions taken on an item. Possible Actions Directory Information Information about the user info collected from ECNDB including but not limited to alias, phone number and office location. Properties Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue Parsed Example { \"type\" : \"directory_information\" , \"Name\" : \"Nestor Fabian Rodriguez Buitrago\" , \"Login\" : \"rodri563\" , \"Computer\" : \"ce-205-38 (128.46.205.67)\" , \"Location\" : \"HAMP G230\" , \"Email\" : \"rodri563@purdue.edu\" , \"Phone\" : \"7654766893\" , \"Office\" : \"HAMP G230\" , \"UNIX Dir\" : \"/home/bridge/b/rodri563\" , \"Zero Dir\" : \"U=\\\\\\\\bridge.ecn.purdue.edu\\\\rodri563\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/2e8399a\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2e83999\" , \"Subject\" : \"Autocad installation\" } Initial Message The body of the email the item originated from. Properties Key Value type initial_message datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. to A list of names(s) and email(s) of people this message was sent to. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. subject The subject of the initial message. content The content of the message as an list of strings. Parsed Example { \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps to item . subject , \"content\" : [ \"I need some help with something.\\n\" ] } Edit Information added by someone at ECN, usually for internal use and/or communication. Properties Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings. Parsed Example { \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] } Status A short message about the progress of the item. Properties Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings. Parsed Example { \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] } Assignment Assigning the item to someone. Properties Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to. Parsed Example { \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply From User A message from the user and/or related parties. Properties Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] } Parse Error An error caused by a malformed delimiter or nested delimiters. Properties Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error. Parsed Example { 'type' : 'parse_error' , 'datetime' : '2020-10-16T10:44:45' , 'file_path' : '/home/pier/e/benne238/webqueue2/q-snapshot/aae/2' , 'expected' : 'Did not encounter a reply-from-user ending delimiter' , 'got' : 'Kris' , 'line_num' : 468 } Item.date_received \u2693\ufe0e Type Description String An ISO 8601 formatted time string showing the date this item was created. Example console . log ( Item . date_received ) // Expexted Output \"2021-04-03T00:48:38+00:00\" Item.department \u2693\ufe0e Type Description String The most recent department for this item. Example console . log ( Item . department ) // Expexted Output \"Bussiness Office\" Item.headers \u2693\ufe0e Type Description Array<Object> An array of objects containing parsed item headers in type / value pairs. Example console . log ( Item . headers [ 0 ]) // Expexted Output { type : \"From\" , content : \"\\\"Campbell, Justin Tyler\\\" <campb303@purdue.edu>\\n\" } Item.is_locked \u2693\ufe0e Type Description Boolean A boolean showing whether or not a lockfile for the item is present. Example console . log ( Item . is_locked ) // Expexted Output true Item.last_updated \u2693\ufe0e Type Description String An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem. Example console . log ( Item . last_updated ) // Expected Output \"2021-04-03T00:48:38+00:00\" Item.number \u2693\ufe0e Type Description Number The indentifying number of the queue item. Example console . log ( Item . number ) // Expected Output 4 Item.path \u2693\ufe0e Type Description String The absolute file path to the Item. Example console . log ( Item . path ) // Expected Output \"/home/pier/e/queue/Mail/ce/1\" Item.priority: \u2693\ufe0e Type Description String The most recent priority for this item. Example console . log ( Item . priority ) // Expexted Output \"COVID\" Item.queue: \u2693\ufe0e Type Description String The queue the Item is in. Example console . log ( Item . queue ) // Expexted Output \"ce\" Item.status \u2693\ufe0e Type Description String The most recent status update for the item. Example console . log ( Item . status ) // Expexted Output \"Waiting for Reply\" Item.subject: \u2693\ufe0e Type Description String The subject of the original message for this item. Example console . log ( Item . subject ) // Expexted Output \"Can't Access Outlook\" Item.user_alias : \u2693\ufe0e Type Description String The Purdue career account alias of the person this item is from. Example console . log ( Item . user_alias ) // Expexted Output \"campb303\" Item.user_email \u2693\ufe0e Type Description String The email address of the person who this item is from. Example console . log ( Item . user_email ) // Expexted Output \"campb303@purdue.edu\" Item.user_name \u2693\ufe0e Type Description String The real name of the person who this item is from. Example console . log ( Item . user_name ) // Expexted Output \"Justin Campbell\"","title":"Items"},{"location":"api/Items/#items","text":"An item is a chronological representation of an interaction with a user.","title":"Items"},{"location":"api/Items/#endpoint","text":"GET /api/data/{queue}/{number}","title":"Endpoint"},{"location":"api/Items/#parameters","text":"Name Value queue The queue of the item. number The number of the item.","title":"Parameters"},{"location":"api/Items/#query-string-options","text":"Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"False\" .) \"True\" | \"False\"","title":"Query String Options"},{"location":"api/Items/#return-codes","text":"Code Description 200 - Ok On success. 404 - Not Found When the Item does not exist. 500 - Internal Service Error On failure.","title":"Return Codes"},{"location":"api/Items/#properties","text":"","title":"Properties"},{"location":"api/Items/#itemassigned_to","text":"Type Description String The Purdue career account alias of the person this item is assigned to. Example console . log ( Item . assigned_to ) // Expexted Output \"sundeep\"","title":"Item.assigned_to:"},{"location":"api/Items/#itembuilding","text":"Type Description String The building a particular Item is related to. Example console . log ( Item . building ) // Expexted Output \"ME\"","title":"Item.building"},{"location":"api/Items/#itemcontent","text":"Type Description Array<Object> A chronological array of objects representing 1 of 9 possible actions taken on an item. Possible Actions Directory Information Information about the user info collected from ECNDB including but not limited to alias, phone number and office location. Properties Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue Parsed Example { \"type\" : \"directory_information\" , \"Name\" : \"Nestor Fabian Rodriguez Buitrago\" , \"Login\" : \"rodri563\" , \"Computer\" : \"ce-205-38 (128.46.205.67)\" , \"Location\" : \"HAMP G230\" , \"Email\" : \"rodri563@purdue.edu\" , \"Phone\" : \"7654766893\" , \"Office\" : \"HAMP G230\" , \"UNIX Dir\" : \"/home/bridge/b/rodri563\" , \"Zero Dir\" : \"U=\\\\\\\\bridge.ecn.purdue.edu\\\\rodri563\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/2e8399a\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2e83999\" , \"Subject\" : \"Autocad installation\" } Initial Message The body of the email the item originated from. Properties Key Value type initial_message datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. to A list of names(s) and email(s) of people this message was sent to. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. subject The subject of the initial message. content The content of the message as an list of strings. Parsed Example { \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps to item . subject , \"content\" : [ \"I need some help with something.\\n\" ] } Edit Information added by someone at ECN, usually for internal use and/or communication. Properties Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings. Parsed Example { \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] } Status A short message about the progress of the item. Properties Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings. Parsed Example { \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] } Assignment Assigning the item to someone. Properties Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to. Parsed Example { \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply From User A message from the user and/or related parties. Properties Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] } Parse Error An error caused by a malformed delimiter or nested delimiters. Properties Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error. Parsed Example { 'type' : 'parse_error' , 'datetime' : '2020-10-16T10:44:45' , 'file_path' : '/home/pier/e/benne238/webqueue2/q-snapshot/aae/2' , 'expected' : 'Did not encounter a reply-from-user ending delimiter' , 'got' : 'Kris' , 'line_num' : 468 }","title":"Item.content"},{"location":"api/Items/#itemdate_received","text":"Type Description String An ISO 8601 formatted time string showing the date this item was created. Example console . log ( Item . date_received ) // Expexted Output \"2021-04-03T00:48:38+00:00\"","title":"Item.date_received"},{"location":"api/Items/#itemdepartment","text":"Type Description String The most recent department for this item. Example console . log ( Item . department ) // Expexted Output \"Bussiness Office\"","title":"Item.department"},{"location":"api/Items/#itemheaders","text":"Type Description Array<Object> An array of objects containing parsed item headers in type / value pairs. Example console . log ( Item . headers [ 0 ]) // Expexted Output { type : \"From\" , content : \"\\\"Campbell, Justin Tyler\\\" <campb303@purdue.edu>\\n\" }","title":"Item.headers"},{"location":"api/Items/#itemis_locked","text":"Type Description Boolean A boolean showing whether or not a lockfile for the item is present. Example console . log ( Item . is_locked ) // Expexted Output true","title":"Item.is_locked"},{"location":"api/Items/#itemlast_updated","text":"Type Description String An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem. Example console . log ( Item . last_updated ) // Expected Output \"2021-04-03T00:48:38+00:00\"","title":"Item.last_updated"},{"location":"api/Items/#itemnumber","text":"Type Description Number The indentifying number of the queue item. Example console . log ( Item . number ) // Expected Output 4","title":"Item.number"},{"location":"api/Items/#itempath","text":"Type Description String The absolute file path to the Item. Example console . log ( Item . path ) // Expected Output \"/home/pier/e/queue/Mail/ce/1\"","title":"Item.path"},{"location":"api/Items/#itempriority","text":"Type Description String The most recent priority for this item. Example console . log ( Item . priority ) // Expexted Output \"COVID\"","title":"Item.priority:"},{"location":"api/Items/#itemqueue","text":"Type Description String The queue the Item is in. Example console . log ( Item . queue ) // Expexted Output \"ce\"","title":"Item.queue:"},{"location":"api/Items/#itemstatus","text":"Type Description String The most recent status update for the item. Example console . log ( Item . status ) // Expexted Output \"Waiting for Reply\"","title":"Item.status"},{"location":"api/Items/#itemsubject","text":"Type Description String The subject of the original message for this item. Example console . log ( Item . subject ) // Expexted Output \"Can't Access Outlook\"","title":"Item.subject:"},{"location":"api/Items/#itemuser_alias","text":"Type Description String The Purdue career account alias of the person this item is from. Example console . log ( Item . user_alias ) // Expexted Output \"campb303\"","title":"Item.user_alias:"},{"location":"api/Items/#itemuser_email","text":"Type Description String The email address of the person who this item is from. Example console . log ( Item . user_email ) // Expexted Output \"campb303@purdue.edu\"","title":"Item.user_email"},{"location":"api/Items/#itemuser_name","text":"Type Description String The real name of the person who this item is from. Example console . log ( Item . user_name ) // Expexted Output \"Justin Campbell\"","title":"Item.user_name"},{"location":"api/Queues/","text":"Queues \u2693\ufe0e A collection of Items . Endpoint \u2693\ufe0e GET /api/data/{queue} Parameters \u2693\ufe0e Name Value queue The name of the queue. Query String Options \u2693\ufe0e Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"True\" .) \"True\" | \"True\" Return Codes \u2693\ufe0e Code Description 200 - Ok On success. 404 - Not Found When the Queue does not exist. 500 - Internal Service Error On failure. Properties \u2693\ufe0e Queue.name \u2693\ufe0e Type Description String The name of the queue. Example console . log ( Queue . name ) // Expected Output \"ce\" Queue.path \u2693\ufe0e Type Description String The absolute file path to the Queue. Example console . log ( Queue . path ) // Expected Output \"/home/pier/e/queue/Mail/ce\" Queue.items \u2693\ufe0e Type Description Array<Object> The Items in the queue. Example console . log ( Queue . items ) // Expected Output [ { queue : \"ce\" , number : 01 , lastUpdated : \"2021-03-26T17:12:00-0400\" ... } { queue : \"ce\" , number : 02 , lastUpdated : \"2021-05-29T17:12:00-0400\" ... } { queue : \"ce\" , number : 03 , lastUpdated : \"2020-12-29T17:12:00-0400\" ... } ]","title":"Queues"},{"location":"api/Queues/#queues","text":"A collection of Items .","title":"Queues"},{"location":"api/Queues/#endpoint","text":"GET /api/data/{queue}","title":"Endpoint"},{"location":"api/Queues/#parameters","text":"Name Value queue The name of the queue.","title":"Parameters"},{"location":"api/Queues/#query-string-options","text":"Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"True\" .) \"True\" | \"True\"","title":"Query String Options"},{"location":"api/Queues/#return-codes","text":"Code Description 200 - Ok On success. 404 - Not Found When the Queue does not exist. 500 - Internal Service Error On failure.","title":"Return Codes"},{"location":"api/Queues/#properties","text":"","title":"Properties"},{"location":"api/Queues/#queuename","text":"Type Description String The name of the queue. Example console . log ( Queue . name ) // Expected Output \"ce\"","title":"Queue.name"},{"location":"api/Queues/#queuepath","text":"Type Description String The absolute file path to the Queue. Example console . log ( Queue . path ) // Expected Output \"/home/pier/e/queue/Mail/ce\"","title":"Queue.path"},{"location":"api/Queues/#queueitems","text":"Type Description Array<Object> The Items in the queue. Example console . log ( Queue . items ) // Expected Output [ { queue : \"ce\" , number : 01 , lastUpdated : \"2021-03-26T17:12:00-0400\" ... } { queue : \"ce\" , number : 02 , lastUpdated : \"2021-05-29T17:12:00-0400\" ... } { queue : \"ce\" , number : 03 , lastUpdated : \"2020-12-29T17:12:00-0400\" ... } ]","title":"Queue.items"},{"location":"api/Simulating%20Responses/","text":"Returns the requested HTTP response with a JSON payload containing the response phrase. Valid response codes and phrases are pulled from the Python http library index . Endpoint \u2693\ufe0e GET /api/error/{response_code} Parameters \u2693\ufe0e Name Value response_code The HTTP response code to be returned. Example \u2693\ufe0e curl https://engineering.purdue.edu/webqueue/webqueue2/build/api/error/301 // Expected Output {\"message\": \"Moved Permanently\"}","title":"Simulating Responses"},{"location":"api/Simulating%20Responses/#endpoint","text":"GET /api/error/{response_code}","title":"Endpoint"},{"location":"api/Simulating%20Responses/#parameters","text":"Name Value response_code The HTTP response code to be returned.","title":"Parameters"},{"location":"api/Simulating%20Responses/#example","text":"curl https://engineering.purdue.edu/webqueue/webqueue2/build/api/error/301 // Expected Output {\"message\": \"Moved Permanently\"}","title":"Example"},{"location":"webqueue2api%20Package/Configuration/","text":"The configuration of webqueue2api can be managed in two different ways: At launch with a configuration file in the same directory as the virtual environment At runtime by modifying the webqueue2api.config symbol directly Configuration File \u2693\ufe0e On import, a ConfigParser INI formatted file is read for configuartion options. This file must be located in the same directory as the virtual environment folder and must be named webqueue2api_config.ini . A Full Config File [parser] # Absolute path to directory containing queue data. # Default: /home/pier/e/queue/Mail queue_directory = /etc/queue-cli/queues # List of queues to ignore. (Comma and space \", \" delimited.) # Default: archives, drafts, inbox, coral queues_to_ignore = dogs, cats, particularly_pugs [api] # Runtime configuration for secure production or convenient development settings. # Valid options are: prod | dev # Default: prod environment = dev # Token used to encrypt JWT payloads. # Default: webqueue2api.api.config.generate_random_string jwt_secret_key = uV0liG9$YgcGE7J! Changing Settings at Runtime \u2693\ufe0e Each package contains package level configuration objects (see: dataclasses on PyPI ) in config.py files. All of the configurations are combined into the top level webqueue2api.config symbol. These configuration objects store default values for each package. Default values can be changed by editing these objects directly or by editing the object values before their use. Changing the parser's queue directory by editing object values. import webqueue2api # Load Queue from default directory ce_queue = Queue ( \"ce\" ) # load Queue from modified directory webqueue2api . config . parser . queue_directory = \"/absolute/path\" other_queue = Queue ( \"other\" )","title":"Configuration"},{"location":"webqueue2api%20Package/Configuration/#configuration-file","text":"On import, a ConfigParser INI formatted file is read for configuartion options. This file must be located in the same directory as the virtual environment folder and must be named webqueue2api_config.ini . A Full Config File [parser] # Absolute path to directory containing queue data. # Default: /home/pier/e/queue/Mail queue_directory = /etc/queue-cli/queues # List of queues to ignore. (Comma and space \", \" delimited.) # Default: archives, drafts, inbox, coral queues_to_ignore = dogs, cats, particularly_pugs [api] # Runtime configuration for secure production or convenient development settings. # Valid options are: prod | dev # Default: prod environment = dev # Token used to encrypt JWT payloads. # Default: webqueue2api.api.config.generate_random_string jwt_secret_key = uV0liG9$YgcGE7J!","title":"Configuration File"},{"location":"webqueue2api%20Package/Configuration/#changing-settings-at-runtime","text":"Each package contains package level configuration objects (see: dataclasses on PyPI ) in config.py files. All of the configurations are combined into the top level webqueue2api.config symbol. These configuration objects store default values for each package. Default values can be changed by editing these objects directly or by editing the object values before their use. Changing the parser's queue directory by editing object values. import webqueue2api # Load Queue from default directory ce_queue = Queue ( \"ce\" ) # load Queue from modified directory webqueue2api . config . parser . queue_directory = \"/absolute/path\" other_queue = Queue ( \"other\" )","title":"Changing Settings at Runtime"},{"location":"webqueue2api%20Package/Getting%20Started/","text":"Getting Started \u2693\ufe0e The webqueue2api Package provides both a parser to read data from ECN's queue and allow for programatic data access as well as an WSGI application to serve the webqueue2 API. The webqueue2api Package has the following structure: webqueue2api : Contains global configuration and exports utilities/data classes. parser : Contains classes for reading data from queue text files and making it available via objects. api : Contains a WSGI application to host a RESTful API that relies on parser . Basic Usage \u2693\ufe0e Load all queues. import webqueue2api all_queues = webqueue2api . load_queues () for queue in all_queues : print ( f \" { queue . name } has { len ( queue . items ) } items.\" # Expected Output \"tech has 72 items\" \"ce has 38 items\" ... Load some queues. import webqueue2api all_queues = webqueue2api . load_queues ( \"che\" , \"tech\" , \"ce\" ) print ( len ( all_queues ) ) # Expected Output 3 Load a queue and get the number of items in it. import webqueue2api ce_queue = webqueue2api . Queue ( \"ce\" ) print ( len ( ce_queue . items ) ) # Expected Output 29 Load an item and get its subject. import webqueue2api ce_1 = webqueue2api . Item ( \"ce\" , 1 ) print ( len ( ce_1 . subject ) ) # Expected Output \"Re: Battery Replacement\"","title":"Getting Started"},{"location":"webqueue2api%20Package/Getting%20Started/#getting-started","text":"The webqueue2api Package provides both a parser to read data from ECN's queue and allow for programatic data access as well as an WSGI application to serve the webqueue2 API. The webqueue2api Package has the following structure: webqueue2api : Contains global configuration and exports utilities/data classes. parser : Contains classes for reading data from queue text files and making it available via objects. api : Contains a WSGI application to host a RESTful API that relies on parser .","title":"Getting Started"},{"location":"webqueue2api%20Package/Getting%20Started/#basic-usage","text":"Load all queues. import webqueue2api all_queues = webqueue2api . load_queues () for queue in all_queues : print ( f \" { queue . name } has { len ( queue . items ) } items.\" # Expected Output \"tech has 72 items\" \"ce has 38 items\" ... Load some queues. import webqueue2api all_queues = webqueue2api . load_queues ( \"che\" , \"tech\" , \"ce\" ) print ( len ( all_queues ) ) # Expected Output 3 Load a queue and get the number of items in it. import webqueue2api ce_queue = webqueue2api . Queue ( \"ce\" ) print ( len ( ce_queue . items ) ) # Expected Output 29 Load an item and get its subject. import webqueue2api ce_1 = webqueue2api . Item ( \"ce\" , 1 ) print ( len ( ce_1 . subject ) ) # Expected Output \"Re: Battery Replacement\"","title":"Basic Usage"},{"location":"webqueue2api%20Package/Package%20Structure/","text":"Hierarchy \u2693\ufe0e The webqueue2api Package consists of four packages in total: webqueue2api : The root packages. This contains both the api and the parser packages as well as global configuration. api : Contains a Flask app that can be used with any WSGI server to host the webqueue2 API and utilities such as authentication code. resources : Contains Flask-RESTful resources for the webqueue2 API. parser : Contains parers for a Queue and an Item as well as utilities and custom errors.","title":"Package Structure"},{"location":"webqueue2api%20Package/Package%20Structure/#hierarchy","text":"The webqueue2api Package consists of four packages in total: webqueue2api : The root packages. This contains both the api and the parser packages as well as global configuration. api : Contains a Flask app that can be used with any WSGI server to host the webqueue2 API and utilities such as authentication code. resources : Contains Flask-RESTful resources for the webqueue2 API. parser : Contains parers for a Queue and an Item as well as utilities and custom errors.","title":"Hierarchy"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/","text":"Below are the derived definitions for each section of an item as it appears in the item's plaintext file and as it is output from the parser. Directory Information \u2693\ufe0e Information about the user such as alias, phone number and office location. This only appears once right after the headers and right before the initial message. This only occurs if the item is submitted through the Trouble Reporting page. Fields \u2693\ufe0e Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue Delimiters \u2693\ufe0e Start : The second line after the first newline followed by a tab \\n\\t . End : The first non-empty line after the start that begins with whitespace then \"Subject:\" Plain Text Example \u2693\ufe0e \\tName: Jerry L Guerrero\\n Login: jerry\\n\" Computer: x-ee27\u00e50bpc1 (128.46.164.29)\\n Location: EE 270B\\n Email: jerry@purdue.edu\\n Phone: \\n Office: \\n UNIX Dir: /home/pier/c/jerry\\n Zero Dir: U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\\n User ECNDB: http://eng.purdue.edu/jump/bcafa8\\n Host ECNDB: http://eng.purdue.edu/jump/2dbd461 \\n Subject: Win7 to Win10 Migration List - kevin\\n Parsed Example \u2693\ufe0e { \"type\" : \"directory_information\" , \"Name\" : \"Jerry L Guerrero\" , \"Login\" : \"jerry\" , \"Computer\" : \"x-ee27\u00e50bpc1 (128.46.164.29)\" , \"Location\" : \"EE 270B\" , \"Email\" : \"jerry@purdue.edu\" , \"Phone\" : \"\" , \"Office\" : \"\" , \"UNIX Dir\" : \"/home/pier/c/jerry\" , \"Zero Dir\" : \"U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/bcafa8\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2dbd461\" , \"Subject\" : \"Win7 to Win10 Migration List - kevin\" } Initial Message \u2693\ufe0e The body of the email the item originated from. This usually appears directly after the headers unless directory information is present. Fields \u2693\ufe0e Key Value type initial_message datetime RFC 8061 formatted datetime string. Pulled from the Date header of the item. from_name The sender's real name. Formatting may vary. Pulled from the From header of the item. This can be empty. from_email The sender's email address. Pulled from the From header of the item. to A list of names(s) and email(s) of people this message was sent to. Pulled from the To header of the item. cc A list of name(s) and email(s) of people who were CC'd. Pulled from the Cc header of the item. This can be empty. subject The subject of the initial message. Pulled from the Subject header of the item. content The content of the message as an list of strings. Delimiters \u2693\ufe0e Start : First newline after directory information if present, otherwise first newline. End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e I need some help with something.\\n My printer stopped working.\\n Parsed Example \u2693\ufe0e { \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps t o i te m.subjec t , \"content\" : [ \"I need some help with something.\\n\" , \"My printer stopped working.\\n\" ] } Edit \u2693\ufe0e Information added by someone at ECN, usually for internal use and/or communication. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings. Delimiters \u2693\ufe0e Start : Line starting with *** Edited End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e *** Edited by: knewell at: 04/22/20 16:39:51 *** This is related to another item. I need to do X next. Parsed Example \u2693\ufe0e { \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] } Status \u2693\ufe0e A short message about the progress of the item. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings. Delimiters \u2693\ufe0e Start : Line starting with *** Status End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e *** Status updated by: knewell at: 4/23/2020 10:35:47 *** Doing X thing. Parsed Example \u2693\ufe0e { \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] } Assignment \u2693\ufe0e Assigning the item to someone. This does not occur in the body of the item. It it tracked in the headers using three different entries: Assigned-To-Updated-By : the career account alias of the person who updated the assignment Assigned-To-Updated-Time : the time the assignment was updated Assigned-To : the career account alias of the person the item was assigned to Fields \u2693\ufe0e Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to. Delimiters \u2693\ufe0e N/A Plain Text Example \u2693\ufe0e Assigned-To: campb303 Assigned-To-Updated-Time: Tue, 23 Jun 2020 13:27:00 EDT Assigned-To-Updated-By: harley Parsed Example \u2693\ufe0e { \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , } Reply To User \u2693\ufe0e A message from ECN to the user and/or related parties. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Delimiters \u2693\ufe0e Start : Line starting with *** Replied End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e *** Replied by: ewhile at: 05/08/20 09:21:43 *** Sascha, Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin. Ethan White ECN Parsed Example \u2693\ufe0e { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply from User \u2693\ufe0e A message from the user and/or related parties. This is only found after two or more items have been merged together. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings Delimiters: \u2693\ufe0e Start : Line starting with === End : Line starting with ==== Plain Text Example \u2693\ufe0e === Additional information supplied by user === Subject: RE: New Computer Deploy From: \"Reckowsky, Michael J.\" <mreckowsky@purdue.edu> Date: Fri, 8 May 2020 13:57:17 +0000 Ethan, Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork. Mike =============================================== Parsed Example \u2693\ufe0e { \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] } Parse Error \u2693\ufe0e Note This is not found in the item but generated when the item is parsed. An error caused by unexpected formatting. Fields \u2693\ufe0e Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error. Plain Text Example \u2693\ufe0e (item aae2 in qsnapshot) === Additional information supplied by user === Subject: RE: Help with hardware upgrades From: \"Ezra, Kristopher L\" <kris@purdue.edu> Date: Wed, 5 Feb 2020 18:11:58 +0000 If it makes no difference between windows and linux for the fileserver I'd rather service a linux machine. Considering the switches, i could do 2 8s and 2 16s. Two of the switches I'm replacing already service 9 connections and I'd rather not daisy chain. Is there something driving the price here? I see gigabit switches from tplink on amazon right now for $50. I dont need managed switches or anything fancy. Kris *** Replied by: emuffley at: 02/05/20 13:22:02 *** Kris, Thank you on the server operating question. We will kick that off to our linux folks for discussion. No daisy chain, agreed. These switches are unmanaged. For the workstations, are you wanting Windows, Linux or a mix? Eric Muffley Systems Engineer, Engineering Computer Network =============================================== Parsed Example \u2693\ufe0e { \"type\" : \"parse_error\" , \"datetime\" : \"2020-10-16T10:44:45\" , \"file_path\" : \"/home/pier/e/benne238/webqueue2/q-snapshot/aae/2\" , \"expected\" : \"Did not encounter a reply_from_user ending delimiter\" , \"got\" : \"Kris\" , \"line_num\" : 468 }","title":"Section Parsing Definitions"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#directory-information","text":"Information about the user such as alias, phone number and office location. This only appears once right after the headers and right before the initial message. This only occurs if the item is submitted through the Trouble Reporting page.","title":"Directory Information"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields","text":"Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters","text":"Start : The second line after the first newline followed by a tab \\n\\t . End : The first non-empty line after the start that begins with whitespace then \"Subject:\"","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example","text":"\\tName: Jerry L Guerrero\\n Login: jerry\\n\" Computer: x-ee27\u00e50bpc1 (128.46.164.29)\\n Location: EE 270B\\n Email: jerry@purdue.edu\\n Phone: \\n Office: \\n UNIX Dir: /home/pier/c/jerry\\n Zero Dir: U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\\n User ECNDB: http://eng.purdue.edu/jump/bcafa8\\n Host ECNDB: http://eng.purdue.edu/jump/2dbd461 \\n Subject: Win7 to Win10 Migration List - kevin\\n","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example","text":"{ \"type\" : \"directory_information\" , \"Name\" : \"Jerry L Guerrero\" , \"Login\" : \"jerry\" , \"Computer\" : \"x-ee27\u00e50bpc1 (128.46.164.29)\" , \"Location\" : \"EE 270B\" , \"Email\" : \"jerry@purdue.edu\" , \"Phone\" : \"\" , \"Office\" : \"\" , \"UNIX Dir\" : \"/home/pier/c/jerry\" , \"Zero Dir\" : \"U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/bcafa8\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2dbd461\" , \"Subject\" : \"Win7 to Win10 Migration List - kevin\" }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#initial-message","text":"The body of the email the item originated from. This usually appears directly after the headers unless directory information is present.","title":"Initial Message"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_1","text":"Key Value type initial_message datetime RFC 8061 formatted datetime string. Pulled from the Date header of the item. from_name The sender's real name. Formatting may vary. Pulled from the From header of the item. This can be empty. from_email The sender's email address. Pulled from the From header of the item. to A list of names(s) and email(s) of people this message was sent to. Pulled from the To header of the item. cc A list of name(s) and email(s) of people who were CC'd. Pulled from the Cc header of the item. This can be empty. subject The subject of the initial message. Pulled from the Subject header of the item. content The content of the message as an list of strings.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_1","text":"Start : First newline after directory information if present, otherwise first newline. End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_1","text":"I need some help with something.\\n My printer stopped working.\\n","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_1","text":"{ \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps t o i te m.subjec t , \"content\" : [ \"I need some help with something.\\n\" , \"My printer stopped working.\\n\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#edit","text":"Information added by someone at ECN, usually for internal use and/or communication. This can occur anywhere in the item after the initial message.","title":"Edit"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_2","text":"Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_2","text":"Start : Line starting with *** Edited End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_2","text":"*** Edited by: knewell at: 04/22/20 16:39:51 *** This is related to another item. I need to do X next.","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_2","text":"{ \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#status","text":"A short message about the progress of the item. This can occur anywhere in the item after the initial message.","title":"Status"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_3","text":"Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_3","text":"Start : Line starting with *** Status End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_3","text":"*** Status updated by: knewell at: 4/23/2020 10:35:47 *** Doing X thing.","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_3","text":"{ \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#assignment","text":"Assigning the item to someone. This does not occur in the body of the item. It it tracked in the headers using three different entries: Assigned-To-Updated-By : the career account alias of the person who updated the assignment Assigned-To-Updated-Time : the time the assignment was updated Assigned-To : the career account alias of the person the item was assigned to","title":"Assignment"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_4","text":"Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_4","text":"N/A","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_4","text":"Assigned-To: campb303 Assigned-To-Updated-Time: Tue, 23 Jun 2020 13:27:00 EDT Assigned-To-Updated-By: harley","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_4","text":"{ \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#reply-to-user","text":"A message from ECN to the user and/or related parties. This can occur anywhere in the item after the initial message.","title":"Reply To User"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_5","text":"Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_5","text":"Start : Line starting with *** Replied End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_5","text":"*** Replied by: ewhile at: 05/08/20 09:21:43 *** Sascha, Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin. Ethan White ECN","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_5","text":"{ \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#reply-from-user","text":"A message from the user and/or related parties. This is only found after two or more items have been merged together. This can occur anywhere in the item after the initial message.","title":"Reply from User"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_6","text":"Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_6","text":"Start : Line starting with === End : Line starting with ====","title":"Delimiters:"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_6","text":"=== Additional information supplied by user === Subject: RE: New Computer Deploy From: \"Reckowsky, Michael J.\" <mreckowsky@purdue.edu> Date: Fri, 8 May 2020 13:57:17 +0000 Ethan, Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork. Mike ===============================================","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_6","text":"{ \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parse-error","text":"Note This is not found in the item but generated when the item is parsed. An error caused by unexpected formatting.","title":"Parse Error"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_7","text":"Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_7","text":"(item aae2 in qsnapshot) === Additional information supplied by user === Subject: RE: Help with hardware upgrades From: \"Ezra, Kristopher L\" <kris@purdue.edu> Date: Wed, 5 Feb 2020 18:11:58 +0000 If it makes no difference between windows and linux for the fileserver I'd rather service a linux machine. Considering the switches, i could do 2 8s and 2 16s. Two of the switches I'm replacing already service 9 connections and I'd rather not daisy chain. Is there something driving the price here? I see gigabit switches from tplink on amazon right now for $50. I dont need managed switches or anything fancy. Kris *** Replied by: emuffley at: 02/05/20 13:22:02 *** Kris, Thank you on the server operating question. We will kick that off to our linux folks for discussion. No daisy chain, agreed. These switches are unmanaged. For the workstations, are you wanting Windows, Linux or a mix? Eric Muffley Systems Engineer, Engineering Computer Network ===============================================","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_7","text":"{ \"type\" : \"parse_error\" , \"datetime\" : \"2020-10-16T10:44:45\" , \"file_path\" : \"/home/pier/e/benne238/webqueue2/q-snapshot/aae/2\" , \"expected\" : \"Did not encounter a reply_from_user ending delimiter\" , \"got\" : \"Kris\" , \"line_num\" : 468 }","title":"Parsed Example"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"See the API Docs . See the Python Package Docs","title":"Home"},{"location":"Dev%20Environment%20Setup%20Guide/","text":"Dev Environment Setup Guide \u2693\ufe0e This document will walk you through the setup and configuration of a development environment for webqueue2 using the provided development machines, SSH authentication, GitHub and VS Code. Prerequisites \u2693\ufe0e On Your Computer \u2693\ufe0e VS Code Cisco AnyConnect for WebVPN On The Development Computer \u2693\ufe0e Note These are already installed on the provided development machines. git Python >= 3.6.9 Configuring Your SSH Keys \u2693\ufe0e We will be using SSH keys to authenticate to both the development machines and GitHub. In either PowerShell on Windows or bash on macOS/Linux, run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in the .ssh folder inside your user's folder. Your user's folder can usually be found at: Windows C:\\Users\\<user_name> macOS /Users/<user_name> Linux /home/<user_name> Note Most CLI shells like PowerShell and bash use the ~ (tilda) key as a shortcut for your user's folder. You can confirm these files were created by running: ls ~/.ssh/ Configuring SSH \u2693\ufe0e In your editor of choice, create the file ~/.ssh/config and add this: Tip Replace campb303 with your career account username and replace w2vm1 with the name of the provided development machine you're connecting to. Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 The configuration above will allow you to connect to the development machine and automatically forward ports for development tools to work. Here's a bit more detail about what's going on: Key Value Host A friendly name to identify an SSH host by. This can be anything. HostName The DNS name or IP address of the computer you're connecting to. User The name of your user on the computer you're connecting to. LocalForward Forwards a port on your computer to a port on the computer you're connecting to. Development machines are not publicly accessible. You'll need to be connected to WebVPN to connect to them. SSH Jump Hosts WebVPN works on all platforms but requires an extra step to get to work. On macOS/Linux, pier.ecn.purdue.edu can be used as an SSH jump host allowing for development machines to be connected to automatically when openning VS Code. Assuming you already have an SSH key configured for pier.ecn.purdue.edu , you can use a jump host by adding the following to ~/.ssh/config : Host campb303-pier HostName pier.ecn.purdue.edu User campb303 Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu ProxyJump campb303-pier User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 To test your configuration, run ssh followed by the Host value. When prompted for your password, enter your career account password and press Enter . Warning Most shell environemnts like PowerShell and bash do not show your password being typed but it is being typed. For the configuration above you would run: ssh campb303-w2vm1 campb303@w2vm1's password: Adding SSH Keys \u2693\ufe0e Now that we've generated SSH keys and configured our host entries, we need to add our SSH key to the host. This will allow us to connect to these machines without passwords later. Tip Replace HOST below with the value from above. Example: campb303-w2vm1 PowerShell on Windows type $env:USERPROFILE \\. ssh \\ id_rsa . pub | ssh HOST \"cat >> .ssh/authorized_keys\" bash on macOS/Linux ssh-copy-id HOST If the key was added successfully, you can login without entering a password by running: ssh HOST Installing VS Code \u2693\ufe0e Download and install VS Code . Be sure to add code to your PATH. Windows Adding code to your PATH on Windows is a checkbox in the installer: Image from this article on Techomoro macOS/Linux Adding code to your PATH on macOS/Linux is accessible by searching for \"PATH\" in the Command Pallete. You can access the Command Pallete with the keyboard shortcut Command / Ctrl + Shift + P : Image from this StackOverflow thread Connecting To The Development Machine \u2693\ufe0e Install the Remote - SSH plugin. After installation a new icon will appear in the sidebar: Click on the Remote SSH icon and you'll see the SSH host you just defined Select the host and click the New Window icon to connect. A new window connected to that host will appear Note This may take a couple of minutes on the first connection while VS Code installs its server. If prompted for a platform, select Linux: Adding Your SSH Keys to GitHub \u2693\ufe0e Because the development machine will be the computer that connects to GitHub, we need to create another SSH key and add it to our GitHub profile: First, open VS Code's integrated terminal by pressing Control + ~ (tilda) Now run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in ~/.ssh/ . You can confirm this by running: ls ~/.ssh/ Now copy the public key from id_rsa.pub by openning the file in VS Code, selecting its contents and copying it. You can open the file in VS Code by running the following in the integrated terminal: Danger Do not copy your private key from id_rsa ! This key should never leave your machine. code ~/.ssh/id_rsa.pub Now go to github.itap.purdue.edu/settings/keys . You may be prompted to login using your career account username and password. Click the \"New SSH Key\" button Give the key a title that tells you what device the key is from (e.g. Desktop or Dev Machine) Paste the contents of id_rsa.pub into the key box Click the \"Add SSH Key\" button Cloning and Opening the Repository \u2693\ufe0e Using the integrated terminal in VS Code, run: git clone git@github.itap.purdue.edu:ECN/webqueue2-api.git This will create a webqueue2-api folder in your user's home directory. Open this directory using the \"Open Folder\" button: Note VS Code will automatically reconnect to the last remote host used when it reopens. Tip If you need to reconnect manually, there will now be an option to open the webqueue2-api folder directly from the Remote Hosts menu: Configuring VS Code \u2693\ufe0e Installing Extensions \u2693\ufe0e Pylance for Python language support, IntelliSense, virtual environments and debugging Git Graph for a more detailed view of git info Markdown Preview GitHub Styling for previewing Markdown as it will appear on GitHub Python Docstring Generator for generating Google style docstrings according to section 3.8 of Google's Python style guide Configuring Extensions \u2693\ufe0e Python \u2693\ufe0e The Python extension supports virtual environments but needs to be told where the virtual environment is. Create or modify the file .vscode/settings.json and add the following: \"python.defaultInterpreterPath\": \"./venv/bin/python3\" Tip The Python extension may complain and tell you to select another interpreter. Ignore this warning for now. Python Docstring Generator \u2693\ufe0e For consistentcy, we'll use a docstring template. Create or modify the file .vscode/settings.json and add the following: \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" At this point, your .vscode/settings.json file should look like this: { \"python.pythonPath\": \"./venv/bin/python3\", \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" } Setting Up the Virtual Environment \u2693\ufe0e For development, we'll use a Python Virtual Environment to isolate out changes and have a reproducible dev environment. In VS Code's integrated terminal: Create a virtual environment at ./venv/ : python3 -m venv venv Activate the virtual environment: source venv/bin/activate Tip To deactivate the virtual environment and use your system's Python interpreter, run: deactivate Update pip within the virtual environment: pip install -U pip Install the webqueue2 API within the virtual environemt: pip install -e .[all] -e installs a package in editable mode which allows code changes to take effect without reinstalling a package. webqueue2 API has multiple conditional dependencies : Condition Installation Command Description Production pip install . For use in production. Only installed needed packages. Development pip install .[dev] For use in development. Installs everything for production and extra packages for development. Documentation pip install .[docs] For use in creating documentation. Installs everything for production and extra packages for documentation. All pip install .[all] A shortcut for installing production, development and documentation dependencies. API Commands \u2693\ufe0e Command Description gunicorn webqueue2api.api:app This will start a local server on localhost:8000 to access the API. mkdocs serve This will start a local server on localhost:6060 to access the API docs. As you change API documentation files in ./docs/ you'll see your changes in the browser. mkdocs build This will output a static bundle of the API documentation in ./site/ that can be put on any webserver.","title":"Dev Environment Setup Guide"},{"location":"Dev%20Environment%20Setup%20Guide/#dev-environment-setup-guide","text":"This document will walk you through the setup and configuration of a development environment for webqueue2 using the provided development machines, SSH authentication, GitHub and VS Code.","title":"Dev Environment Setup Guide"},{"location":"Dev%20Environment%20Setup%20Guide/#prerequisites","text":"","title":"Prerequisites"},{"location":"Dev%20Environment%20Setup%20Guide/#on-your-computer","text":"VS Code Cisco AnyConnect for WebVPN","title":"On Your Computer"},{"location":"Dev%20Environment%20Setup%20Guide/#on-the-development-computer","text":"Note These are already installed on the provided development machines. git Python >= 3.6.9","title":"On The Development Computer"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-your-ssh-keys","text":"We will be using SSH keys to authenticate to both the development machines and GitHub. In either PowerShell on Windows or bash on macOS/Linux, run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in the .ssh folder inside your user's folder. Your user's folder can usually be found at: Windows C:\\Users\\<user_name> macOS /Users/<user_name> Linux /home/<user_name> Note Most CLI shells like PowerShell and bash use the ~ (tilda) key as a shortcut for your user's folder. You can confirm these files were created by running: ls ~/.ssh/","title":"Configuring Your SSH Keys"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-ssh","text":"In your editor of choice, create the file ~/.ssh/config and add this: Tip Replace campb303 with your career account username and replace w2vm1 with the name of the provided development machine you're connecting to. Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 The configuration above will allow you to connect to the development machine and automatically forward ports for development tools to work. Here's a bit more detail about what's going on: Key Value Host A friendly name to identify an SSH host by. This can be anything. HostName The DNS name or IP address of the computer you're connecting to. User The name of your user on the computer you're connecting to. LocalForward Forwards a port on your computer to a port on the computer you're connecting to. Development machines are not publicly accessible. You'll need to be connected to WebVPN to connect to them. SSH Jump Hosts WebVPN works on all platforms but requires an extra step to get to work. On macOS/Linux, pier.ecn.purdue.edu can be used as an SSH jump host allowing for development machines to be connected to automatically when openning VS Code. Assuming you already have an SSH key configured for pier.ecn.purdue.edu , you can use a jump host by adding the following to ~/.ssh/config : Host campb303-pier HostName pier.ecn.purdue.edu User campb303 Host campb303-w2vm1 HostName w2vm1.ecn.purdue.edu ProxyJump campb303-pier User campb303 # Forward Flask Debug Port LocalForward 5000 localhost:5000 # Forward MkDocs Port LocalForward 5000 localhost:6060 # Forward gunicorn Port LocalForward 8000 localhost:8000 To test your configuration, run ssh followed by the Host value. When prompted for your password, enter your career account password and press Enter . Warning Most shell environemnts like PowerShell and bash do not show your password being typed but it is being typed. For the configuration above you would run: ssh campb303-w2vm1 campb303@w2vm1's password:","title":"Configuring SSH"},{"location":"Dev%20Environment%20Setup%20Guide/#adding-ssh-keys","text":"Now that we've generated SSH keys and configured our host entries, we need to add our SSH key to the host. This will allow us to connect to these machines without passwords later. Tip Replace HOST below with the value from above. Example: campb303-w2vm1 PowerShell on Windows type $env:USERPROFILE \\. ssh \\ id_rsa . pub | ssh HOST \"cat >> .ssh/authorized_keys\" bash on macOS/Linux ssh-copy-id HOST If the key was added successfully, you can login without entering a password by running: ssh HOST","title":"Adding SSH Keys"},{"location":"Dev%20Environment%20Setup%20Guide/#installing-vs-code","text":"Download and install VS Code . Be sure to add code to your PATH. Windows Adding code to your PATH on Windows is a checkbox in the installer: Image from this article on Techomoro macOS/Linux Adding code to your PATH on macOS/Linux is accessible by searching for \"PATH\" in the Command Pallete. You can access the Command Pallete with the keyboard shortcut Command / Ctrl + Shift + P : Image from this StackOverflow thread","title":"Installing VS Code"},{"location":"Dev%20Environment%20Setup%20Guide/#connecting-to-the-development-machine","text":"Install the Remote - SSH plugin. After installation a new icon will appear in the sidebar: Click on the Remote SSH icon and you'll see the SSH host you just defined Select the host and click the New Window icon to connect. A new window connected to that host will appear Note This may take a couple of minutes on the first connection while VS Code installs its server. If prompted for a platform, select Linux:","title":"Connecting To The Development Machine"},{"location":"Dev%20Environment%20Setup%20Guide/#adding-your-ssh-keys-to-github","text":"Because the development machine will be the computer that connects to GitHub, we need to create another SSH key and add it to our GitHub profile: First, open VS Code's integrated terminal by pressing Control + ~ (tilda) Now run the following command and accept all defaults by pressing Enter : ssh-keygen This will create the files id_rsa and id_rsa.pub in ~/.ssh/ . You can confirm this by running: ls ~/.ssh/ Now copy the public key from id_rsa.pub by openning the file in VS Code, selecting its contents and copying it. You can open the file in VS Code by running the following in the integrated terminal: Danger Do not copy your private key from id_rsa ! This key should never leave your machine. code ~/.ssh/id_rsa.pub Now go to github.itap.purdue.edu/settings/keys . You may be prompted to login using your career account username and password. Click the \"New SSH Key\" button Give the key a title that tells you what device the key is from (e.g. Desktop or Dev Machine) Paste the contents of id_rsa.pub into the key box Click the \"Add SSH Key\" button","title":"Adding Your SSH Keys to GitHub"},{"location":"Dev%20Environment%20Setup%20Guide/#cloning-and-opening-the-repository","text":"Using the integrated terminal in VS Code, run: git clone git@github.itap.purdue.edu:ECN/webqueue2-api.git This will create a webqueue2-api folder in your user's home directory. Open this directory using the \"Open Folder\" button: Note VS Code will automatically reconnect to the last remote host used when it reopens. Tip If you need to reconnect manually, there will now be an option to open the webqueue2-api folder directly from the Remote Hosts menu:","title":"Cloning and Opening the Repository"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-vs-code","text":"","title":"Configuring VS Code"},{"location":"Dev%20Environment%20Setup%20Guide/#installing-extensions","text":"Pylance for Python language support, IntelliSense, virtual environments and debugging Git Graph for a more detailed view of git info Markdown Preview GitHub Styling for previewing Markdown as it will appear on GitHub Python Docstring Generator for generating Google style docstrings according to section 3.8 of Google's Python style guide","title":"Installing Extensions"},{"location":"Dev%20Environment%20Setup%20Guide/#configuring-extensions","text":"","title":"Configuring Extensions"},{"location":"Dev%20Environment%20Setup%20Guide/#python","text":"The Python extension supports virtual environments but needs to be told where the virtual environment is. Create or modify the file .vscode/settings.json and add the following: \"python.defaultInterpreterPath\": \"./venv/bin/python3\" Tip The Python extension may complain and tell you to select another interpreter. Ignore this warning for now.","title":"Python"},{"location":"Dev%20Environment%20Setup%20Guide/#python-docstring-generator","text":"For consistentcy, we'll use a docstring template. Create or modify the file .vscode/settings.json and add the following: \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" At this point, your .vscode/settings.json file should look like this: { \"python.pythonPath\": \"./venv/bin/python3\", \"autoDocstring.customTemplatePath\": \"./docstring-format.mustache\" }","title":"Python Docstring Generator"},{"location":"Dev%20Environment%20Setup%20Guide/#setting-up-the-virtual-environment","text":"For development, we'll use a Python Virtual Environment to isolate out changes and have a reproducible dev environment. In VS Code's integrated terminal: Create a virtual environment at ./venv/ : python3 -m venv venv Activate the virtual environment: source venv/bin/activate Tip To deactivate the virtual environment and use your system's Python interpreter, run: deactivate Update pip within the virtual environment: pip install -U pip Install the webqueue2 API within the virtual environemt: pip install -e .[all] -e installs a package in editable mode which allows code changes to take effect without reinstalling a package. webqueue2 API has multiple conditional dependencies : Condition Installation Command Description Production pip install . For use in production. Only installed needed packages. Development pip install .[dev] For use in development. Installs everything for production and extra packages for development. Documentation pip install .[docs] For use in creating documentation. Installs everything for production and extra packages for documentation. All pip install .[all] A shortcut for installing production, development and documentation dependencies.","title":"Setting Up the Virtual Environment"},{"location":"Dev%20Environment%20Setup%20Guide/#api-commands","text":"Command Description gunicorn webqueue2api.api:app This will start a local server on localhost:8000 to access the API. mkdocs serve This will start a local server on localhost:6060 to access the API docs. As you change API documentation files in ./docs/ you'll see your changes in the browser. mkdocs build This will output a static bundle of the API documentation in ./site/ that can be put on any webserver.","title":"API Commands"},{"location":"Installation/","text":"Installation \u2693\ufe0e The webqueue2 API is publicly available at https://engineering.purdue.edu/webqueue/webqueue2/build/api but you can install it on your own machine if you'd like. The code is available on GitHub . Available package versions can be seen on the releases page and can be installed via pip, a requirements file, or downloaded and installed manually. pip available on ECN machines needs updated. Installation via pip is possible through pip's VCS support which was introduced in pip 19. The version of pip available on ECN supported machines is too old and needs updated. To update pip, run: pip install -U pop Using a virtual environment is recommended for reproducibility. Create a virtual environment called __venv__ : python3 -m venv __venv__ Activate the virtual environment: source __venv__/bin/activate Update pip: pip install -U pip Install via pip To install webqueue2-api 1.0.0, you can run: pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api Install via requirements file To install webqueue2-api 1.0.0, place the following line your requirements file: echo \"git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api\" >> requirements.txt pip install -r requirements.txt If you'd like a version other than 1.0.0 simply replace the that version number with a different version listed on the releases page . To start the server, run the following while your virtual environment is activated: gunicorn webqueue2api.api:app","title":"Installation"},{"location":"Installation/#installation","text":"The webqueue2 API is publicly available at https://engineering.purdue.edu/webqueue/webqueue2/build/api but you can install it on your own machine if you'd like. The code is available on GitHub . Available package versions can be seen on the releases page and can be installed via pip, a requirements file, or downloaded and installed manually. pip available on ECN machines needs updated. Installation via pip is possible through pip's VCS support which was introduced in pip 19. The version of pip available on ECN supported machines is too old and needs updated. To update pip, run: pip install -U pop Using a virtual environment is recommended for reproducibility. Create a virtual environment called __venv__ : python3 -m venv __venv__ Activate the virtual environment: source __venv__/bin/activate Update pip: pip install -U pip Install via pip To install webqueue2-api 1.0.0, you can run: pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api Install via requirements file To install webqueue2-api 1.0.0, place the following line your requirements file: echo \"git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api\" >> requirements.txt pip install -r requirements.txt If you'd like a version other than 1.0.0 simply replace the that version number with a different version listed on the releases page . To start the server, run the following while your virtual environment is activated: gunicorn webqueue2api.api:app","title":"Installation"},{"location":"Material%20for%20mkdocs%20Formatting/","text":"Material for mkdocs Formatting \u2693\ufe0e Admonitions \u2693\ufe0e See: Material for mkdocs: Admonitions Note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Summary Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Info Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Custom Title Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Code Blocks \u2693\ufe0e See: Material for mkdocs: Code Blocks # This is a Python code block. print ( \"Hello world!\" ) if __name__ == \"__main__\" 1 2 # This is a JavaScript code block with line numbers . ( _ => console . log ( \"Hello world!\" ))(); # This is a Markdown code block with line highlights and nested code block. ``` js ( _ => console.log(\"Hello world!\"))(); ``` This is an inline Java highlight system . out . println ( \"Hello world!\" ) Content Tabs \u2693\ufe0e See: Material for mkdocs: Content Tabs Basic Tabs \u2693\ufe0e === \"Tab 1\" Hello === \"Tab 2\" World Tab 1 Hello Tab 2 World Tabs in Admonitions with Code Blocks \u2693\ufe0e !!! example \"Hello world\" in many languages: === \"Python\" ```python print ( \"Hello world!\" ) if __name__ == \"__main__\" ``` === \"JavaScript\" ```js ( _ => console . log ( \"Hello world!\" ))(); ``` Example \"Hello world\" in many languages: Python print ( \"Hello world!\" ) if __name__ == \"__main__\" JavaScript ( _ => console . log ( \"Hello world!\" ))(); Data Tables \u2693\ufe0e See: Material for mkdocs: Data Tables | Method | Description | | ----------- | ------------------------------------ | | `GET` | :material-check: Fetch resource | | `PUT` | :material-check-all: Update resource | | `DELETE` | :material-close: Delete resource | Method Description GET Fetch resource PUT Update resource DELETE Delete resource","title":"Material for mkdocs Formatting"},{"location":"Material%20for%20mkdocs%20Formatting/#material-for-mkdocs-formatting","text":"","title":"Material for mkdocs Formatting"},{"location":"Material%20for%20mkdocs%20Formatting/#admonitions","text":"See: Material for mkdocs: Admonitions Note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Summary Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Info Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. Custom Title Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.","title":"Admonitions"},{"location":"Material%20for%20mkdocs%20Formatting/#code-blocks","text":"See: Material for mkdocs: Code Blocks # This is a Python code block. print ( \"Hello world!\" ) if __name__ == \"__main__\" 1 2 # This is a JavaScript code block with line numbers . ( _ => console . log ( \"Hello world!\" ))(); # This is a Markdown code block with line highlights and nested code block. ``` js ( _ => console.log(\"Hello world!\"))(); ``` This is an inline Java highlight system . out . println ( \"Hello world!\" )","title":"Code Blocks"},{"location":"Material%20for%20mkdocs%20Formatting/#content-tabs","text":"See: Material for mkdocs: Content Tabs","title":"Content Tabs"},{"location":"Material%20for%20mkdocs%20Formatting/#basic-tabs","text":"=== \"Tab 1\" Hello === \"Tab 2\" World Tab 1 Hello Tab 2 World","title":"Basic Tabs"},{"location":"Material%20for%20mkdocs%20Formatting/#tabs-in-admonitions-with-code-blocks","text":"!!! example \"Hello world\" in many languages: === \"Python\" ```python print ( \"Hello world!\" ) if __name__ == \"__main__\" ``` === \"JavaScript\" ```js ( _ => console . log ( \"Hello world!\" ))(); ``` Example \"Hello world\" in many languages: Python print ( \"Hello world!\" ) if __name__ == \"__main__\" JavaScript ( _ => console . log ( \"Hello world!\" ))();","title":"Tabs in Admonitions with Code Blocks"},{"location":"Material%20for%20mkdocs%20Formatting/#data-tables","text":"See: Material for mkdocs: Data Tables | Method | Description | | ----------- | ------------------------------------ | | `GET` | :material-check: Fetch resource | | `PUT` | :material-check-all: Update resource | | `DELETE` | :material-close: Delete resource | Method Description GET Fetch resource PUT Update resource DELETE Delete resource","title":"Data Tables"},{"location":"api/Authentication/","text":"Authentication \u2693\ufe0e The webqueue2 API uses a two stage authentication system combining Active Directory and HTTP Token (or \"bearer\") authentication. Getting an Access Token \u2693\ufe0e All API calls require an access token. You can get an access token by making a POST request to the /api/login endpoint containing the JSON encoded username and password of a valid user. Who is a valid user? A valid user is a non-admin BoilerAD user who is in the 00000227-ECN-webqueue group. Users cannot be added directly to this group. To be included in this group, a user must exist in one of the following groups: 00000227-ECNStaff 00000227-ECNStuds 00000227-ECN-webqueue-misc Example \u2693\ufe0e Get an access token. fetch ( \"https://engineering.purdue.edu/webqueue/webqueue2/build/api/login\" , { method : \"POST\" , headers : { 'Content-Type' : 'application/json' }, body : JSON . stringify ({ \"username\" : USERNAME , \"password\" : PASSWORD }) } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )) // Expected Output \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" Making Calls With Access Token \u2693\ufe0e To interact with the API, add an Authorization header to your request with a value of Bearer TOKEN where TOKEN is your access token. Example: \u2693\ufe0e Get item CE 100. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 100 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data )); // Expected Output { queue : \"ce\" , number : 100 , lastUpdated : \"2021-03-11T07:24:00-0500\" ... } Refreshing Access Tokens \u2693\ufe0e When you login, you'll receive an access token that expires 15 minutes after creation as well as two cookies needed to get a new access token. Those cookies are: Name Value Path Expiration SameSite refresh_token_cookie Your refresh token. /api/tokens/refresh 30 Days Yes csrf_refresh_token Additional verification data. (e.g. 7b7c1ea8-f6bb-4204-99af-cd4124a69d89 ) / Session Yes The refresh_token_cookie is used to generate a new access token and will be sent back to the server with every request automatically. It expires 30 days after login. The csrf_refresh_token is used to verify the refresh_token_cookie and needs sent back as an X-CSRF-TOKEN header. To refresh your access token, make a POST request to the /api/tokens/refresh endpoint with the value of the csrf_refresh_token cookies inside a X-CSRF-TOKEN header: Example \u2693\ufe0e Get a new refresh token. // Get this value from your cookies. const csrf_refresh_token = \"7b7c1ea8-f6bb-4204-99af-cd4124a69d89\" fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/tokens/refresh` , { method : \"POST\" , headers : { 'X-CSRF-TOKEN' : csrf_refresh_token } } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )); // Expected Output eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 . eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ .6 z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE","title":"Authentication"},{"location":"api/Authentication/#authentication","text":"The webqueue2 API uses a two stage authentication system combining Active Directory and HTTP Token (or \"bearer\") authentication.","title":"Authentication"},{"location":"api/Authentication/#getting-an-access-token","text":"All API calls require an access token. You can get an access token by making a POST request to the /api/login endpoint containing the JSON encoded username and password of a valid user. Who is a valid user? A valid user is a non-admin BoilerAD user who is in the 00000227-ECN-webqueue group. Users cannot be added directly to this group. To be included in this group, a user must exist in one of the following groups: 00000227-ECNStaff 00000227-ECNStuds 00000227-ECN-webqueue-misc","title":"Getting an Access Token"},{"location":"api/Authentication/#example","text":"Get an access token. fetch ( \"https://engineering.purdue.edu/webqueue/webqueue2/build/api/login\" , { method : \"POST\" , headers : { 'Content-Type' : 'application/json' }, body : JSON . stringify ({ \"username\" : USERNAME , \"password\" : PASSWORD }) } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )) // Expected Output \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\"","title":"Example"},{"location":"api/Authentication/#making-calls-with-access-token","text":"To interact with the API, add an Authorization header to your request with a value of Bearer TOKEN where TOKEN is your access token.","title":"Making Calls With Access Token"},{"location":"api/Authentication/#example_1","text":"Get item CE 100. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 100 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data )); // Expected Output { queue : \"ce\" , number : 100 , lastUpdated : \"2021-03-11T07:24:00-0500\" ... }","title":"Example:"},{"location":"api/Authentication/#refreshing-access-tokens","text":"When you login, you'll receive an access token that expires 15 minutes after creation as well as two cookies needed to get a new access token. Those cookies are: Name Value Path Expiration SameSite refresh_token_cookie Your refresh token. /api/tokens/refresh 30 Days Yes csrf_refresh_token Additional verification data. (e.g. 7b7c1ea8-f6bb-4204-99af-cd4124a69d89 ) / Session Yes The refresh_token_cookie is used to generate a new access token and will be sent back to the server with every request automatically. It expires 30 days after login. The csrf_refresh_token is used to verify the refresh_token_cookie and needs sent back as an X-CSRF-TOKEN header. To refresh your access token, make a POST request to the /api/tokens/refresh endpoint with the value of the csrf_refresh_token cookies inside a X-CSRF-TOKEN header:","title":"Refreshing Access Tokens"},{"location":"api/Authentication/#example_2","text":"Get a new refresh token. // Get this value from your cookies. const csrf_refresh_token = \"7b7c1ea8-f6bb-4204-99af-cd4124a69d89\" fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/tokens/refresh` , { method : \"POST\" , headers : { 'X-CSRF-TOKEN' : csrf_refresh_token } } ) . then ( resp => resp . json () ) . then ( data => console . log ( data . access_token )); // Expected Output eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 . eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ .6 z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE","title":"Example"},{"location":"api/Getting%20Started/","text":"Getting Started \u2693\ufe0e The webqueue2 API is organized around REST . The API has resource oriented URLs, accepts and returns JSON encoded request bodies, can be modified via the query string and uses standard HTTP response codes and verbs. You can use the webqueue2 API hosted at https://engineering.purdue.edu/webqueue/webqueue2/build/api or install it on your own machine . Basic Usage \u2693\ufe0e Get the first item in CE queue. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data [ 0 ]. items [ 0 ] )); // Expected Output { queue : \"ce\" , number : 17 , lastUpdated : \"2021-03-29T17:12:00-0400\" ... } Get the subject of an CE 1. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 1 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data . subject )); // Expected Output \"Linux Server Purchase\"","title":"Getting Started"},{"location":"api/Getting%20Started/#getting-started","text":"The webqueue2 API is organized around REST . The API has resource oriented URLs, accepts and returns JSON encoded request bodies, can be modified via the query string and uses standard HTTP response codes and verbs. You can use the webqueue2 API hosted at https://engineering.purdue.edu/webqueue/webqueue2/build/api or install it on your own machine .","title":"Getting Started"},{"location":"api/Getting%20Started/#basic-usage","text":"Get the first item in CE queue. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data [ 0 ]. items [ 0 ] )); // Expected Output { queue : \"ce\" , number : 17 , lastUpdated : \"2021-03-29T17:12:00-0400\" ... } Get the subject of an CE 1. let access_token = \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTY1NTIyMDIsIm5iZiI6MTYxNjU1MjIwMiwianRpIjoiZDgyNGM1MWItM2JmNy00ZDUzLWE0YTgtY2VhZWQ5ZmVjNGYzIiwiZXhwIjoxNjE2NTUzMTAyLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiI1Yjk5NWQ5OS05YjIzLTQyMjYtYTc0OC1lMmQ5OTA4MDkzOTQifQ.6z7EReDfhPkBkuAMHEvDuMDV4wVbqrWSjQXdRyv_5hE\" ; let queue = \"ce\" ; let item_number = 1 ; fetch ( `https://engineering.purdue.edu/webqueue/webqueue2/build/api/data/ ${ queue } / ${ item_number } ` , { headers : { \"Authorization\" : `Bearer ${ access_token } ` }} ) . then ( resp => resp . json () ) . then ( data => console . log ( data . subject )); // Expected Output \"Linux Server Purchase\"","title":"Basic Usage"},{"location":"api/Items/","text":"Items \u2693\ufe0e An item is a chronological representation of an interaction with a user. Endpoint \u2693\ufe0e GET /api/data/{queue}/{number} Parameters \u2693\ufe0e Name Value queue The queue of the item. number The number of the item. Query String Options \u2693\ufe0e Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"False\" .) \"True\" | \"False\" Return Codes \u2693\ufe0e Code Description 200 - Ok On success. 404 - Not Found When the Item does not exist. 500 - Internal Service Error On failure. Properties \u2693\ufe0e Item.assigned_to : \u2693\ufe0e Type Description String The Purdue career account alias of the person this item is assigned to. Example console . log ( Item . assigned_to ) // Expexted Output \"sundeep\" Item.building \u2693\ufe0e Type Description String The building a particular Item is related to. Example console . log ( Item . building ) // Expexted Output \"ME\" Item.content \u2693\ufe0e Type Description Array<Object> A chronological array of objects representing 1 of 9 possible actions taken on an item. Possible Actions Directory Information Information about the user info collected from ECNDB including but not limited to alias, phone number and office location. Properties Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue Parsed Example { \"type\" : \"directory_information\" , \"Name\" : \"Nestor Fabian Rodriguez Buitrago\" , \"Login\" : \"rodri563\" , \"Computer\" : \"ce-205-38 (128.46.205.67)\" , \"Location\" : \"HAMP G230\" , \"Email\" : \"rodri563@purdue.edu\" , \"Phone\" : \"7654766893\" , \"Office\" : \"HAMP G230\" , \"UNIX Dir\" : \"/home/bridge/b/rodri563\" , \"Zero Dir\" : \"U=\\\\\\\\bridge.ecn.purdue.edu\\\\rodri563\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/2e8399a\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2e83999\" , \"Subject\" : \"Autocad installation\" } Initial Message The body of the email the item originated from. Properties Key Value type initial_message datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. to A list of names(s) and email(s) of people this message was sent to. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. subject The subject of the initial message. content The content of the message as an list of strings. Parsed Example { \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps to item . subject , \"content\" : [ \"I need some help with something.\\n\" ] } Edit Information added by someone at ECN, usually for internal use and/or communication. Properties Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings. Parsed Example { \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] } Status A short message about the progress of the item. Properties Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings. Parsed Example { \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] } Assignment Assigning the item to someone. Properties Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to. Parsed Example { \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply From User A message from the user and/or related parties. Properties Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] } Parse Error An error caused by a malformed delimiter or nested delimiters. Properties Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error. Parsed Example { 'type' : 'parse_error' , 'datetime' : '2020-10-16T10:44:45' , 'file_path' : '/home/pier/e/benne238/webqueue2/q-snapshot/aae/2' , 'expected' : 'Did not encounter a reply-from-user ending delimiter' , 'got' : 'Kris' , 'line_num' : 468 } Item.date_received \u2693\ufe0e Type Description String An ISO 8601 formatted time string showing the date this item was created. Example console . log ( Item . date_received ) // Expexted Output \"2021-04-03T00:48:38+00:00\" Item.department \u2693\ufe0e Type Description String The most recent department for this item. Example console . log ( Item . department ) // Expexted Output \"Bussiness Office\" Item.headers \u2693\ufe0e Type Description Array<Object> An array of objects containing parsed item headers in type / value pairs. Example console . log ( Item . headers [ 0 ]) // Expexted Output { type : \"From\" , content : \"\\\"Campbell, Justin Tyler\\\" <campb303@purdue.edu>\\n\" } Item.is_locked \u2693\ufe0e Type Description Boolean A boolean showing whether or not a lockfile for the item is present. Example console . log ( Item . is_locked ) // Expexted Output true Item.last_updated \u2693\ufe0e Type Description String An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem. Example console . log ( Item . last_updated ) // Expected Output \"2021-04-03T00:48:38+00:00\" Item.number \u2693\ufe0e Type Description Number The indentifying number of the queue item. Example console . log ( Item . number ) // Expected Output 4 Item.path \u2693\ufe0e Type Description String The absolute file path to the Item. Example console . log ( Item . path ) // Expected Output \"/home/pier/e/queue/Mail/ce/1\" Item.priority: \u2693\ufe0e Type Description String The most recent priority for this item. Example console . log ( Item . priority ) // Expexted Output \"COVID\" Item.queue: \u2693\ufe0e Type Description String The queue the Item is in. Example console . log ( Item . queue ) // Expexted Output \"ce\" Item.status \u2693\ufe0e Type Description String The most recent status update for the item. Example console . log ( Item . status ) // Expexted Output \"Waiting for Reply\" Item.subject: \u2693\ufe0e Type Description String The subject of the original message for this item. Example console . log ( Item . subject ) // Expexted Output \"Can't Access Outlook\" Item.user_alias : \u2693\ufe0e Type Description String The Purdue career account alias of the person this item is from. Example console . log ( Item . user_alias ) // Expexted Output \"campb303\" Item.user_email \u2693\ufe0e Type Description String The email address of the person who this item is from. Example console . log ( Item . user_email ) // Expexted Output \"campb303@purdue.edu\" Item.user_name \u2693\ufe0e Type Description String The real name of the person who this item is from. Example console . log ( Item . user_name ) // Expexted Output \"Justin Campbell\"","title":"Items"},{"location":"api/Items/#items","text":"An item is a chronological representation of an interaction with a user.","title":"Items"},{"location":"api/Items/#endpoint","text":"GET /api/data/{queue}/{number}","title":"Endpoint"},{"location":"api/Items/#parameters","text":"Name Value queue The queue of the item. number The number of the item.","title":"Parameters"},{"location":"api/Items/#query-string-options","text":"Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"False\" .) \"True\" | \"False\"","title":"Query String Options"},{"location":"api/Items/#return-codes","text":"Code Description 200 - Ok On success. 404 - Not Found When the Item does not exist. 500 - Internal Service Error On failure.","title":"Return Codes"},{"location":"api/Items/#properties","text":"","title":"Properties"},{"location":"api/Items/#itemassigned_to","text":"Type Description String The Purdue career account alias of the person this item is assigned to. Example console . log ( Item . assigned_to ) // Expexted Output \"sundeep\"","title":"Item.assigned_to:"},{"location":"api/Items/#itembuilding","text":"Type Description String The building a particular Item is related to. Example console . log ( Item . building ) // Expexted Output \"ME\"","title":"Item.building"},{"location":"api/Items/#itemcontent","text":"Type Description Array<Object> A chronological array of objects representing 1 of 9 possible actions taken on an item. Possible Actions Directory Information Information about the user info collected from ECNDB including but not limited to alias, phone number and office location. Properties Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue Parsed Example { \"type\" : \"directory_information\" , \"Name\" : \"Nestor Fabian Rodriguez Buitrago\" , \"Login\" : \"rodri563\" , \"Computer\" : \"ce-205-38 (128.46.205.67)\" , \"Location\" : \"HAMP G230\" , \"Email\" : \"rodri563@purdue.edu\" , \"Phone\" : \"7654766893\" , \"Office\" : \"HAMP G230\" , \"UNIX Dir\" : \"/home/bridge/b/rodri563\" , \"Zero Dir\" : \"U=\\\\\\\\bridge.ecn.purdue.edu\\\\rodri563\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/2e8399a\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2e83999\" , \"Subject\" : \"Autocad installation\" } Initial Message The body of the email the item originated from. Properties Key Value type initial_message datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. to A list of names(s) and email(s) of people this message was sent to. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. subject The subject of the initial message. content The content of the message as an list of strings. Parsed Example { \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps to item . subject , \"content\" : [ \"I need some help with something.\\n\" ] } Edit Information added by someone at ECN, usually for internal use and/or communication. Properties Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings. Parsed Example { \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] } Status A short message about the progress of the item. Properties Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings. Parsed Example { \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] } Assignment Assigning the item to someone. Properties Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to. Parsed Example { \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply To User A message from ECN to the user and/or related parties. Properties Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply From User A message from the user and/or related parties. Properties Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings Parsed Example { \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] } Parse Error An error caused by a malformed delimiter or nested delimiters. Properties Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error. Parsed Example { 'type' : 'parse_error' , 'datetime' : '2020-10-16T10:44:45' , 'file_path' : '/home/pier/e/benne238/webqueue2/q-snapshot/aae/2' , 'expected' : 'Did not encounter a reply-from-user ending delimiter' , 'got' : 'Kris' , 'line_num' : 468 }","title":"Item.content"},{"location":"api/Items/#itemdate_received","text":"Type Description String An ISO 8601 formatted time string showing the date this item was created. Example console . log ( Item . date_received ) // Expexted Output \"2021-04-03T00:48:38+00:00\"","title":"Item.date_received"},{"location":"api/Items/#itemdepartment","text":"Type Description String The most recent department for this item. Example console . log ( Item . department ) // Expexted Output \"Bussiness Office\"","title":"Item.department"},{"location":"api/Items/#itemheaders","text":"Type Description Array<Object> An array of objects containing parsed item headers in type / value pairs. Example console . log ( Item . headers [ 0 ]) // Expexted Output { type : \"From\" , content : \"\\\"Campbell, Justin Tyler\\\" <campb303@purdue.edu>\\n\" }","title":"Item.headers"},{"location":"api/Items/#itemis_locked","text":"Type Description Boolean A boolean showing whether or not a lockfile for the item is present. Example console . log ( Item . is_locked ) // Expexted Output true","title":"Item.is_locked"},{"location":"api/Items/#itemlast_updated","text":"Type Description String An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem. Example console . log ( Item . last_updated ) // Expected Output \"2021-04-03T00:48:38+00:00\"","title":"Item.last_updated"},{"location":"api/Items/#itemnumber","text":"Type Description Number The indentifying number of the queue item. Example console . log ( Item . number ) // Expected Output 4","title":"Item.number"},{"location":"api/Items/#itempath","text":"Type Description String The absolute file path to the Item. Example console . log ( Item . path ) // Expected Output \"/home/pier/e/queue/Mail/ce/1\"","title":"Item.path"},{"location":"api/Items/#itempriority","text":"Type Description String The most recent priority for this item. Example console . log ( Item . priority ) // Expexted Output \"COVID\"","title":"Item.priority:"},{"location":"api/Items/#itemqueue","text":"Type Description String The queue the Item is in. Example console . log ( Item . queue ) // Expexted Output \"ce\"","title":"Item.queue:"},{"location":"api/Items/#itemstatus","text":"Type Description String The most recent status update for the item. Example console . log ( Item . status ) // Expexted Output \"Waiting for Reply\"","title":"Item.status"},{"location":"api/Items/#itemsubject","text":"Type Description String The subject of the original message for this item. Example console . log ( Item . subject ) // Expexted Output \"Can't Access Outlook\"","title":"Item.subject:"},{"location":"api/Items/#itemuser_alias","text":"Type Description String The Purdue career account alias of the person this item is from. Example console . log ( Item . user_alias ) // Expexted Output \"campb303\"","title":"Item.user_alias:"},{"location":"api/Items/#itemuser_email","text":"Type Description String The email address of the person who this item is from. Example console . log ( Item . user_email ) // Expexted Output \"campb303@purdue.edu\"","title":"Item.user_email"},{"location":"api/Items/#itemuser_name","text":"Type Description String The real name of the person who this item is from. Example console . log ( Item . user_name ) // Expexted Output \"Justin Campbell\"","title":"Item.user_name"},{"location":"api/Queues/","text":"Queues \u2693\ufe0e A collection of Items . Endpoint \u2693\ufe0e GET /api/data/{queue} Parameters \u2693\ufe0e Name Value queue The name of the queue. Query String Options \u2693\ufe0e Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"True\" .) \"True\" | \"True\" Return Codes \u2693\ufe0e Code Description 200 - Ok On success. 404 - Not Found When the Queue does not exist. 500 - Internal Service Error On failure. Properties \u2693\ufe0e Queue.name \u2693\ufe0e Type Description String The name of the queue. Example console . log ( Queue . name ) // Expected Output \"ce\" Queue.path \u2693\ufe0e Type Description String The absolute file path to the Queue. Example console . log ( Queue . path ) // Expected Output \"/home/pier/e/queue/Mail/ce\" Queue.items \u2693\ufe0e Type Description Array<Object> The Items in the queue. Example console . log ( Queue . items ) // Expected Output [ { queue : \"ce\" , number : 01 , lastUpdated : \"2021-03-26T17:12:00-0400\" ... } { queue : \"ce\" , number : 02 , lastUpdated : \"2021-05-29T17:12:00-0400\" ... } { queue : \"ce\" , number : 03 , lastUpdated : \"2020-12-29T17:12:00-0400\" ... } ]","title":"Queues"},{"location":"api/Queues/#queues","text":"A collection of Items .","title":"Queues"},{"location":"api/Queues/#endpoint","text":"GET /api/data/{queue}","title":"Endpoint"},{"location":"api/Queues/#parameters","text":"Name Value queue The name of the queue.","title":"Parameters"},{"location":"api/Queues/#query-string-options","text":"Name Description Possible Values headers_only When \"True\" , only meta data will be loaded. When \"False\" content will be parsed. (Defaults to \"True\" .) \"True\" | \"True\"","title":"Query String Options"},{"location":"api/Queues/#return-codes","text":"Code Description 200 - Ok On success. 404 - Not Found When the Queue does not exist. 500 - Internal Service Error On failure.","title":"Return Codes"},{"location":"api/Queues/#properties","text":"","title":"Properties"},{"location":"api/Queues/#queuename","text":"Type Description String The name of the queue. Example console . log ( Queue . name ) // Expected Output \"ce\"","title":"Queue.name"},{"location":"api/Queues/#queuepath","text":"Type Description String The absolute file path to the Queue. Example console . log ( Queue . path ) // Expected Output \"/home/pier/e/queue/Mail/ce\"","title":"Queue.path"},{"location":"api/Queues/#queueitems","text":"Type Description Array<Object> The Items in the queue. Example console . log ( Queue . items ) // Expected Output [ { queue : \"ce\" , number : 01 , lastUpdated : \"2021-03-26T17:12:00-0400\" ... } { queue : \"ce\" , number : 02 , lastUpdated : \"2021-05-29T17:12:00-0400\" ... } { queue : \"ce\" , number : 03 , lastUpdated : \"2020-12-29T17:12:00-0400\" ... } ]","title":"Queue.items"},{"location":"api/Simulating%20Responses/","text":"Returns the requested HTTP response with a JSON payload containing the response phrase. Valid response codes and phrases are pulled from the Python http library index . Endpoint \u2693\ufe0e GET /api/error/{response_code} Parameters \u2693\ufe0e Name Value response_code The HTTP response code to be returned. Example \u2693\ufe0e curl https://engineering.purdue.edu/webqueue/webqueue2/build/api/error/301 // Expected Output {\"message\": \"Moved Permanently\"}","title":"Simulating Responses"},{"location":"api/Simulating%20Responses/#endpoint","text":"GET /api/error/{response_code}","title":"Endpoint"},{"location":"api/Simulating%20Responses/#parameters","text":"Name Value response_code The HTTP response code to be returned.","title":"Parameters"},{"location":"api/Simulating%20Responses/#example","text":"curl https://engineering.purdue.edu/webqueue/webqueue2/build/api/error/301 // Expected Output {\"message\": \"Moved Permanently\"}","title":"Example"},{"location":"webqueue2api%20Package/Configuration/","text":"The configuration of webqueue2api can be managed in two different ways: At launch with a configuration file in the same directory as the virtual environment At runtime by modifying the webqueue2api.config symbol directly Configuration File \u2693\ufe0e On import, a ConfigParser INI formatted file is read for configuartion options. This file must be located in the same directory as the virtual environment folder and must be named webqueue2api_config.ini . A Full Config File [parser] # Absolute path to directory containing queue data. # Default: /home/pier/e/queue/Mail queue_directory = /etc/queue-cli/queues # List of queues to ignore. (Comma and space \", \" delimited.) # Default: archives, drafts, inbox, coral queues_to_ignore = dogs, cats, particularly_pugs [api] # Runtime configuration for secure production or convenient development settings. # Valid options are: prod | dev # Default: prod environment = dev # Token used to encrypt JWT payloads. # Default: webqueue2api.api.config.generate_random_string jwt_secret_key = uV0liG9$YgcGE7J! Changing Settings at Runtime \u2693\ufe0e Each package contains package level configuration objects (see: dataclasses on PyPI ) in config.py files. All of the configurations are combined into the top level webqueue2api.config symbol. These configuration objects store default values for each package. Default values can be changed by editing these objects directly or by editing the object values before their use. Changing the parser's queue directory by editing object values. import webqueue2api # Load Queue from default directory ce_queue = Queue ( \"ce\" ) # load Queue from modified directory webqueue2api . config . parser . queue_directory = \"/absolute/path\" other_queue = Queue ( \"other\" )","title":"Configuration"},{"location":"webqueue2api%20Package/Configuration/#configuration-file","text":"On import, a ConfigParser INI formatted file is read for configuartion options. This file must be located in the same directory as the virtual environment folder and must be named webqueue2api_config.ini . A Full Config File [parser] # Absolute path to directory containing queue data. # Default: /home/pier/e/queue/Mail queue_directory = /etc/queue-cli/queues # List of queues to ignore. (Comma and space \", \" delimited.) # Default: archives, drafts, inbox, coral queues_to_ignore = dogs, cats, particularly_pugs [api] # Runtime configuration for secure production or convenient development settings. # Valid options are: prod | dev # Default: prod environment = dev # Token used to encrypt JWT payloads. # Default: webqueue2api.api.config.generate_random_string jwt_secret_key = uV0liG9$YgcGE7J!","title":"Configuration File"},{"location":"webqueue2api%20Package/Configuration/#changing-settings-at-runtime","text":"Each package contains package level configuration objects (see: dataclasses on PyPI ) in config.py files. All of the configurations are combined into the top level webqueue2api.config symbol. These configuration objects store default values for each package. Default values can be changed by editing these objects directly or by editing the object values before their use. Changing the parser's queue directory by editing object values. import webqueue2api # Load Queue from default directory ce_queue = Queue ( \"ce\" ) # load Queue from modified directory webqueue2api . config . parser . queue_directory = \"/absolute/path\" other_queue = Queue ( \"other\" )","title":"Changing Settings at Runtime"},{"location":"webqueue2api%20Package/Deployment/","text":"For convenience, as WSGI compliant symbole is available at webqueu2api.api:app . This can be used with any WSGI server. This project was developed against gunicorn so that is what we recommend. Development Example Start a server on localhost:5000 in debug mode. gunicorn --log-level debug webqueue2.api:app Production Example Start a public server on port 5000 in the background with access and error logs written to files. gunicorn --daemon \\ --access-logfile /var/log/webqueue2api/access.log \\ --error-logfile /var/log/webqueue2api/error.log \\ webqueue2.api:app See gunicorn's Docs for more details about configuring gunicorn.","title":"Deployment"},{"location":"webqueue2api%20Package/Getting%20Started/","text":"Getting Started \u2693\ufe0e The webqueue2api Package provides both a parser to read data from ECN's queue and allow for programatic data access as well as an WSGI application to serve the webqueue2 API. The webqueue2api Package has the following structure: webqueue2api : Contains global configuration and exports utilities/data classes. parser : Contains classes for reading data from queue text files and making it available via objects. api : Contains a WSGI application to host a RESTful API that relies on parser . Basic Usage \u2693\ufe0e Load all queues. import webqueue2api all_queues = webqueue2api . load_queues () for queue in all_queues : print ( f \" { queue . name } has { len ( queue . items ) } items.\" # Expected Output \"tech has 72 items\" \"ce has 38 items\" ... Load some queues. import webqueue2api all_queues = webqueue2api . load_queues ( \"che\" , \"tech\" , \"ce\" ) print ( len ( all_queues ) ) # Expected Output 3 Load a queue and get the number of items in it. import webqueue2api ce_queue = webqueue2api . Queue ( \"ce\" ) print ( len ( ce_queue . items ) ) # Expected Output 29 Load an item and get its subject. import webqueue2api ce_1 = webqueue2api . Item ( \"ce\" , 1 ) print ( len ( ce_1 . subject ) ) # Expected Output \"Re: Battery Replacement\"","title":"Getting Started"},{"location":"webqueue2api%20Package/Getting%20Started/#getting-started","text":"The webqueue2api Package provides both a parser to read data from ECN's queue and allow for programatic data access as well as an WSGI application to serve the webqueue2 API. The webqueue2api Package has the following structure: webqueue2api : Contains global configuration and exports utilities/data classes. parser : Contains classes for reading data from queue text files and making it available via objects. api : Contains a WSGI application to host a RESTful API that relies on parser .","title":"Getting Started"},{"location":"webqueue2api%20Package/Getting%20Started/#basic-usage","text":"Load all queues. import webqueue2api all_queues = webqueue2api . load_queues () for queue in all_queues : print ( f \" { queue . name } has { len ( queue . items ) } items.\" # Expected Output \"tech has 72 items\" \"ce has 38 items\" ... Load some queues. import webqueue2api all_queues = webqueue2api . load_queues ( \"che\" , \"tech\" , \"ce\" ) print ( len ( all_queues ) ) # Expected Output 3 Load a queue and get the number of items in it. import webqueue2api ce_queue = webqueue2api . Queue ( \"ce\" ) print ( len ( ce_queue . items ) ) # Expected Output 29 Load an item and get its subject. import webqueue2api ce_1 = webqueue2api . Item ( \"ce\" , 1 ) print ( len ( ce_1 . subject ) ) # Expected Output \"Re: Battery Replacement\"","title":"Basic Usage"},{"location":"webqueue2api%20Package/Package%20Structure/","text":"Hierarchy \u2693\ufe0e The webqueue2api Package consists of four packages in total: webqueue2api : The root packages. This contains both the api and the parser packages as well as global configuration. api : Contains a Flask app that can be used with any WSGI server to host the webqueue2 API and utilities such as authentication code. resources : Contains Flask-RESTful resources for the webqueue2 API. parser : Contains parers for a Queue and an Item as well as utilities and custom errors.","title":"Package Structure"},{"location":"webqueue2api%20Package/Package%20Structure/#hierarchy","text":"The webqueue2api Package consists of four packages in total: webqueue2api : The root packages. This contains both the api and the parser packages as well as global configuration. api : Contains a Flask app that can be used with any WSGI server to host the webqueue2 API and utilities such as authentication code. resources : Contains Flask-RESTful resources for the webqueue2 API. parser : Contains parers for a Queue and an Item as well as utilities and custom errors.","title":"Hierarchy"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/","text":"Below are the derived definitions for each section of an item as it appears in the item's plaintext file and as it is output from the parser. Directory Information \u2693\ufe0e Information about the user such as alias, phone number and office location. This only appears once right after the headers and right before the initial message. This only occurs if the item is submitted through the Trouble Reporting page. Fields \u2693\ufe0e Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue Delimiters \u2693\ufe0e Start : The second line after the first newline followed by a tab \\n\\t . End : The first non-empty line after the start that begins with whitespace then \"Subject:\" Plain Text Example \u2693\ufe0e \\tName: Jerry L Guerrero\\n Login: jerry\\n\" Computer: x-ee27\u00e50bpc1 (128.46.164.29)\\n Location: EE 270B\\n Email: jerry@purdue.edu\\n Phone: \\n Office: \\n UNIX Dir: /home/pier/c/jerry\\n Zero Dir: U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\\n User ECNDB: http://eng.purdue.edu/jump/bcafa8\\n Host ECNDB: http://eng.purdue.edu/jump/2dbd461 \\n Subject: Win7 to Win10 Migration List - kevin\\n Parsed Example \u2693\ufe0e { \"type\" : \"directory_information\" , \"Name\" : \"Jerry L Guerrero\" , \"Login\" : \"jerry\" , \"Computer\" : \"x-ee27\u00e50bpc1 (128.46.164.29)\" , \"Location\" : \"EE 270B\" , \"Email\" : \"jerry@purdue.edu\" , \"Phone\" : \"\" , \"Office\" : \"\" , \"UNIX Dir\" : \"/home/pier/c/jerry\" , \"Zero Dir\" : \"U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/bcafa8\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2dbd461\" , \"Subject\" : \"Win7 to Win10 Migration List - kevin\" } Initial Message \u2693\ufe0e The body of the email the item originated from. This usually appears directly after the headers unless directory information is present. Fields \u2693\ufe0e Key Value type initial_message datetime RFC 8061 formatted datetime string. Pulled from the Date header of the item. from_name The sender's real name. Formatting may vary. Pulled from the From header of the item. This can be empty. from_email The sender's email address. Pulled from the From header of the item. to A list of names(s) and email(s) of people this message was sent to. Pulled from the To header of the item. cc A list of name(s) and email(s) of people who were CC'd. Pulled from the Cc header of the item. This can be empty. subject The subject of the initial message. Pulled from the Subject header of the item. content The content of the message as an list of strings. Delimiters \u2693\ufe0e Start : First newline after directory information if present, otherwise first newline. End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e I need some help with something.\\n My printer stopped working.\\n Parsed Example \u2693\ufe0e { \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps t o i te m.subjec t , \"content\" : [ \"I need some help with something.\\n\" , \"My printer stopped working.\\n\" ] } Edit \u2693\ufe0e Information added by someone at ECN, usually for internal use and/or communication. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings. Delimiters \u2693\ufe0e Start : Line starting with *** Edited End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e *** Edited by: knewell at: 04/22/20 16:39:51 *** This is related to another item. I need to do X next. Parsed Example \u2693\ufe0e { \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] } Status \u2693\ufe0e A short message about the progress of the item. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings. Delimiters \u2693\ufe0e Start : Line starting with *** Status End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e *** Status updated by: knewell at: 4/23/2020 10:35:47 *** Doing X thing. Parsed Example \u2693\ufe0e { \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] } Assignment \u2693\ufe0e Assigning the item to someone. This does not occur in the body of the item. It it tracked in the headers using three different entries: Assigned-To-Updated-By : the career account alias of the person who updated the assignment Assigned-To-Updated-Time : the time the assignment was updated Assigned-To : the career account alias of the person the item was assigned to Fields \u2693\ufe0e Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to. Delimiters \u2693\ufe0e N/A Plain Text Example \u2693\ufe0e Assigned-To: campb303 Assigned-To-Updated-Time: Tue, 23 Jun 2020 13:27:00 EDT Assigned-To-Updated-By: harley Parsed Example \u2693\ufe0e { \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , } Reply To User \u2693\ufe0e A message from ECN to the user and/or related parties. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings Delimiters \u2693\ufe0e Start : Line starting with *** Replied End : Beginning of another delimiter if present, otherwise end of file. Plain Text Example \u2693\ufe0e *** Replied by: ewhile at: 05/08/20 09:21:43 *** Sascha, Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin. Ethan White ECN Parsed Example \u2693\ufe0e { \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] } Reply from User \u2693\ufe0e A message from the user and/or related parties. This is only found after two or more items have been merged together. This can occur anywhere in the item after the initial message. Fields \u2693\ufe0e Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings Delimiters: \u2693\ufe0e Start : Line starting with === End : Line starting with ==== Plain Text Example \u2693\ufe0e === Additional information supplied by user === Subject: RE: New Computer Deploy From: \"Reckowsky, Michael J.\" <mreckowsky@purdue.edu> Date: Fri, 8 May 2020 13:57:17 +0000 Ethan, Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork. Mike =============================================== Parsed Example \u2693\ufe0e { \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] } Parse Error \u2693\ufe0e Note This is not found in the item but generated when the item is parsed. An error caused by unexpected formatting. Fields \u2693\ufe0e Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error. Plain Text Example \u2693\ufe0e (item aae2 in qsnapshot) === Additional information supplied by user === Subject: RE: Help with hardware upgrades From: \"Ezra, Kristopher L\" <kris@purdue.edu> Date: Wed, 5 Feb 2020 18:11:58 +0000 If it makes no difference between windows and linux for the fileserver I'd rather service a linux machine. Considering the switches, i could do 2 8s and 2 16s. Two of the switches I'm replacing already service 9 connections and I'd rather not daisy chain. Is there something driving the price here? I see gigabit switches from tplink on amazon right now for $50. I dont need managed switches or anything fancy. Kris *** Replied by: emuffley at: 02/05/20 13:22:02 *** Kris, Thank you on the server operating question. We will kick that off to our linux folks for discussion. No daisy chain, agreed. These switches are unmanaged. For the workstations, are you wanting Windows, Linux or a mix? Eric Muffley Systems Engineer, Engineering Computer Network =============================================== Parsed Example \u2693\ufe0e { \"type\" : \"parse_error\" , \"datetime\" : \"2020-10-16T10:44:45\" , \"file_path\" : \"/home/pier/e/benne238/webqueue2/q-snapshot/aae/2\" , \"expected\" : \"Did not encounter a reply_from_user ending delimiter\" , \"got\" : \"Kris\" , \"line_num\" : 468 }","title":"Section Parsing Definitions"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#directory-information","text":"Information about the user such as alias, phone number and office location. This only appears once right after the headers and right before the initial message. This only occurs if the item is submitted through the Trouble Reporting page.","title":"Directory Information"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields","text":"Key Value type directory_information Name The real name of the sender. Login The career account alias of the sender. Computer The computer the item is related to. Formatting may vary. Location Where the computer is located. Email The email address of the sender. Phone The phone number of the sender. Office The office location of the sender. UNIX Dir The home directory for the user on non-Windows systems Zero Dir The home directory for the user via Active Directory User ECNDB Link to the sender's username report in ECNDB Host ECNDB Link to the computer report in ECNDB Subject The subject of the email sent to the queue","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters","text":"Start : The second line after the first newline followed by a tab \\n\\t . End : The first non-empty line after the start that begins with whitespace then \"Subject:\"","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example","text":"\\tName: Jerry L Guerrero\\n Login: jerry\\n\" Computer: x-ee27\u00e50bpc1 (128.46.164.29)\\n Location: EE 270B\\n Email: jerry@purdue.edu\\n Phone: \\n Office: \\n UNIX Dir: /home/pier/c/jerry\\n Zero Dir: U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\\n User ECNDB: http://eng.purdue.edu/jump/bcafa8\\n Host ECNDB: http://eng.purdue.edu/jump/2dbd461 \\n Subject: Win7 to Win10 Migration List - kevin\\n","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example","text":"{ \"type\" : \"directory_information\" , \"Name\" : \"Jerry L Guerrero\" , \"Login\" : \"jerry\" , \"Computer\" : \"x-ee27\u00e50bpc1 (128.46.164.29)\" , \"Location\" : \"EE 270B\" , \"Email\" : \"jerry@purdue.edu\" , \"Phone\" : \"\" , \"Office\" : \"\" , \"UNIX Dir\" : \"/home/pier/c/jerry\" , \"Zero Dir\" : \"U=\\\\\\\\pier.ecn.purdue.edu\\\\jerry\" , \"User ECNDB\" : \"http://eng.purdue.edu/jump/bcafa8\" , \"Host ECNDB\" : \"http://eng.purdue.edu/jump/2dbd461\" , \"Subject\" : \"Win7 to Win10 Migration List - kevin\" }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#initial-message","text":"The body of the email the item originated from. This usually appears directly after the headers unless directory information is present.","title":"Initial Message"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_1","text":"Key Value type initial_message datetime RFC 8061 formatted datetime string. Pulled from the Date header of the item. from_name The sender's real name. Formatting may vary. Pulled from the From header of the item. This can be empty. from_email The sender's email address. Pulled from the From header of the item. to A list of names(s) and email(s) of people this message was sent to. Pulled from the To header of the item. cc A list of name(s) and email(s) of people who were CC'd. Pulled from the Cc header of the item. This can be empty. subject The subject of the initial message. Pulled from the Subject header of the item. content The content of the message as an list of strings.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_1","text":"Start : First newline after directory information if present, otherwise first newline. End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_1","text":"I need some help with something.\\n My printer stopped working.\\n","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_1","text":"{ \"type\" : \"initial_message\" , \"datetime\" : \"2020-09-11T01:26:45+00:00\" , \"from_name\" : \"Justin Campbell\" , \"from_email\" : \"campb303@purdue.edu\" , \"to\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, ], \"cc\" : [ { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"subject\" : Maps t o i te m.subjec t , \"content\" : [ \"I need some help with something.\\n\" , \"My printer stopped working.\\n\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#edit","text":"Information added by someone at ECN, usually for internal use and/or communication. This can occur anywhere in the item after the initial message.","title":"Edit"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_2","text":"Key Value type edit datetime RFC 8061 formatted datetime string. by The career account alias of the person who added the edit. content The content of the edit as a list of strings.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_2","text":"Start : Line starting with *** Edited End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_2","text":"*** Edited by: knewell at: 04/22/20 16:39:51 *** This is related to another item. I need to do X next.","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_2","text":"{ \"type\" : \"edit\" , \"datetime\" : \"2020-04-22T16:39:51\" , \"by\" : \"knewell\" , \"content\" : [ \"This is related to another item. I need to do X next.\\n\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#status","text":"A short message about the progress of the item. This can occur anywhere in the item after the initial message.","title":"Status"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_3","text":"Key Value type status datetime RFC 8061 formatted datetime string. by The career account alias of the person who updated the status. content The content of the status as a list of strings.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_3","text":"Start : Line starting with *** Status End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_3","text":"*** Status updated by: knewell at: 4/23/2020 10:35:47 *** Doing X thing.","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_3","text":"{ \"type\" : \"status\" , \"datetime\" : \"2020-04-23T10:35:47\" , \"by\" : \"knewell\" , \"content\" : [ \"Doing X thing.\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#assignment","text":"Assigning the item to someone. This does not occur in the body of the item. It it tracked in the headers using three different entries: Assigned-To-Updated-By : the career account alias of the person who updated the assignment Assigned-To-Updated-Time : the time the assignment was updated Assigned-To : the career account alias of the person the item was assigned to","title":"Assignment"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_4","text":"Key Value type assignment datetime RFC 8061 formatted datetime string. by The career account alias of the person who changed the to The career account alias of the person who the item was assigned to.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_4","text":"N/A","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_4","text":"Assigned-To: campb303 Assigned-To-Updated-Time: Tue, 23 Jun 2020 13:27:00 EDT Assigned-To-Updated-By: harley","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_4","text":"{ \"type\" : \"assignment\" , \"datetime\" : \"2020-06-23T13:27:00\" , \"by\" : \"harley\" , \"to\" : \"campb303\" , }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#reply-to-user","text":"A message from ECN to the user and/or related parties. This can occur anywhere in the item after the initial message.","title":"Reply To User"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_5","text":"Key Value type reply_to_user datetime RFC 8061 formatted datetime string. by The sender's real name. Formatting may vary. This can be empty. content The content of the message as an list of strings","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_5","text":"Start : Line starting with *** Replied End : Beginning of another delimiter if present, otherwise end of file.","title":"Delimiters"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_5","text":"*** Replied by: ewhile at: 05/08/20 09:21:43 *** Sascha, Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin. Ethan White ECN","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_5","text":"{ \"type\" : \"reply_to_user\" , \"datetime\" : \"2020-05-08T09:21:43\" , \"by\" : \"ewhile\" , \"content\" : [ \"Sascha,\\n\" , \"\\n\" , \"Chicken kevin biltong, flank jowl prosciutto shoulder meatball meatloaf sirloin.\\n\" , \"\\n\" , \"Ethan White\\n\" , \"ECN\" ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#reply-from-user","text":"A message from the user and/or related parties. This is only found after two or more items have been merged together. This can occur anywhere in the item after the initial message.","title":"Reply from User"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_6","text":"Key Value type reply_from_user datetime RFC 8061 formatted datetime string. from_name The sender's real name. Formatting may vary. This can be empty. from_email The sender's email address. cc A list of name(s) and email(s) of people who were CC'd. This can be empty. headers A dictionary of headers from the reply. subject The subject of the reply. content The content of the message as an list of strings","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#delimiters_6","text":"Start : Line starting with === End : Line starting with ====","title":"Delimiters:"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_6","text":"=== Additional information supplied by user === Subject: RE: New Computer Deploy From: \"Reckowsky, Michael J.\" <mreckowsky@purdue.edu> Date: Fri, 8 May 2020 13:57:17 +0000 Ethan, Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork. Mike ===============================================","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_6","text":"{ \"type\" : \"reply_from_user\" , \"datetime\" : \"2020-05-08T13:57:18+00:00\" , \"from_name\" : \"Reckowsky, Michael J.\" , \"from_email\" : \"mreckowsky@purdue.edu\" , \"cc\" : [ { \"name\" : \"John Doe\" , \"email\" : \"johndoe@example.com\" }, { \"name\" : \"\" , \"email\" : \"janesmith@example.com\" } ], \"headers\" : [ { \"type\" : \"Subject\" , \"content\" : \"RE: New Computer Deploy\" }, { \"type\" : \"From\" , \"content\" : \"\\\"Reckowsky, Michael J.\\\" <mreckowsky@purdue.edu>\" }, { \"type\" : \"Date\" , \"content\" : \"Fri, 8 May 2020 13:57:17 +0000\" }, ], \"subject\" : \"RE: New Computer Deploy\" , \"content\" : [ \"Ethan,\\n\" , \"\\n\" , \"Biltong beef ribs doner chuck, pork chop jowl salami cow filet mignon pork.\\n\" , \"\\n\" , \"Mike\\n\" , ] }","title":"Parsed Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parse-error","text":"Note This is not found in the item but generated when the item is parsed. An error caused by unexpected formatting.","title":"Parse Error"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#fields_7","text":"Key Value type parse_error datetime RFC 8061 formatted datetime string. file_path Full path of the item with the error. expected Description of what the parser was expecting. got Line that cause the parse error. line_num The line number in the item that caused the parse error.","title":"Fields"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#plain-text-example_7","text":"(item aae2 in qsnapshot) === Additional information supplied by user === Subject: RE: Help with hardware upgrades From: \"Ezra, Kristopher L\" <kris@purdue.edu> Date: Wed, 5 Feb 2020 18:11:58 +0000 If it makes no difference between windows and linux for the fileserver I'd rather service a linux machine. Considering the switches, i could do 2 8s and 2 16s. Two of the switches I'm replacing already service 9 connections and I'd rather not daisy chain. Is there something driving the price here? I see gigabit switches from tplink on amazon right now for $50. I dont need managed switches or anything fancy. Kris *** Replied by: emuffley at: 02/05/20 13:22:02 *** Kris, Thank you on the server operating question. We will kick that off to our linux folks for discussion. No daisy chain, agreed. These switches are unmanaged. For the workstations, are you wanting Windows, Linux or a mix? Eric Muffley Systems Engineer, Engineering Computer Network ===============================================","title":"Plain Text Example"},{"location":"webqueue2api%20Package/Parser/Section%20Parsing%20Definitions/#parsed-example_7","text":"{ \"type\" : \"parse_error\" , \"datetime\" : \"2020-10-16T10:44:45\" , \"file_path\" : \"/home/pier/e/benne238/webqueue2/q-snapshot/aae/2\" , \"expected\" : \"Did not encounter a reply_from_user ending delimiter\" , \"got\" : \"Kris\" , \"line_num\" : 468 }","title":"Parsed Example"}]}
\ No newline at end of file
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
index 5b0aa99..00a5fea 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -50,6 +50,11 @@
          <lastmod>2021-08-03</lastmod>
          <changefreq>daily</changefreq>
     </url>
+    <url>
+         <loc>https://pages.github.itap.purdue.edu/ECN/webqueue2-api/webqueue2api%20Package/Deployment/</loc>
+         <lastmod>2021-08-03</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
     <url>
          <loc>https://pages.github.itap.purdue.edu/ECN/webqueue2-api/webqueue2api%20Package/Getting%20Started/</loc>
          <lastmod>2021-08-03</lastmod>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
index 44b005cfbf68085a54a6d1540590c4ccf0220680..9144e02bc5dacb29ebde0f522ddbf6988e95ace0 100644
GIT binary patch
literal 425
zcmV;a0apGWiwFo$!U$mk|8r?{Wo=<_E_iKh0Nqy2Zo)7OzV9her5$MsyKGY_n)nlk
zP21QWAf%>^Xp@jQu)Y194k0ewrb!`E>ezLy?@Meq`S`1CdV8==YBfp*X_oXr30+E6
zjgrrgdH+5c7dN@LjRWkFvvQ-PMl_F%9S(=oNraXgmug!vCu&k0I~rM*J|x9Wk46aa
zyXr>XXi<bHj=~sTflDiiwO^+axk-(;rH2$s&t{Vsc7XNHgNI?C8_9AOK0c4d9k#kG
zhS_k?&+hx#9l0EBXKteAs)CJ$T~Tt`eCO=U@(YrkQ2rs_DeP~D*-Y)F)v5)Bq^$tG
zA-V9fgy<M8l|$Y%94Tj_1OLnstmF;t{zhARw%bw*M~k_(Ek~rxkB(HBPabQ^E-B(X
zmoOL5ZGR{b<QAcflEspmpNkUtTTtVKzLKpE9jVKncW_247a^6CMhX#m<zh<#*hH(1
zth|l0v@ejFf@$=3_#<8mqxk#R1!70p5wl*Pw{ShwtOLtdAVO_*FX%Gd9pV%=QpsTc
Thepx~x?>kV=uwf%lM4U<Ejh|o

literal 415
zcmV;Q0bu?giwFoQtq5TP|8r?{Wo=<_E_iKh0Nqy2Zo?o9zV|7rNIN#9-KCq-R8#-d
z!=`QB9)J=jK}{e9({67+lU7wPy-kxC5*Qm}eIM9}bo$lQ{R0>)wVFi3IEnh8gwCZZ
zC(-A}axjjjSub^_wt#(dR(29qi0va|$Kx@!5~1O(jkPJ66%{F#osBGsAEK<+r{)8k
zW?f5bEixa)Qka&PVB=C^<+iaz-o~vnxq}#T#}=~}c7*NTfrHV2x00pIZ@!MjEjBvO
zM#*S6NXCQYo?OnhD>qSbRYGB4pXFTE-zmGYoItV*%3s7ghr`_{S*U|FS~Z}Mv<;wZ
zNv@pCAvi{BWs%o4N6MMtz&~>YBY91yUuZ*Pv&*%xG+AoXa74=d;7IxY<glXbk|NA|
z@qGo|@%sWnZV>VyS*+>tvq2(%^J<vTH?nd5Me4HW9c-(W4Uo!3BZY{(a<QWTY^GHq
zOJ~9??Hi=Rul5_n&axwBoIq#b|4=g)4BLS4nb<AR*Ri|AITTV!Z~lX_>jeEsvmesx
JI0eB9000rL&9wjk

diff --git a/docs/webqueue2api Package/Configuration/index.html b/docs/webqueue2api Package/Configuration/index.html
index e7872cb..30299ec 100644
--- a/docs/webqueue2api Package/Configuration/index.html	
+++ b/docs/webqueue2api Package/Configuration/index.html	
@@ -437,6 +437,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -453,14 +465,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
@@ -621,13 +633,13 @@ <h2 id="changing-settings-at-runtime">Changing Settings at Runtime<a class="head
       
       
         
-        <a href="../Package%20Structure/" class="md-footer__link md-footer__link--next" aria-label="Next: Package Structure" rel="next">
+        <a href="../Deployment/" class="md-footer__link md-footer__link--next" aria-label="Next: Deployment" rel="next">
           <div class="md-footer__title">
             <div class="md-ellipsis">
               <span class="md-footer__direction">
                 Next
               </span>
-              Package Structure
+              Deployment
             </div>
           </div>
           <div class="md-footer__button md-icon">
diff --git a/docs/webqueue2api Package/Deployment/index.html b/docs/webqueue2api Package/Deployment/index.html
new file mode 100644
index 0000000..761f7f1
--- /dev/null
+++ b/docs/webqueue2api Package/Deployment/index.html	
@@ -0,0 +1,594 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+    
+      <meta charset="utf-8">
+      <meta name="viewport" content="width=device-width,initial-scale=1">
+      
+      
+      
+      
+        <link rel="canonical" href="https://pages.github.itap.purdue.edu/ECN/webqueue2-api/webqueue2api%20Package/Deployment/">
+      
+      <link rel="icon" href="../../images/favicon.ico">
+      <meta name="generator" content="mkdocs-1.2.2, mkdocs-material-7.2.2">
+    
+    
+      
+        <title>Deployment - webqueue2 API</title>
+      
+    
+    
+      <link rel="stylesheet" href="../../assets/stylesheets/main.1118c9be.min.css">
+      
+        
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.ba0d045b.min.css">
+        
+          
+          
+          <meta name="theme-color" content="#7e56c2">
+        
+      
+    
+    
+    
+      
+        
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
+        <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
+      
+    
+    
+    
+      <link rel="stylesheet" href="../../css/custom_css.css">
+    
+    
+      
+
+
+    
+    
+  </head>
+  
+  
+    
+    
+    
+    
+    
+    <body dir="ltr" data-md-color-scheme="" data-md-color-primary="deep-purple" data-md-color-accent="teal">
+  
+    
+    <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
+    
+    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+    <label class="md-overlay" for="__drawer"></label>
+    <div data-md-component="skip">
+      
+    </div>
+    <div data-md-component="announce">
+      
+    </div>
+    
+      <header class="md-header" data-md-component="header">
+  <nav class="md-header__inner md-grid" aria-label="Header">
+    <a href="../.." title="webqueue2 API" class="md-header__button md-logo" aria-label="webqueue2 API" data-md-component="logo">
+      
+  
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 12h7v1.5h-7m0-4h7V11h-7m0 3.5h7V16h-7m8-12H3a2 2 0 0 0-2 2v13a2 2 0 0 0 2 2h18a2 2 0 0 0 2-2V6a2 2 0 0 0-2-2m0 15h-9V6h9"/></svg>
+
+    </a>
+    <label class="md-header__button md-icon" for="__drawer">
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
+    </label>
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+            webqueue2 API
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+            
+              Deployment
+            
+          </span>
+        </div>
+      </div>
+    </div>
+    
+    
+    
+      <label class="md-header__button md-icon" for="__search">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
+      </label>
+      
+<div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="__search"></label>
+  <div class="md-search__inner" role="search">
+    <form class="md-search__form" name="search">
+      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+      <label class="md-search__icon md-icon" for="__search">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
+      </label>
+      <nav class="md-search__options" aria-label="Search">
+        
+        <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
+        </button>
+      </nav>
+      
+    </form>
+    <div class="md-search__output">
+      <div class="md-search__scrollwrap" data-md-scrollfix>
+        <div class="md-search-result" data-md-component="search-result">
+          <div class="md-search-result__meta">
+            Initializing search
+          </div>
+          <ol class="md-search-result__list"></ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+    
+    
+      <div class="md-header__source">
+        
+<a href="https://github.itap.purdue.edu/ECN/webqueue2-api" title="Go to repository" class="md-source" data-md-component="source">
+  <div class="md-source__icon md-icon">
+    
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+  </div>
+  <div class="md-source__repository">
+    Github
+  </div>
+</a>
+      </div>
+    
+  </nav>
+</header>
+    
+    <div class="md-container" data-md-component="container">
+      
+      
+        
+      
+      <main class="md-main" data-md-component="main">
+        <div class="md-main__inner md-grid">
+          
+            
+              
+              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    
+
+
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+  <label class="md-nav__title" for="__drawer">
+    <a href="../.." title="webqueue2 API" class="md-nav__button md-logo" aria-label="webqueue2 API" data-md-component="logo">
+      
+  
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 12h7v1.5h-7m0-4h7V11h-7m0 3.5h7V16h-7m8-12H3a2 2 0 0 0-2 2v13a2 2 0 0 0 2 2h18a2 2 0 0 0 2-2V6a2 2 0 0 0-2-2m0 15h-9V6h9"/></svg>
+
+    </a>
+    webqueue2 API
+  </label>
+  
+    <div class="md-nav__source">
+      
+<a href="https://github.itap.purdue.edu/ECN/webqueue2-api" title="Go to repository" class="md-source" data-md-component="source">
+  <div class="md-source__icon md-icon">
+    
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+  </div>
+  <div class="md-source__repository">
+    Github
+  </div>
+</a>
+    </div>
+  
+  <ul class="md-nav__list" data-md-scrollfix>
+    
+      
+      
+      
+
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../.." class="md-nav__link">
+        Home
+      </a>
+    </li>
+  
+
+    
+      
+      
+      
+
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../Installation/" class="md-nav__link">
+        Installation
+      </a>
+    </li>
+  
+
+    
+      
+      
+      
+
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../Dev%20Environment%20Setup%20Guide/" class="md-nav__link">
+        Dev Environment Setup Guide
+      </a>
+    </li>
+  
+
+    
+      
+      
+      
+
+  
+  
+  
+    
+      
+    
+    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+      
+      
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
+      
+      <label class="md-nav__link" for="__nav_4">
+        API
+        <span class="md-nav__icon md-icon"></span>
+      </label>
+      <nav class="md-nav" aria-label="API" data-md-level="1">
+        <label class="md-nav__title" for="__nav_4">
+          <span class="md-nav__icon md-icon"></span>
+          API
+        </label>
+        <ul class="md-nav__list" data-md-scrollfix>
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../api/Getting%20Started/" class="md-nav__link">
+        Getting Started
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../api/Authentication/" class="md-nav__link">
+        Authentication
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../api/Items/" class="md-nav__link">
+        Items
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../api/Queues/" class="md-nav__link">
+        Queues
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../api/Simulating%20Responses/" class="md-nav__link">
+        Simulating Responses
+      </a>
+    </li>
+  
+
+          
+        </ul>
+      </nav>
+    </li>
+  
+
+    
+      
+      
+      
+
+  
+  
+    
+  
+  
+    
+      
+    
+    <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
+      
+      
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
+      
+      <label class="md-nav__link" for="__nav_5">
+        webqueue2api Package
+        <span class="md-nav__icon md-icon"></span>
+      </label>
+      <nav class="md-nav" aria-label="webqueue2api Package" data-md-level="1">
+        <label class="md-nav__title" for="__nav_5">
+          <span class="md-nav__icon md-icon"></span>
+          webqueue2api Package
+        </label>
+        <ul class="md-nav__list" data-md-scrollfix>
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../Getting%20Started/" class="md-nav__link">
+        Getting Started
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../Configuration/" class="md-nav__link">
+        Configuration
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+    
+  
+  
+    <li class="md-nav__item md-nav__item--active">
+      
+      <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+      
+      
+      
+      <a href="./" class="md-nav__link md-nav__link--active">
+        Deployment
+      </a>
+      
+    </li>
+  
+
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../Package%20Structure/" class="md-nav__link">
+        Package Structure
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+      
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
+      
+      <label class="md-nav__link" for="__nav_5_5">
+        Parser
+        <span class="md-nav__icon md-icon"></span>
+      </label>
+      <nav class="md-nav" aria-label="Parser" data-md-level="2">
+        <label class="md-nav__title" for="__nav_5_5">
+          <span class="md-nav__icon md-icon"></span>
+          Parser
+        </label>
+        <ul class="md-nav__list" data-md-scrollfix>
+          
+            
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../Parser/Section%20Parsing%20Definitions/" class="md-nav__link">
+        Section Parsing Definitions
+      </a>
+    </li>
+  
+
+          
+        </ul>
+      </nav>
+    </li>
+  
+
+          
+        </ul>
+      </nav>
+    </li>
+  
+
+    
+  </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+            
+            
+          
+          <div class="md-content" data-md-component="content">
+            <article class="md-content__inner md-typeset">
+              
+                
+                
+                  <h1>Deployment</h1>
+                
+                <p>For convenience, as WSGI compliant symbole is available at <code>webqueu2api.api:app</code>. This can be used with any WSGI server. This project was developed against <a href="https://gunicorn.org/">gunicorn</a> so that is what we recommend.</p>
+<div class="admonition example">
+<p class="admonition-title">Development Example</p>
+<p>Start a server on <code>localhost:5000</code> in debug mode.
+<div class="highlight"><pre><span></span><code>gunicorn --log-level debug webqueue2.api:app
+</code></pre></div></p>
+</div>
+<div class="admonition example">
+<p class="admonition-title">Production Example</p>
+<p>Start a public server on port 5000 in the background with access and error logs written to files.
+<div class="highlight"><pre><span></span><code>gunicorn --daemon <span class="se">\</span>
+  --access-logfile /var/log/webqueue2api/access.log <span class="se">\ </span>
+  --error-logfile /var/log/webqueue2api/error.log <span class="se">\ </span>
+  webqueue2.api:app
+</code></pre></div></p>
+</div>
+<p>See <a href="https://gunicorn.org/#docs">gunicorn's Docs</a> for more details about configuring gunicorn.</p>
+                
+              
+              
+                
+
+
+              
+            </article>
+          </div>
+        </div>
+        
+      </main>
+      
+        
+<footer class="md-footer">
+  
+    <nav class="md-footer__inner md-grid" aria-label="Footer">
+      
+        
+        <a href="../Configuration/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration" rel="prev">
+          <div class="md-footer__button md-icon">
+            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
+          </div>
+          <div class="md-footer__title">
+            <div class="md-ellipsis">
+              <span class="md-footer__direction">
+                Previous
+              </span>
+              Configuration
+            </div>
+          </div>
+        </a>
+      
+      
+        
+        <a href="../Package%20Structure/" class="md-footer__link md-footer__link--next" aria-label="Next: Package Structure" rel="next">
+          <div class="md-footer__title">
+            <div class="md-ellipsis">
+              <span class="md-footer__direction">
+                Next
+              </span>
+              Package Structure
+            </div>
+          </div>
+          <div class="md-footer__button md-icon">
+            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
+          </div>
+        </a>
+      
+    </nav>
+  
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-footer-copyright">
+        
+        Made with
+        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+          Material for MkDocs
+        </a>
+        
+      </div>
+      
+  <div class="md-footer-social">
+    
+      
+      
+      <a href="https://purdueecn.slack.com/archives/C019K7PSPNW" target="_blank" rel="noopener" title="webqueue2 on Slack" class="md-footer-social__link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M94.12 315.1c0 25.9-21.16 47.06-47.06 47.06S0 341 0 315.1c0-25.9 21.16-47.06 47.06-47.06h47.06v47.06zm23.72 0c0-25.9 21.16-47.06 47.06-47.06s47.06 21.16 47.06 47.06v117.84c0 25.9-21.16 47.06-47.06 47.06s-47.06-21.16-47.06-47.06V315.1zm47.06-188.98c-25.9 0-47.06-21.16-47.06-47.06S139 32 164.9 32s47.06 21.16 47.06 47.06v47.06H164.9zm0 23.72c25.9 0 47.06 21.16 47.06 47.06s-21.16 47.06-47.06 47.06H47.06C21.16 243.96 0 222.8 0 196.9s21.16-47.06 47.06-47.06H164.9zm188.98 47.06c0-25.9 21.16-47.06 47.06-47.06 25.9 0 47.06 21.16 47.06 47.06s-21.16 47.06-47.06 47.06h-47.06V196.9zm-23.72 0c0 25.9-21.16 47.06-47.06 47.06-25.9 0-47.06-21.16-47.06-47.06V79.06c0-25.9 21.16-47.06 47.06-47.06 25.9 0 47.06 21.16 47.06 47.06V196.9zM283.1 385.88c25.9 0 47.06 21.16 47.06 47.06 0 25.9-21.16 47.06-47.06 47.06-25.9 0-47.06-21.16-47.06-47.06v-47.06h47.06zm0-23.72c-25.9 0-47.06-21.16-47.06-47.06 0-25.9 21.16-47.06 47.06-47.06h117.84c25.9 0 47.06 21.16 47.06 47.06 0 25.9-21.16 47.06-47.06 47.06H283.1z"/></svg>
+      </a>
+    
+      
+      
+      <a href="https://github.itap.purdue.edu/ECN/webqueue2-api" target="_blank" rel="noopener" title="webqueue2-API on GitHub" class="md-footer-social__link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
+      </a>
+    
+  </div>
+
+    </div>
+  </div>
+</footer>
+      
+    </div>
+    <div class="md-dialog" data-md-component="dialog">
+      <div class="md-dialog__inner md-typeset"></div>
+    </div>
+    <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.709b4209.min.js", "version": null}</script>
+    
+    
+      <script src="../../assets/javascripts/bundle.2b46852b.min.js"></script>
+      
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js"></script>
+      
+        <script src="../../javascript/tablesort.js"></script>
+      
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/docs/webqueue2api Package/Getting Started/index.html b/docs/webqueue2api Package/Getting Started/index.html
index 234c5eb..f15395f 100644
--- a/docs/webqueue2api Package/Getting Started/index.html	
+++ b/docs/webqueue2api Package/Getting Started/index.html	
@@ -434,6 +434,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -450,14 +462,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/webqueue2api Package/Package Structure/index.html b/docs/webqueue2api Package/Package Structure/index.html
index b92ba14..0423bc9 100644
--- a/docs/webqueue2api Package/Package Structure/index.html	
+++ b/docs/webqueue2api Package/Package Structure/index.html	
@@ -393,6 +393,18 @@
             
   
   
+  
+    <li class="md-nav__item">
+      <a href="../Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
     
   
   
@@ -446,14 +458,14 @@
     <li class="md-nav__item md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" >
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
@@ -559,7 +571,7 @@ <h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Perma
     <nav class="md-footer__inner md-grid" aria-label="Footer">
       
         
-        <a href="../Configuration/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration" rel="prev">
+        <a href="../Deployment/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Deployment" rel="prev">
           <div class="md-footer__button md-icon">
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
           </div>
@@ -568,7 +580,7 @@ <h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Perma
               <span class="md-footer__direction">
                 Previous
               </span>
-              Configuration
+              Deployment
             </div>
           </div>
         </a>
diff --git a/docs/webqueue2api Package/Parser/Section Parsing Definitions/index.html b/docs/webqueue2api Package/Parser/Section Parsing Definitions/index.html
index 0684536..eeefb0f 100644
--- a/docs/webqueue2api Package/Parser/Section Parsing Definitions/index.html	
+++ b/docs/webqueue2api Package/Parser/Section Parsing Definitions/index.html	
@@ -394,6 +394,18 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../Deployment/" class="md-nav__link">
+        Deployment
+      </a>
+    </li>
+  
+
+          
+            
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../Package%20Structure/" class="md-nav__link">
         Package Structure
@@ -412,14 +424,14 @@
     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
       
       
-        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" checked>
+        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_5" type="checkbox" id="__nav_5_5" checked>
       
-      <label class="md-nav__link" for="__nav_5_4">
+      <label class="md-nav__link" for="__nav_5_5">
         Parser
         <span class="md-nav__icon md-icon"></span>
       </label>
       <nav class="md-nav" aria-label="Parser" data-md-level="2">
-        <label class="md-nav__title" for="__nav_5_4">
+        <label class="md-nav__title" for="__nav_5_5">
           <span class="md-nav__icon md-icon"></span>
           Parser
         </label>
diff --git a/docs/webqueue2api Package/awesome-pages.yaml b/docs/webqueue2api Package/awesome-pages.yaml
index 9c82ab4..aec8315 100644
--- a/docs/webqueue2api Package/awesome-pages.yaml	
+++ b/docs/webqueue2api Package/awesome-pages.yaml	
@@ -3,5 +3,6 @@
 nav:
     - Getting Started.md
     - Configuration.md
+    - Deployment.md
     - Package Structure.md
     - ...
\ No newline at end of file