I8.2 · Watch SendGrid

Aperta
#52 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
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go, openapi
Ambito
api, backend

Direzione di ricerca

Start with CONTRIBUTING.md and the existing provider plugins to learn the catalog format, golden tests, and provider page template. Verify SendGrid’s official sources and versioning scheme, recording a check date and leaving unknown details as TBD. Add source catalog entries, fixtures including one historical breaking change, providers/sendgrid.md, and the docs/plugins.md row; done means the acceptance criteria pass and the client fix needed is documented.

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

Descrizione

good first issue story

Part of https://github.com/patch-it-dev/patch-it-plugins/issues/11

Story

As a developer whose code calls SendGrid, I want patch-it to know when SendGrid breaks, deprecates or retires something, so I get the fix before production does.

Subtasks

  • Find SendGrid's sources and record them with the date checked (verify, don't guess; leave TBD if unknown):
    • deprecations / sunset page
    • API changelog (RSS / Atom if there is one)
    • OpenAPI spec, if published
    • official SDKs and their release notes / changelogs (Python and JS first)
    • API versioning scheme (date-based, path, header, none)
  • Pick the format plugin for each source (OpenAPI, RSS, GitHub Releases, changelog file, registry, prose) and add catalog lines
  • Golden test: a saved copy of each source in, the expected events out
  • One real historical breaking change as a replay fixture
  • Provider page providers/sendgrid.md from the template
  • Add or update its row in docs/plugins.md (see CONTRIBUTING.md)
  • Note what the client needs to fix it (existing handler, or a new fix kind in the client)

Acceptance criteria

  • Daily ingest emits SendGrid events, each with source_url and an exact source_excerpt
  • The replayed historical change produces the right events
  • The provider page lists every source with its date checked
Lingua principale
Go
Stelle
0
Fork
0
Merge medio
2h 59m
PR unite (30g)
17

Preparare l'ambiente

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 patch-it-dev/patch-it-plugins

Tutte le issue di patch-it-dev/patch-it-plugins

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.