Estoy utilizando la API de Discourse para extraer publicaciones de un foro. Necesito ayuda para comprender el significado de los campos que devuelve la API. Por ejemplo, el campo post_type en cada post es un número. ¿Cuáles son los valores válidos y qué significan? De manera similar, el id bajo actions_summary es un número. Hay otros campos como reads, score, etc., sobre los cuales no tengo claridad. ¿Alguna indicación sobre dónde puedo obtener esta información? ¡Gracias!
1 me gusta
Si tienes instalado el plugin Data Explorer en tu sitio, puedes obtener detalles sobre los códigos numéricos utilizados pasando el cursor sobre las entradas:
Por ejemplo, al pasar el cursor sobre el campo post_type de posts se muestran los siguientes valores:
- regular: 1
- acción de moderador: 2
- acción pequeña: 3
- susurro: 4
Aparte de Data Explorer, el único lugar que conozco donde encontrar esta información es en el código de Discourse. Por ejemplo, para encontrar el significado de cada action_type de la tabla user_actions, ingresa UserAction.types en la consola de Rails. Esto devuelve los siguientes valores:
{:like=>1, :was_liked=>2, :bookmark=>3, :new_topic=>4, :reply=>5, :response=>6, :mention=>7, :quote=>9, :edit=>11, :new_private_message=>12, :got_private_message=>13, :solved=>15, :assigned=>16}
3 Me gusta
¡Gracias @simon! Esta es una forma interesante de obtener esta información. Realicé algunas investigaciones basadas en tus sugerencias y encontré este fragmento de código para user_actions, pero no pude encontrar nada similar para post_type después de una búsqueda considerable. Esperaba que cada campo devuelto por la API estuviera documentado en algún lugar, al menos para los campos importantes que tienen una semántica significativa.
Eso es comprensible. Sin embargo, existe un código similar. Está aquí: discourse/app/models/post.rb at main · discourse/discourse · GitHub. La estructura de la base de datos de Discourse es muy consistente. Esperemos que esto ayude a compensar la falta de documentación.
No estoy seguro de que cada campo devuelto por la API llegue a estar documentado, pero parece importante documentar los diversos lugares donde se devuelven códigos numéricos. Ejemplos de esto son:
Post.typesUserAction.typesNotification.typesNotificationLevels.allUserOption.email_level_types
Si procedemos con esto, no estoy seguro de cuál sería el mejor lugar para la documentación. Posiblemente en https://docs.discourse.org/, pero es posible que surjan problemas técnicos al hacerlo.
3 Me gusta
¡Gracias @simon! Sí, incluir los nombres en inglés y las descripciones de una línea para los códigos numéricos sería muy útil. ¿Hay algún lugar donde pueda solicitar esto?
1 me gusta
Estoy de acuerdo en que estos campos necesitan ser documentados. Me asignaré este tema y me aseguraré de que se realice.
3 Me gusta