Implement the GSA API Standards

Abierto
#24 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
api

Línea de trabajo

Empieza revisando los endpoints existentes de la Auctions API y los GSA API Standards enlazados, especialmente los requisitos de OpenAPI. Se considera completado cuando se haya añadido un archivo de especificación de OpenAPI que describa la API pública actual y cumpla los estándares aplicables.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
JavaScript
Estrellas
3
Forks
5
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de GSA/auctions_api

Todos los issues de GSA/auctions_api

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.