Skip to content

Commit

Permalink
Deployed 6e6df94 to master with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@funmoocbot
funmoocbot committed Dec 15, 2023
1 parent f6d3165 commit 5f3f0ea
Show file tree
Hide file tree
Showing 6 changed files with 361 additions and 55 deletions.
86 changes: 50 additions & 36 deletions master/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2220,66 +2220,80 @@ <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Perma
<h2 id="unreleased"><a href="https://github.com/openfun/ralph/compare/v3.9.0...master">Unreleased</a><a class="headerlink" href="#unreleased" title="Permanent link">&para;</a></h2>
<h3 id="added">Added<a class="headerlink" href="#added" title="Permanent link">&para;</a></h3>
<ul>
<li>Implement Pydantic model for LRS Statements resource query parameters</li>
<li>Implement xAPI LMS Profile statements validation</li>
<li><code>EdX</code> to <code>xAPI</code> converters for enrollment events</li>
<li>Backends: Add <code>Writable</code> and <code>Listable</code> interfaces to distinguish supported
functionalities among <code>data</code> backends</li>
<li>Backends: Add <code>max_statements</code> option to data backends <code>read</code> method</li>
<li>Backends: Add <code>prefetch</code> option to async data backends <code>read</code> method</li>
<li>Backends: Add <code>concurrency</code> option to async data backends <code>write</code> method</li>
<li>Backends: Add <code>get_backends</code> function to automatically discover backends
for CLI and LRS usage</li>
<li>Add aliases for <code>ralph-malph</code> extra dependencies: <code>backends</code> and <code>full</code></li>
<li>Backends: Add client options for WSDataBackend</li>
<li>Backends: Add <code>READ_CHUNK_SIZE</code> and <code>WRITE_CHUNK_SIZE</code> data backend settings</li>
<li>Models: Implement Pydantic model for LRS Statements resource query parameters</li>
<li>Models: Implement xAPI LMS Profile statements validation</li>
<li>Models: Add <code>EdX</code> to <code>xAPI</code> converters for enrollment events</li>
<li>Project: Add aliases for <code>ralph-malph</code> extra dependencies: <code>backends</code> and
<code>full</code></li>
</ul>
<h3 id="changed">Changed<a class="headerlink" href="#changed" title="Permanent link">&para;</a></h3>
<ul>
<li>Upgrade base python version to 3.12 for the development stack and Docker
image</li>
<li>Upgrade <code>cachetools</code> to <code>5.3.2</code></li>
<li>Refactor <code>database</code> and <code>storage</code> backends under the unified <code>data</code> backend
interface [BC]</li>
<li>Refactor LRS <code>query_statements</code> and <code>query_statements_by_ids</code> backends
methods under the unified <code>lrs</code> backend interface [BC]</li>
<li>Refactor LRS Statements resource query parameters defined for <code>ralph</code> API</li>
<li>User credentials must now include an &ldquo;agent&rdquo; field which can be created
using the cli</li>
<li><code>GET /statements</code> now has &ldquo;mine&rdquo; option which matches statements that
have an authority field matching that of the user</li>
<li>CLI: change <code>push</code> to <code>write</code> and <code>fetch</code> to <code>read</code> [BC]</li>
<li>Upgrade <code>bcrypt</code> to <code>4.1.1</code></li>
<li>Upgrade <code>fastapi</code> to <code>0.105.0</code></li>
<li>Upgrade <code>sentry_sdk</code> to <code>1.38.0</code></li>
<li>Upgrade <code>uvicorn</code> to <code>0.24.0.post1</code></li>
<li>Arnold: Add variable to override PVC name in arnold deployment</li>
<li>API: <code>GET /statements</code> now has &ldquo;mine&rdquo; option which matches statements that
have an authority field matching that of the user</li>
<li>API: Invalid parameters now return 400 status code</li>
<li>API: Forwarding PUT now uses PUT (instead of POST)</li>
<li>Models: The xAPI <code>context.contextActivities.category</code> field is now mandatory
in the video and virtual classroom profiles. [BC]</li>
<li>Backends: <code>LRSHTTP</code> methods must not be used in <code>asyncio</code> events loop (BC)</li>
<li>Add variable to override PVC name in arnold deployment</li>
<li>Backends: add <code>max_statements</code> option to <code>AsyncLRSHTTP</code></li>
<li>API: Incoming statements are enriched with <code>id</code>, <code>timestamp</code>, <code>stored</code>
and <code>authority</code></li>
<li>Backends: update <code>statementId</code> and <code>voidedStatementId</code> to snake_case,
with camelCase alias, in <code>LRSStatementsQuery</code></li>
<li>API: Add <code>RALPH_LRS_RESTRICT_BY_AUTHORITY</code> option making <code>?mine=True</code>
implicit</li>
<li>CLI: list cli usage strings in alphabetical order</li>
<li>API: Add <code>RALPH_LRS_RESTRICT_BY_SCOPE</code> option enabling endpoint access
control by user scopes</li>
<li>Backends: Replace reference to a JSON column in ClickHouse with
function calls on the String column [BC]</li>
<li>API: enhance &lsquo;limit&rsquo; query parameter&rsquo;s validation </li>
<li>API: Enhance &lsquo;limit&rsquo; query parameter&rsquo;s validation</li>
<li>API: Variable <code>RUNSERVER_AUTH_BACKEND</code> becomes <code>RUNSERVER_AUTH_BACKENDS</code>, and
multiple authentication methods are supported simultaneously</li>
<li>Backends: Refactor LRS Statements resource query parameters defined for
<code>ralph</code> API</li>
<li>Backends: Refactor <code>database</code>, <code>storage</code>, <code>http</code> and <code>stream</code> backends under
the unified <code>data</code> backend interface [BC]</li>
<li>Backends: Refactor LRS <code>query_statements</code> and <code>query_statements_by_ids</code>
backends methods under the unified <code>lrs</code> backend interface [BC]</li>
<li>Backends: Update <code>statementId</code> and <code>voidedStatementId</code> to snake_case,
with camelCase alias, in <code>LRSStatementsQuery</code></li>
<li>Backends: Replace reference to a JSON column in ClickHouse with
function calls on the String column [BC]</li>
<li>CLI: User credentials must now include an &ldquo;agent&rdquo; field which can be created
using the cli</li>
<li>CLI: Change <code>push</code> to <code>write</code> and <code>fetch</code> to <code>read</code> [BC]</li>
<li>CLI: Change <code>-c --chunk-size</code> option to <code>-s --chunk-size</code> [BC]</li>
<li>CLI: Change websocket backend name <code>-b ws</code> to <code>-b async_ws</code> along with it&rsquo;s
uri option <code>--ws-uri</code> to <code>--async-ws-uri</code> [BC]</li>
<li>CLI: List cli usage strings in alphabetical order</li>
<li>CLI: Change backend configuration environment variable prefixes from
<code>RALPH_BACKENDS__{{DATABASE|HTTP|STORAGE|STREAM}}__{{BACKEND}}__{{OPTION}}</code>
to <code>RALPH_BACKENDS__DATA__{{BACKEND}}__{{OPTION}}</code></li>
<li>Models: The xAPI <code>context.contextActivities.category</code> field is now mandatory
in the video and virtual classroom profiles. [BC]</li>
<li>Upgrade base python version to 3.12 for the development stack and Docker
image</li>
<li>Upgrade <code>cachetools</code> to <code>5.3.2</code></li>
<li>Upgrade <code>bcrypt</code> to <code>&gt;=4.0.0</code></li>
<li>Upgrade <code>fastapi</code> to <code>0.105.0</code></li>
<li>Upgrade <code>sentry_sdk</code> to <code>1.38.0</code></li>
<li>Upgrade <code>uvicorn</code> to <code>0.24.0.post1</code></li>
</ul>
<h3 id="fixed">Fixed<a class="headerlink" href="#fixed" title="Permanent link">&para;</a></h3>
<ul>
<li>API: Fix a typo (&lsquo;attachements&rsquo; -&gt; &lsquo;attachments&rsquo;) to ensure compliance with
the LRS specification and prevent potential silent bugs.</li>
the LRS specification and prevent potential silent bugs</li>
</ul>
<h3 id="removed">Removed<a class="headerlink" href="#removed" title="Permanent link">&para;</a></h3>
<ul>
<li><code>school</code>, <code>course</code>, <code>module</code> context extensions in Edx to xAPI base converter</li>
<li><code>name</code> field in <code>VideoActivity</code> xAPI model mistakenly used in <code>video</code> profile</li>
<li>drop support for python 3.7</li>
<li>Project: Drop support for Python 3.7</li>
<li>Models: Remove <code>school</code>, <code>course</code>, <code>module</code> context extensions in Edx to xAPI
base converter</li>
<li>Models: Remove <code>name</code> field in <code>VideoActivity</code> xAPI model mistakenly used in
<code>video</code> profile</li>
<li>CLI: Remove <code>DEFAULT_BACKEND_CHUNK_SIZE</code> environment variable configuration</li>
</ul>
<h2 id="390_-_2023-07-21"><a href="https://github.com/openfun/ralph/compare/v3.8.0...v3.9.0">3.9.0</a> - 2023-07-21<a class="headerlink" href="#390_-_2023-07-21" title="Permanent link">&para;</a></h2>
<h3 id="changed_1">Changed<a class="headerlink" href="#changed_1" title="Permanent link">&para;</a></h3>
Expand Down
Loading

0 comments on commit 5f3f0ea

Please sign in to comment.