Reference to API documentation/help
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- api, documentation
Línea de trabajo
Revisa las directrices de API, el RFC 5988 citado y la referencia a Microsoft API Guidelines para determinar el cambio previsto en la documentación. Aclara cómo deben exponer los servicios la ayuda de recursos mediante un encabezado Link; después, actualiza el texto pertinente de las directrices y verifica que el ejemplo y las referencias sean correctos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
services SHOULD include a Link header (see RFC 5988) to point to documentation for the resource in question.
Link: <{help}>; rel="help"
RFC 5988:
Relation Name: help
Description: Refers to a resource offering help (more information, links to other sources information, etc.)
Reference: https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#744-options-and-link-headers
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 34
- Forks
- 10
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de bcgov/api-guidelines
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
bcgov/api-guidelines#34 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 25/100
bcgov/api-guidelines#33 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 55/100
bcgov/api-guidelines#32 ·
-
Devhub Issue: BC Government API Guidelines [API creation with the focus on security by design]Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
bcgov/api-guidelines#31 ·
-
It's Been a While Since This Repository has Been UpdatedQuizá libre de nuevo @jeff-card la tomó hace 1559 días y no hay ningún pull request abierto. Abierto
bcgov/api-guidelines#28 · 3 comentarios · 2 asignados ·
Todos los issues de bcgov/api-guidelines
Issues similares
-
state:triage-needed
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
fix(accounts): Balance Sheet and Profit and Loss crash on PostgreSQL due to MySQL force_indexAbierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 Medio día Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
puppe1990/amarra-cais#342 ·
Los mantenedores suelen responder en 1 día
-
Discord webhook notifications fail with HTTP 403 (Cloudflare blocks default urllib User-Agent)Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
tharje/spooler-v2#20 ·