Skip to content

Commit 7be8c17

Browse files
hhuangMITREhhuangMITRE
authored
Updating documentation for new media metadata field in REST API.
1 parent fac44a2 commit 7be8c17

4 files changed

Lines changed: 61 additions & 25 deletions

File tree

‎docs/docs/html/REST-API.html‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@
145145
<body>
146146
<div style='page-break-after:always'>
147147
<h1>OpenMPF Workflow Manager REST API</h1>
148-
<h2>Version 5.0.0 (build 20200616)</h2>
148+
<h2>Version 5.1.0 (build 20200804)</h2>
149149
<br/>
150150
<p><i><font size="3">NOTICE</font></i></p>
151151
<p><i><font size="3">
@@ -158,7 +158,7 @@ <h2>Version 5.0.0 (build 20200616)</h2>
158158
</font></i></p>
159159
<br/>
160160
</div>
161-
<div class='footer'>Last updated on: Tue Jun 23, 2020</div>
161+
<div class='footer'>Last updated on: Tue Aug 4, 2020</div>
162162
<div class="coverHeadings">
163163
<h1>Introduction</h1>
164164
</div>
@@ -652,6 +652,18 @@ <h3>1.4. JobCreationRequest</h3>
652652
<td style='width:30%;'>A valid (properly encoded) URI to a single media source for the job.</td>
653653
<td style='width:30%;'>Yes</td>
654654
</tr>
655+
<tr style=''>
656+
<td style='width:30%;'>metadata</td>
657+
<td style='width:10%;'>object</td>
658+
<td style='width:30%;'>A map of key-value pairs using strings which may be used to set the metadata for this
659+
media. When sufficient metadata is provided, media inspection will be skipped. To skip inspection, the
660+
`MEDIA_HASH` and `MIME_TYPE` keys must be set to the media's respective hash and media type. Audio files
661+
will also require the metadata value for `DURATION`. Image files will also require the metadata values
662+
for `FRAME_WIDTH` and `FRAME_HEIGHT`. Video files will also require the metadata values for
663+
`FRAME_WIDTH`, `FRAME_HEIGHT`, `FRAME_COUNT`, `FPS`, and `DURATION`.
664+
</td>
665+
<td style='width:30%;'>No</td>
666+
</tr>
655667
<tr style=''>
656668
<td style='width:30%;'>properties</td>
657669
<td style='width:10%;'>object</td>
@@ -1891,6 +1903,12 @@ <h2>2. Paths</h2>
18911903
URIs must be properly encoded.
18921904
<br/>
18931905
<br/>
1906+
Within media, an optional metadata object containing String key-value pairs can override media
1907+
inspection once the required metadata information is provided for audio, image, generic, and
1908+
video jobs. For media metadata, note that optional parameters like `ROTATION` and
1909+
`HORIZONTAL_FLIP` can also be provided.
1910+
<br/>
1911+
<br/>
18941912
The body of a POST job creation request will be similar to this example which uses a OCV FACE DETECTION (WITH MOG MOTION PREPROCESSOR) PIPELINE. Some unrequired parameters are omitted. Note that this example makes use of overloading by jobProperties, algorithmProperties and mediaProperties:
18951913
<br/>
18961914
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">

‎docs/site/html/REST-API.html‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@
145145
<body>
146146
<div style='page-break-after:always'>
147147
<h1>OpenMPF Workflow Manager REST API</h1>
148-
<h2>Version 5.0.0 (build 20200616)</h2>
148+
<h2>Version 5.1.0 (build 20200804)</h2>
149149
<br/>
150150
<p><i><font size="3">NOTICE</font></i></p>
151151
<p><i><font size="3">
@@ -158,7 +158,7 @@ <h2>Version 5.0.0 (build 20200616)</h2>
158158
</font></i></p>
159159
<br/>
160160
</div>
161-
<div class='footer'>Last updated on: Tue Jun 23, 2020</div>
161+
<div class='footer'>Last updated on: Tue Aug 4, 2020</div>
162162
<div class="coverHeadings">
163163
<h1>Introduction</h1>
164164
</div>
@@ -652,6 +652,18 @@ <h3>1.4. JobCreationRequest</h3>
652652
<td style='width:30%;'>A valid (properly encoded) URI to a single media source for the job.</td>
653653
<td style='width:30%;'>Yes</td>
654654
</tr>
655+
<tr style=''>
656+
<td style='width:30%;'>metadata</td>
657+
<td style='width:10%;'>object</td>
658+
<td style='width:30%;'>A map of key-value pairs using strings which may be used to set the metadata for this
659+
media. When sufficient metadata is provided, media inspection will be skipped. To skip inspection, the
660+
`MEDIA_HASH` and `MIME_TYPE` keys must be set to the media's respective hash and media type. Audio files
661+
will also require the metadata value for `DURATION`. Image files will also require the metadata values
662+
for `FRAME_WIDTH` and `FRAME_HEIGHT`. Video files will also require the metadata values for
663+
`FRAME_WIDTH`, `FRAME_HEIGHT`, `FRAME_COUNT`, `FPS`, and `DURATION`.
664+
</td>
665+
<td style='width:30%;'>No</td>
666+
</tr>
655667
<tr style=''>
656668
<td style='width:30%;'>properties</td>
657669
<td style='width:10%;'>object</td>
@@ -1891,6 +1903,12 @@ <h2>2. Paths</h2>
18911903
URIs must be properly encoded.
18921904
<br/>
18931905
<br/>
1906+
Within media, an optional metadata object containing String key-value pairs can override media
1907+
inspection once the required metadata information is provided for audio, image, generic, and
1908+
video jobs. For media metadata, note that optional parameters like `ROTATION` and
1909+
`HORIZONTAL_FLIP` can also be provided.
1910+
<br/>
1911+
<br/>
18941912
The body of a POST job creation request will be similar to this example which uses a OCV FACE DETECTION (WITH MOG MOTION PREPROCESSOR) PIPELINE. Some unrequired parameters are omitted. Note that this example makes use of overloading by jobProperties, algorithmProperties and mediaProperties:
18951913
<br/>
18961914
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">

‎docs/site/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,5 +398,5 @@ <h1 id="overview">Overview</h1>
398398

399399
<!--
400400
MkDocs version : 0.16.0
401-
Build Date UTC : 2020-07-29 15:08:51
401+
Build Date UTC : 2020-08-06 02:13:46
402402
-->

‎docs/site/sitemap.xml‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<url>
66
<loc>/index.html</loc>
7-
<lastmod>2020-07-29</lastmod>
7+
<lastmod>2020-08-05</lastmod>
88
<changefreq>daily</changefreq>
99
</url>
1010

@@ -13,55 +13,55 @@
1313

1414
<url>
1515
<loc>/Release-Notes/index.html</loc>
16-
<lastmod>2020-07-29</lastmod>
16+
<lastmod>2020-08-05</lastmod>
1717
<changefreq>daily</changefreq>
1818
</url>
1919

2020
<url>
2121
<loc>/Install-Guide/index.html</loc>
22-
<lastmod>2020-07-29</lastmod>
22+
<lastmod>2020-08-05</lastmod>
2323
<changefreq>daily</changefreq>
2424
</url>
2525

2626
<url>
2727
<loc>/User-Guide/index.html</loc>
28-
<lastmod>2020-07-29</lastmod>
28+
<lastmod>2020-08-05</lastmod>
2929
<changefreq>daily</changefreq>
3030
</url>
3131

3232
<url>
3333
<loc>/Admin-Guide/index.html</loc>
34-
<lastmod>2020-07-29</lastmod>
34+
<lastmod>2020-08-05</lastmod>
3535
<changefreq>daily</changefreq>
3636
</url>
3737

3838
<url>
3939
<loc>/Node-Guide/index.html</loc>
40-
<lastmod>2020-07-29</lastmod>
40+
<lastmod>2020-08-05</lastmod>
4141
<changefreq>daily</changefreq>
4242
</url>
4343

4444
<url>
4545
<loc>/Object-Storage-Guide/index.html</loc>
46-
<lastmod>2020-07-29</lastmod>
46+
<lastmod>2020-08-05</lastmod>
4747
<changefreq>daily</changefreq>
4848
</url>
4949

5050
<url>
5151
<loc>/Contributor-Guide/index.html</loc>
52-
<lastmod>2020-07-29</lastmod>
52+
<lastmod>2020-08-05</lastmod>
5353
<changefreq>daily</changefreq>
5454
</url>
5555

5656
<url>
5757
<loc>/Development-Environment-Guide/index.html</loc>
58-
<lastmod>2020-07-29</lastmod>
58+
<lastmod>2020-08-05</lastmod>
5959
<changefreq>daily</changefreq>
6060
</url>
6161

6262
<url>
6363
<loc>/Acknowledgements/index.html</loc>
64-
<lastmod>2020-07-29</lastmod>
64+
<lastmod>2020-08-05</lastmod>
6565
<changefreq>daily</changefreq>
6666
</url>
6767

@@ -71,49 +71,49 @@
7171

7272
<url>
7373
<loc>/Component-API-Overview/index.html</loc>
74-
<lastmod>2020-07-29</lastmod>
74+
<lastmod>2020-08-05</lastmod>
7575
<changefreq>daily</changefreq>
7676
</url>
7777

7878
<url>
7979
<loc>/CPP-Batch-Component-API/index.html</loc>
80-
<lastmod>2020-07-29</lastmod>
80+
<lastmod>2020-08-05</lastmod>
8181
<changefreq>daily</changefreq>
8282
</url>
8383

8484
<url>
8585
<loc>/CPP-Streaming-Component-API/index.html</loc>
86-
<lastmod>2020-07-29</lastmod>
86+
<lastmod>2020-08-05</lastmod>
8787
<changefreq>daily</changefreq>
8888
</url>
8989

9090
<url>
9191
<loc>/Java-Batch-Component-API/index.html</loc>
92-
<lastmod>2020-07-29</lastmod>
92+
<lastmod>2020-08-05</lastmod>
9393
<changefreq>daily</changefreq>
9494
</url>
9595

9696
<url>
9797
<loc>/Python-Batch-Component-API/index.html</loc>
98-
<lastmod>2020-07-29</lastmod>
98+
<lastmod>2020-08-05</lastmod>
9999
<changefreq>daily</changefreq>
100100
</url>
101101

102102
<url>
103103
<loc>/GPU-Support-Guide/index.html</loc>
104-
<lastmod>2020-07-29</lastmod>
104+
<lastmod>2020-08-05</lastmod>
105105
<changefreq>daily</changefreq>
106106
</url>
107107

108108
<url>
109109
<loc>/Packaging-and-Registering-a-Component/index.html</loc>
110-
<lastmod>2020-07-29</lastmod>
110+
<lastmod>2020-08-05</lastmod>
111111
<changefreq>daily</changefreq>
112112
</url>
113113

114114
<url>
115115
<loc>/Feed-Forward-Guide/index.html</loc>
116-
<lastmod>2020-07-29</lastmod>
116+
<lastmod>2020-08-05</lastmod>
117117
<changefreq>daily</changefreq>
118118
</url>
119119

@@ -123,13 +123,13 @@
123123

124124
<url>
125125
<loc>/Workflow-Manager/index.html</loc>
126-
<lastmod>2020-07-29</lastmod>
126+
<lastmod>2020-08-05</lastmod>
127127
<changefreq>daily</changefreq>
128128
</url>
129129

130130
<url>
131131
<loc>/REST-API/index.html</loc>
132-
<lastmod>2020-07-29</lastmod>
132+
<lastmod>2020-08-05</lastmod>
133133
<changefreq>daily</changefreq>
134134
</url>
135135

0 commit comments

Comments
 (0)