Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Accept the withheld-area code lists on UK local-area breakdown results before any executor sends them

未关闭 适合新手
#977 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@anth-volk 已经在做这个了。

开始于 2026年10月28日。

  • #976 来自 @anth-volk —— 未关闭

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
67/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
openapi, python
领域
api

调研方向

阅读 issue 引用的契约和 gateway golden OpenAPI,然后检查本地区域细分结果的序列化。将两个可选的 withheld-code 字段添加到契约和 OpenAPI 中。验证没有列表的结果会省略两个键,而空列表仍会保留。Issue 未指定测试或文件路径,因此根据契约定义定位相关的序列化测试。

由索引模型根据 Issue 内容生成。

描述

Part of #968.

Problem

#968 adds two optional fields to a UK local-area breakdown result (kind: local_areas): constituency_withheld_codes and local_authority_withheld_codes.

A push to main deploys the versioned executor before the stable gateway: in simulation-deploy.reusable.yml, deploy_gateway needs deploy_executor. The deployed gateway's contract rejects unknown keys. If one deploy both added the fields to the contract and had the executor fill them, the gateway would report every breakdown that finished between those two steps as failed.

What should happen

Deploy the change in two steps:

  1. The contract and the gateway accept the two fields, and no executor sends them. The executor redeployed in this step carries the new contract while the old gateway still serves, so a result that doesn't report the lists must leave both keys out of its JSON rather than write null.
  2. The executor fills them, in #975, once step 1 is deployed.

Done when

  • The contract has both optional fields, and the gateway's golden OpenAPI lists them.
  • A breakdown result without the lists dumps with the same keys as before.
  • An empty list ([]) is kept in the dump.
主要语言
Python
星标
1
派生
1
平均合并
1 天 19 小时
30 天内合并 PR
81

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

PolicyEngine/policyengine-sim-api 的其他 Issue

查看 PolicyEngine/policyengine-sim-api 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。