Skip to content

Commit

Permalink
chg: [documentation] Updated documentation related to the RSS/Atom fe…
Browse files Browse the repository at this point in the history
…eds.
  • Loading branch information
cedricbonhomme committed Dec 22, 2024
1 parent b7885fd commit 3ce99b1
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
12 changes: 7 additions & 5 deletions static/documentation/_sources/feeds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@ Available feeds
* - user_bp.feed_activity
- GET
- /user/<string:login>.<string:format>
- User activity.
- Recent user activity.

* - home_bp.feed_recent
- GET
- /recent/<string:source>.<string:format>[?vulnerability=<vuln-id>][?vendor=<vendor-id>]
- Rencent vulnerabilities per source or for all sources.
Argument ``vulnerability`` is used for the feed of linked vulnerabilities.
Argument ``vendor`` is used to generate a feed of vulnerabilities dedicated a specific vendor.
- Recent vulnerabilities per source or for all sources.

Argument ``vulnerability`` is used to generate a feed of linked vulnerabilities.

Argument ``vendor`` is used to generate a feed of vulnerabilities for the specified vendor.

* - sightings_bp.feed_sightings
- GET
Expand All @@ -43,7 +45,7 @@ Available feeds
* - sightings_bp.feed_cpe_search
- GET
- /sightings/cpesearch/<string:cpe>/feed.<string:format>
- Recent sightings for a CPE.
- Recent sightings for all vulnerabilities related to a CPE.


The value of ``format`` can be ``rss`` or ``atom``.
Expand Down
11 changes: 6 additions & 5 deletions static/documentation/feeds.html
Original file line number Diff line number Diff line change
Expand Up @@ -431,14 +431,15 @@ <h2>Available feeds<a class="headerlink" href="#available-feeds" title="Link to
<tr class="row-even"><td><p>user_bp.feed_activity</p></td>
<td><p>GET</p></td>
<td><p>/user/&lt;string:login&gt;.&lt;string:format&gt;</p></td>
<td><p>User activity.</p></td>
<td><p>Recent user activity.</p></td>
</tr>
<tr class="row-odd"><td><p>home_bp.feed_recent</p></td>
<td><p>GET</p></td>
<td><p>/recent/&lt;string:source&gt;.&lt;string:format&gt;[?vulnerability=&lt;vuln-id&gt;][?vendor=&lt;vendor-id&gt;]</p></td>
<td><p>Rencent vulnerabilities per source or for all sources.
Argument <code class="docutils literal notranslate"><span class="pre">vulnerability</span></code> is used for the feed of linked vulnerabilities.
Argument <code class="docutils literal notranslate"><span class="pre">vendor</span></code> is used to generate a feed of vulnerabilities dedicated a specific vendor.</p></td>
<td><p>Recent vulnerabilities per source or for all sources.</p>
<p>Argument <code class="docutils literal notranslate"><span class="pre">vulnerability</span></code> is used to generate a feed of linked vulnerabilities.</p>
<p>Argument <code class="docutils literal notranslate"><span class="pre">vendor</span></code> is used to generate a feed of vulnerabilities for the specified vendor.</p>
</td>
</tr>
<tr class="row-even"><td><p>sightings_bp.feed_sightings</p></td>
<td><p>GET</p></td>
Expand All @@ -448,7 +449,7 @@ <h2>Available feeds<a class="headerlink" href="#available-feeds" title="Link to
<tr class="row-odd"><td><p>sightings_bp.feed_cpe_search</p></td>
<td><p>GET</p></td>
<td><p>/sightings/cpesearch/&lt;string:cpe&gt;/feed.&lt;string:format&gt;</p></td>
<td><p>Recent sightings for a CPE.</p></td>
<td><p>Recent sightings for all vulnerabilities related to a CPE.</p></td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit 3ce99b1

Please sign in to comment.