Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[REST] avatar_url examples are misleading

Abierto
#3,259 11 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
github, json, openapi
Área
api, documentation

Línea de trabajo

Comienza con el artículo enlazado sobre commits/estados de REST y busca en este repositorio su código fuente y la respuesta de ejemplo que contiene avatar_url. Comprueba los ejemplos renderizados y los campos de estado relacionados; se considera terminado cuando los ejemplos ya no usan URL de avatar 404 engañosas y representan claramente la información de estado solicitada.

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

Descripción

content feature rest-schema
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28

What part(s) of the article would you like to see updated?

The example responses have things like:

  {
    "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "avatar_url": "https://github.com/images/error/hubot_happy.gif",
    "id": 1,
    "node_id": "MDY6U3RhdHVzMQ==",
    "state": "success",
    "description": "Build has completed successfully",
    "target_url": "https://ci.example.com/1000/output",
    "context": "continuous-integration/jenkins",
    "created_at": "2012-07-20T01:19:13Z",
    "updated_at": "2012-07-20T01:19:13Z",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",

Note that both avatar_urls are 404:

This doesn't seem to match the real world, and since I'm looking for the word error, it's really confusing/misleading.

Checking https://api.github.com/users/octocat, it appears it's more likely that it should be something like:

{
  "login": "octocat",
  "id": 583231,
  "node_id": "MDQ6VXNlcjU4MzIzMQ==",
  "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",

I can't tell if that's the avatar_url I should see in both places or if they're very different things.

Additional information

I'm trying to get information on error, failure, pending, or success, so I'm looking for those in the output of responses...

Note that the use of a lot of "id": 1, for things that might be different is very counter-productive.

It'd be really nice if the sample output covered each of the status states instead of just one.

Lenguaje dominante
Sin datos de lenguaje
Estrellas
1.6k
Forks
342
Merge medio
2 h 23 min
PR fusionados (30 d)
57

Guía de contribución

Abrir la guía de contribución

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 github/rest-api-description

Todos los issues de github/rest-api-description

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.