OpenAPITools / OpenAPITools/openapi-diff

Add documentation for detectable breaking/non-breaking changes

Aperta
#138 1 commento 6 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Breaking/Non-Breaking classification enhancement
Lingua principale
Java
Stelle
1.1k
Fork
190
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

We are using this library to power a GitHub Action that generates a backward compatibility report between two versions of an OpenAPI spec. We love this library, but it is not clear what changes are detectable by this library, and what changes this library classifies as "breaking" or "non-breaking" changes. It would be really valuable to us if this repo could include a markdown file outlining all the OAS changes that this library can detect.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Non è indicato alcun file né test. Inizia esaminando il comportamento di confronto OpenAPI della libreria e facendo un inventario delle modifiche alla specifica che rileva e di come le classifica come breaking o non-breaking. Il lavoro è completato quando viene aggiunto un documento Markdown che descrive chiaramente le modifiche OAS rilevabili e le relative classificazioni.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.