Implement the GSA API Standards

Aperta
#24 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia esaminando gli endpoint esistenti dell’Auctions API e i GSA API Standards collegati, in particolare i requisiti OpenAPI. Il lavoro è completato quando viene aggiunto un file di specifica OpenAPI che descrive l’API pubblica attuale e soddisfa gli standard applicabili.

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

Descrizione

In November 2018, the GSA CTO and CIO directed all API programs at GSA to implement the GSA API Standards (details here). All current APIs at the agency have a deadline of Dec. 31, 2019 to do this.

This issue is to track the Auctions API's adoption of the Standards.

  • Add Your API To The GSA API Directory
  • Use The api.data.gov Service
  • Provide Support For Versioning
  • Provide Public Documentation
  • Provide A Feedback Mechanism That Is Clear and Monitored
  • Provide An OpenAPI Specification File
Lingua principale
JavaScript
Stelle
3
Fork
5
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

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 GSA/auctions_api

Tutte le issue di GSA/auctions_api

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.