Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document or refactor nullable-but-required pattern for timestamp fields across all destination types

Aperta
  • Qualcosa non va?
#526 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Start with docs/apis/openapi.yaml and compare the destination schemas, beginning with the GCP Pub/Sub implementation referenced in the issue. Decide whether to document the required-but-nullable semantics or make the fields optional, then apply the chosen approach consistently across all destination types. Done means the schemas follow one clear, consistent approach.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Context

Multiple destination types have disabled_at and other timestamp fields marked as required but nullable in the OpenAPI specification.

Problem

This pattern is semantically confusing - "required but can be null" means "must be present but value can be null". While this is technically valid in OpenAPI, it can be unclear to API consumers and SDK users.

Current Behavior

This pattern is consistent across all destination types, which is correct behavior. The fields are present in responses but may have null values.

Options to Consider

  1. Document the pattern clearly - Add comments in the OpenAPI spec explaining why these fields use the nullable-but-required pattern
  2. Make fields optional - Remove from required array and handle absence vs null differently in the implementation
  3. Keep current pattern with schema documentation - Maintain current approach but add clear documentation explaining the semantics

Acceptance Criteria

  • Either document the nullable-but-required pattern clearly in the OpenAPI spec, OR
  • Refactor to use optional fields consistently across all destination type schemas
  • Ensure chosen approach is applied consistently across ALL destination types

Reference

Identified in code review of GCP Pub/Sub implementation. This is a systemic pattern that affects all destination types.

Related Files

  • docs/apis/openapi.yaml - All destination schemas
Lingua principale
Go
Stelle
1.1k
Fork
70
Merge medio
1g 18h
PR unite (30g)
56

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hookdeck/outpost

Tutte le issue di hookdeck/outpost

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.