Update Docs

Ref: #250
openaddresses · Mar 2, 2022 · 84b0f5c · 84b0f5c
1 parent e648304
commit 84b0f5c
Show file tree

Hide file tree

Showing 7 changed files with 78 additions and 56 deletions.
diff --git a/api/doc/assets/main.bundle.js b/api/doc/assets/main.bundle.js
diff --git a/api/doc/index.html b/api/doc/index.html
@@ -211,7 +211,9 @@ <h2>{{__ "Query Parameter(s)"}}</h2>
             {{#if optional}}
               <span class="label optional">{{__ "optional"}}</span>
             {{else}}
-              <span class="label required">{{__ "required"}}</span>
+              {{#if ../template.showRequiredLabels}}
+                <span class="label required">{{__ "required"}}</span>
+              {{/if}}
             {{/if}}
             </td>
             {{#unless this.Type compare=null}}
@@ -254,7 +256,9 @@ <h2>{{__ "Request Body"}}</h2>
             {{#if optional}}
               <span class="label optional">{{__ "optional"}}</span>
             {{else}}
-              <span class="label required">{{__ "required"}}</span>
+              {{#if ../template.showRequiredLabels}}
+                <span class="label required">{{__ "required"}}</span>
+              {{/if}}
             {{/if}}
             </td>
             {{#unless this.Type compare=null}}
@@ -302,7 +306,9 @@ <h2>{{__ @key}}</h2>
             {{#if optional}}
               <span class="label optional">{{__ "optional"}}</span>
             {{else}}
-              <span class="label required">{{__ "required"}}</span>
+              {{#if ../template.showRequiredLabels}}
+                <span class="label required">{{__ "required"}}</span>
+              {{/if}}
             {{/if}}</td>
             {{#if ../../_hasType}}
               <td class="code">

diff --git a/api/lib/job.js b/api/lib/job.js
@@ -300,6 +300,10 @@ class Job {
                 job.s3 = `s3://${process.env.Bucket}/${process.env.StackName}/job/${job.id}/source.geojson.gz`;
             }
 
+            if (job.output && job.output.validated) {
+                job.s3_validated = `s3://${process.env.Bucket}/${process.env.StackName}/job/${job.id}/validated.geojson.gz`;
+            }
+
             return job;
         });
     }
@@ -355,6 +359,10 @@ class Job {
             job.s3 = `s3://${process.env.Bucket}/${process.env.StackName}/job/${job.id}/source.geojson.gz`;
         }
 
+        if (job.output && job.output.validated) {
+            job.s3_validated = `s3://${process.env.Bucket}/${process.env.StackName}/job/${job.id}/validated.geojson.gz`;
+        }
+
         return job;
     }
 

diff --git a/api/package-lock.json b/api/package-lock.json
diff --git a/api/routes/data.js b/api/routes/data.js
@@ -32,6 +32,7 @@ async function router(schema, config) {
             if (!req.auth || !req.auth.level || req.auth.level !== 'sponsor') {
                 for (const d of data) {
                     delete d.s3;
+                    delete d.s3_validated;
                 }
             }
 
@@ -98,6 +99,7 @@ async function router(schema, config) {
 
             if (!req.auth || !req.auth.level || req.auth.level !== 'sponsor') {
                 delete data.s3;
+                delete data.s3_validated;
             }
 
             return res.json(data);

diff --git a/api/routes/job.js b/api/routes/job.js
@@ -31,7 +31,8 @@ async function router(schema, config) {
 
             if (!req.auth || !req.auth.level || req.auth.level !== 'sponsor') {
                 for (const j of jobs) {
-                    delete j.s3;
+                    delete job.s3;
+                    delete job.s3_validated;
                 }
             }
 
@@ -64,6 +65,7 @@ async function router(schema, config) {
 
             if (!req.auth || !req.auth.level || req.auth.level !== 'sponsor') {
                 delete job.s3;
+                delete job.s3_validated;
             }
 
             return res.json(job);

diff --git a/api/schema/res.Job.json b/api/schema/res.Job.json
@@ -30,6 +30,9 @@
         "s3": {
             "type": ["boolean", "string"]
         },
+        "s3_validated": {
+            "type": ["boolean", "string"]
+        },
         "run": {
             "type": "integer"
         },