跳转到内容

订阅

25 endpoints.

GEThttp://localhost:3000/api/reservations

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 list_reservations,位于 crates/lanrurugi-api/src/subscriptions/api.rs:1003。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:54 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/reservations/{id}/discard

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 discard_reservation,位于 crates/lanrurugi-api/src/subscriptions/api.rs:1023。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:55 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

GEThttp://localhost:3000/api/subscriptions

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 list,位于 crates/lanrurugi-api/src/subscriptions/api.rs:168。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:27 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/subscriptions

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 create,位于 crates/lanrurugi-api/src/subscriptions/api.rs:245。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:27 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

DELETEhttp://localhost:3000/api/subscriptions/{id}

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 remove,位于 crates/lanrurugi-api/src/subscriptions/api.rs:348。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:40 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

GEThttp://localhost:3000/api/subscriptions/{id}

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 detail,位于 crates/lanrurugi-api/src/subscriptions/api.rs:288。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:40 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

PUThttp://localhost:3000/api/subscriptions/{id}

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 update,位于 crates/lanrurugi-api/src/subscriptions/api.rs:307。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:40 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

用户自己投的反对票:这些作品从此不再被该订阅下载

Section titled “用户自己投的反对票:这些作品从此不再被该订阅下载”
POSThttp://localhost:3000/api/subscriptions/{id}/block

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:640)的译文;原文以源码为准。

用户自己投的「不」:这些作品从此不再被该订阅下载。

刻意与「规则拒绝」区分开——规则读取的值会变化,所以拒绝是临时性的,每个周期都重新判定(FR-011i);而这是一个答复,重新判定就等于把用户已经说过的话再问一遍。预览界面按行提供这一操作;forget_seen 可以撤销它。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:50 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

立即执行一次真实检查,而不是等排期(FR-024)

Section titled “立即执行一次真实检查,而不是等排期(FR-024)”
POSThttp://localhost:3000/api/subscriptions/{id}/check

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:842)的译文;原文以源码为准。

立即执行一次真实检查,而不是等待排期(FR-024)。

它是派生出去执行的,而不是被 await:一次检查要联系来源,还可能翻页遍历,比一个请求应该保持打开的时间更长。结果会出现在该订阅自己的历史里。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:48 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/subscriptions/{id}/disable

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 disable,位于 crates/lanrurugi-api/src/subscriptions/api.rs:384。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:45 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/subscriptions/{id}/enable

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 enable,位于 crates/lanrurugi-api/src/subscriptions/api.rs:374。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:44 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

让某个订阅重新考虑它已经处理过的作品

Section titled “让某个订阅重新考虑它已经处理过的作品”
POSThttp://localhost:3000/api/subscriptions/{id}/forget

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:593)的译文;原文以源码为准。

让某个订阅重新考虑它已经处理过的作品。

「已看过」在其他情况下是永久性的,这对通常情形是正确的——用户故意删掉的作品绝不能在下次检查时回来。但有两种情况需要撤销它:一次误删,以及一条后来被放宽的规则(在旧规则下被拒绝的作品在被拒绝的那一刻就被记为已看过,所以没有任何东西会重新考虑它们)。

带 sources 时只遗忘指定的那些。带 all: true 时清空整个集合——它被保留为一个独立的、显式的请求,因为在长期运行的订阅上,它可能一次匹配到全部历史目录,后果的量级不同。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:49 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

预览一次检查会做什么,但不真的执行

Section titled “预览一次检查会做什么,但不真的执行”
POSThttp://localhost:3000/api/subscriptions/{id}/preview

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:799)的译文;原文以源码为准。

预览一次检查会做什么,但不真的执行。

它刻意可以作用于已停用的订阅:「这条规则实际会抓到什么」恰恰是在调整一条关掉的规则时问的。不会入队、不会记为已看过、也不会写日志,因此可以安全地反复运行——唯一的代价是向来源发一次请求。

接受一个可选的请求体携带尚未保存的订阅,这样规则可以在提交之前先预览。没有这一点,用户就得先保存一条规则才能知道它做什么。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:47 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/subscriptions/{id}/resume

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:396)的译文;原文以源码为准。

解除系统施加的暂停。与 enable 不同,因为被暂停的订阅是被系统停下的,它欠用户一个解释——恢复就是用户对这个解释的回应。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:46 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

用户显式屏蔽过的全部作品,最新的在前

Section titled “用户显式屏蔽过的全部作品,最新的在前”
GEThttp://localhost:3000/api/subscriptions/blocked

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:413)的译文;原文以源码为准。

用户显式屏蔽过的全部作品,最新的在前,跨所有订阅。

它有自己的端点,而不是在历史记录上加个筛选:屏蔽是一个答复——用户对这个作品说了不——而历史是不断被后续周期重写的决策日志(一个先入队后入库的作品在每条记录里都读作 already_held)。只有屏蔽列表始终保持在用户留下的样子,这正是它值得单独展示、并从这里撤销的原因。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:53 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/subscriptions/condition/ai

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 generate,位于 crates/lanrurugi-api/src/subscriptions/ai_condition.rs:302。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:38 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/subscriptions/condition/parse

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 parse,位于 crates/lanrurugi-api/src/subscriptions/ai_condition.rs:285。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:39 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

全部订阅的近期候选,合并成一条按时间倒序的流

Section titled “全部订阅的近期候选,合并成一条按时间倒序的流”
GEThttp://localhost:3000/api/subscriptions/history

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:446)的译文;原文以源码为准。

全部订阅的近期候选,合并成一条按时间倒序的流。

按订阅分开的历史已经存在,但它回答的是「这条规则做了什么」——而实际被问到的通常是另一个问题:最近来了什么,以及某个预期中的东西为什么没来。那需要把各个订阅交错在一起,而不是逐个读。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:52 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

GEThttp://localhost:3000/api/subscriptions/pending

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:855)的译文;原文以源码为准。

已匹配、等待用户确认的作品。它之所以可达,仅仅因为 auto_download 默认关闭——否则那个默认值会让候选被记录下来却无从答复。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:31 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

批准——这一刻之后,无人值守的匹配才变成要花钱的操作

Section titled “批准——这一刻之后,无人值守的匹配才变成要花钱的操作”
POSThttp://localhost:3000/api/subscriptions/pending/approve

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:888)的译文;原文以源码为准。

批准就是无人值守的匹配变成有人值守的花钱的时刻——在此之前不消耗任何下载额度。

部分成功会如实上报而不是整体回滚:有多个条目时,其中一个入队失败没有理由把其余的也一并撤销批准,调用方会被告知究竟哪些没能入队。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:32 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

忽略——把每个作品标记为已看过,后续检查就不会再问同样的问题

Section titled “忽略——把每个作品标记为已看过,后续检查就不会再问同样的问题”
POSThttp://localhost:3000/api/subscriptions/pending/dismiss

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:976)的译文;原文以源码为准。

忽略会把每个作品标记为已看过,因此后续检查不会再提出同样的问题。这是用户在回答「不」——与预留不同,后者是系统在报告它无法下载某个东西。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:33 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

POSThttp://localhost:3000/api/subscriptions/preview

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:740)的译文;原文以源码为准。

预览一个还不存在的订阅。

带 id 的路由无法承担这件事:没有记录可读。而恰恰是在创建一个订阅的时候,「这条规则实际会抓到什么」最重要——之后用户就已经把规则定下来了。草稿是按来源当前的状态求值的,无论结果如何都不会存储任何东西。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:36 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

在可能不同的条件下,重新评判一份已抓取的列表

Section titled “在可能不同的条件下,重新评判一份已抓取的列表”
POSThttp://localhost:3000/api/subscriptions/preview/judge

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:680)的译文;原文以源码为准。

在可能不同的条件下,重新评判一份已抓取的列表。

改一个条件并不会改变来源会返回什么——只有 criteria 影响请求——所以重新抓取纯属浪费、很慢,而且是对一个有限流的来源又多发一次请求。判断仍然发生在这里而不是浏览器里,因为条件树的第二份实现迟早会与真实的那份产生分歧。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:37 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

哪些来源可以支撑一个订阅,以及各自的间隔上下限——好让界面只提供合法选项

Section titled “哪些来源可以支撑一个订阅,以及各自的间隔上下限——好让界面只提供合法选项”
GEThttp://localhost:3000/api/subscriptions/sources

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:182)的译文;原文以源码为准。

哪些来源可以支撑一个订阅,以及各自的间隔上下限——好让界面只提供可行的来源,并在用户提交之前就显示这些上下限,而不是通过一次拒绝来教会用户规则。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:28 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

哪些订阅已经处理过某个作品(按其来源 URL 查)

Section titled “哪些订阅已经处理过某个作品(按其来源 URL 查)”
GEThttp://localhost:3000/api/subscriptions/tracking

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

下面这段是 handler 自己的文档注释(crates/lanrurugi-api/src/subscriptions/api.rs:551)的译文;原文以源码为准。

哪些订阅已经处理过某个作品(按其来源 URL 查)。

在删除档案之前询问,这样删除流程只会为「确实由某个订阅带进来」的档案提供「不要再让它回来」这个选项——对一个手动上传的文件提供该选项等于给了一个没有效果的开关,那比不给选项更糟。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/subscriptions/api.rs:51 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。