Skip to content

Commit

Permalink
deploy: 22911b0
Browse files Browse the repository at this point in the history
  • Loading branch information
@jgaucher-cs
jgaucher-cs committed May 16, 2024
1 parent 664a16a commit bd6c06c
Show file tree
Hide file tree
Showing 19 changed files with 60 additions and 46 deletions.
Binary file modified api/python/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified api/python/doctrees/generated/rs_server_cadip/rs_server_cadip.api.doctree
View file
Binary file not shown.
17 changes: 3 additions & 14 deletions api/python/html/generated/rs_server_cadip/rs_server_cadip.api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,21 +194,10 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py function">
<dt class="sig sig-object py" id="rs_server_cadip.api.cadip_search.search_session">
<span class="sig-prename descclassname"><span class="pre">rs_server_cadip.api.cadip_search.</span></span><span class="sig-name descname"><span class="pre">search_session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">station</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rs_server_cadip.api.cadip_search.search_session" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">rs_server_cadip.api.cadip_search.</span></span><span class="sig-name descname"><span class="pre">search_session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">station</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Path(PydanticUndefined)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rs_server_cadip.api.cadip_search.search_session" title="Link to this definition"></a></dt>
<dd><p>Endpoint to retrieve list of sessions from any CADIP station.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>station</strong> (<em>str</em>) – CADIP station identifier (MTI, SGS, MPU, INU, etc)</p></li>
<li><p><strong>id</strong> (<em>str</em><em>, </em><em>list-like-str</em>) – Session identifier
(eg: “S1A_20170501121534062343” or “S1A_20170501121534062343, S1A_20240328185208053186”)</p></li>
<li><p><strong>platform</strong> (<em>str</em><em>, </em><em>list-like-str</em>) – Satellite identifier
(eg: “S1A” or “S1A, S1B”)</p></li>
<li><p><strong>start_date</strong> (<em>str</em>) – Start date of the time interval</p></li>
<li><p><strong>stop_date</strong> (<em>str</em>) – Stop date of the time interval</p></li>
</ul>
</dd>
</dl>
<p>A valid session search request must contain at least a value for either <em>id</em> or <em>platform</em> or time interval
(<em>start_date</em> and <em>stop_date</em> correctly defined).</p>
</dd></dl>

</section>
Expand Down
2 changes: 1 addition & 1 deletion api/python/html/searchindex.js
View file

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions api/rest/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<!--
Copyright 2024 CS Group
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<html>
<head>
<!-- Load the latest Swagger UI code and style from npm using unpkg.com -->
Expand Down
41 changes: 22 additions & 19 deletions api/rest/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"info": {
"title": "RS-Server",
"version": "0.1a8"
"version": "0.1a9"
},
"paths": {
"/adgs/aux/search": {
Expand All @@ -25,10 +25,10 @@
"required": true,
"schema": {
"type": "string",
"description": "Time interval e.g. '2024-01-01T00:00:00Z/2024-01-02T23:59:59Z'",
"description": "Time interval e.g. \"2024-01-01T00:00:00Z/2024-01-02T23:59:59Z\"",
"title": "Datetime"
},
"description": "Time interval e.g. '2024-01-01T00:00:00Z/2024-01-02T23:59:59Z'"
"description": "Time interval e.g. \"2024-01-01T00:00:00Z/2024-01-02T23:59:59Z\""
},
{
"name": "limit",
Expand Down Expand Up @@ -146,10 +146,10 @@
"type": "null"
}
],
"description": "Object storage path e.g. 's3://bucket-name/sub/dir'",
"description": "Object storage path e.g. \"s3://bucket-name/sub/dir\"",
"title": "Obs"
},
"description": "Object storage path e.g. 's3://bucket-name/sub/dir'"
"description": "Object storage path e.g. \"s3://bucket-name/sub/dir\""
}
],
"responses": {
Expand Down Expand Up @@ -257,10 +257,10 @@
"required": true,
"schema": {
"type": "string",
"description": "Time interval e.g. '2024-01-01T00:00:00Z/2024-01-02T23:59:59Z'",
"description": "Time interval e.g. \"2024-01-01T00:00:00Z/2024-01-02T23:59:59Z\"",
"title": "Datetime"
},
"description": "Time interval e.g. '2024-01-01T00:00:00Z/2024-01-02T23:59:59Z'"
"description": "Time interval e.g. \"2024-01-01T00:00:00Z/2024-01-02T23:59:59Z\""
},
{
"name": "limit",
Expand Down Expand Up @@ -328,7 +328,7 @@
"CADIP stations"
],
"summary": "Search Session",
"description": "Endpoint to retrieve list of sessions from any CADIP station.\n\nArgs:\n station (str): CADIP station identifier (MTI, SGS, MPU, INU, etc)\n id (str, list-like-str): Session identifier\n (eg: \"S1A_20170501121534062343\" or \"S1A_20170501121534062343, S1A_20240328185208053186\")\n platform (str, list-like-str): Satellite identifier\n (eg: \"S1A\" or \"S1A, S1B\")\n start_date (str): Start date of the time interval\n stop_date (str): Stop date of the time interval",
"description": "Endpoint to retrieve list of sessions from any CADIP station.\n\nA valid session search request must contain at least a value for either *id* or *platform* or time interval\n(*start_date* and *stop_date* correctly defined).",
"operationId": "search_session_cadip__station__session_get",
"security": [
{
Expand All @@ -341,8 +341,11 @@
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "CADIP station identifier (MTI, SGS, MPU, INU, etc)",
"title": "Station"
}
},
"description": "CADIP station identifier (MTI, SGS, MPU, INU, etc)"
},
{
"name": "id",
Expand All @@ -357,10 +360,10 @@
"type": "null"
}
],
"description": "SessionID filter e.g 'S1A_20170501121534062343",
"description": "Session identifier eg: \"S1A_20200105072204051312\" or \"S1A_20200105072204051312, S1A_20220715090550123456\"",
"title": "Id"
},
"description": "SessionID filter e.g 'S1A_20170501121534062343"
"description": "Session identifier eg: \"S1A_20200105072204051312\" or \"S1A_20200105072204051312, S1A_20220715090550123456\""
},
{
"name": "platform",
Expand All @@ -375,10 +378,10 @@
"type": "null"
}
],
"description": "Satellite filter e.g 'S1A",
"description": "Satellite identifier eg: \"S1A\" or \"S1A, S1B\"",
"title": "Platform"
},
"description": "Satellite filter e.g 'S1A"
"description": "Satellite identifier eg: \"S1A\" or \"S1A, S1B\""
},
{
"name": "start_date",
Expand All @@ -393,10 +396,10 @@
"type": "null"
}
],
"description": "Start time e.g. '2024-01-01T00:00:00Z'",
"description": "Start time e.g. \"2024-01-01T00:00:00Z\"",
"title": "Start Date"
},
"description": "Start time e.g. '2024-01-01T00:00:00Z'"
"description": "Start time e.g. \"2024-01-01T00:00:00Z\""
},
{
"name": "stop_date",
Expand All @@ -411,10 +414,10 @@
"type": "null"
}
],
"description": "Stop time e.g. '2024-01-01T00:00:00Z'",
"description": "Stop time e.g. \"2024-01-01T00:00:00Z\"",
"title": "Stop Date"
},
"description": "Stop time e.g. '2024-01-01T00:00:00Z'"
"description": "Stop time e.g. \"2024-01-01T00:00:00Z\""
}
],
"responses": {
Expand Down Expand Up @@ -506,10 +509,10 @@
"type": "null"
}
],
"description": "Object storage path e.g. 's3://bucket-name/sub/dir'",
"description": "Object storage path e.g. \"s3://bucket-name/sub/dir\"",
"title": "Obs"
},
"description": "Object storage path e.g. 's3://bucket-name/sub/dir'"
"description": "Object storage path e.g. \"s3://bucket-name/sub/dir\""
}
],
"responses": {
Expand Down
2 changes: 1 addition & 1 deletion dev/background/ci.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ <h2 id="_generate_documentation_workflow">Generate documentation workflow</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/background/tree-structure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <h1>Project tree structure</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/background/workflow.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ <h2 id="_code_review">Code review</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/code-style.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ <h2 id="_documentation">Documentation</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/design/design.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h5 id="_configuration">Configuration</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/doc-generation/description.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ <h2 id="_rest_api_reference_guide">Rest api reference guide</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/doc-generation/how-to.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ <h2 id="_verify_the_generated_documentation">5. Verify the generated documentati
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/environment/description.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h1>Development environment description</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion dev/environment/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ <h2 id="_the_next_steps">The next steps</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
Binary file added images/banner_logo.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h2 id="_developer_manual">Developer manual</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion users/architecture.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ <h3 id="_stac_item_lifecycle">STAC item lifecycle</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down
8 changes: 7 additions & 1 deletion users/functionalities.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,12 @@ <h4 id="_parameters_2">Parameters</h4>
</div>
</div>
<div class="sect3">
<h4 id="_note">Note</h4>
<div class="paragraph">
<p>A valid session search request must contain at least a value for either <strong>id</strong> or <strong>platform</strong> or time interval (<strong>start_date</strong> and <strong>stop_date</strong> correctly defined).</p>
</div>
</div>
<div class="sect3">
<h4 id="_request_example_2">Request example</h4>
<div class="listingblock">
<div class="content">
Expand Down Expand Up @@ -995,7 +1001,7 @@ <h3 id="_update_a_feature"><span class="green">Update a Feature</span></h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-29 16:57:30 UTC
Last updated 2024-05-16 13:49:33 UTC
</div>
</div>
</body>
Expand Down

0 comments on commit bd6c06c

Please sign in to comment.