Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#977 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@anth-volk arbeitet bereits daran.

Seit 28.10.2026.

  • #976 von @anth-volk — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
67/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
openapi, python
Bereich
api

Rechercherichtung

Lies den Vertrag und die Gateway-Golden-OpenAPI-Spezifikation, auf die im Issue verwiesen wird, und untersuche anschließend die Serialisierung des Ergebnisses der Aufschlüsselung nach lokalen Gebieten. Füge dem Vertrag und der OpenAPI-Spezifikation die beiden optionalen Felder für zurückgehaltene Codes hinzu. Stelle sicher, dass Ergebnisse ohne Listen beide Schlüssel auslassen, während leere Listen weiterhin enthalten sind. Im Issue werden weder Tests noch Dateipfade genannt. Ermittle daher anhand der Vertragsdefinitionen die relevanten Serialisierungstests.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.
Vorherrschende Sprache
Python
Sterne
1
Forks
1
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
77

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus PolicyEngine/policyengine-sim-api

Alle Issues in PolicyEngine/policyengine-sim-api

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.