Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#977 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@anth-volk ya está trabajando en esto.

Desde el 28/10/2026.

  • #976 de @anth-volk — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
67/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
openapi, python
Área
api

Línea de trabajo

Lee el contrato y la especificación OpenAPI dorada de gateway a los que hace referencia la incidencia y, después, inspecciona la serialización del resultado del desglose por área local. Añade al contrato y a OpenAPI los dos campos opcionales de códigos retenidos. Verifica que los resultados sin listas omitan ambas claves, mientras que las listas vacías sigan presentes. La incidencia no indica pruebas ni rutas de archivos, así que localiza las pruebas de serialización pertinentes a partir de las definiciones del contrato.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
1 d 15 h
PR fusionados (30 d)
78

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PolicyEngine/policyengine-sim-api

Todos los issues de PolicyEngine/policyengine-sim-api

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.