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

Document the locations on GET {component}/usage

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#265 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
79/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Área
documentation

Línea de trabajo

Lee la documentación de la API en content/4.api/ y busca la sección de componentes para GET {component}/usage. Documenta, según el issue, el campo locations específico de cada rol, los detalles de ubicación y representación, el orden, los límites, los recuentos exactos y el comportamiento de caché private, no-store. La tarea está terminada cuando la documentación del endpoint cubre cada comportamiento indicado y distingue la respuesta de admin de las respuestas sin locations.

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

Descripción

The bundle's GET {component}/usage now lists where a component is used, for admins (components-web-app/api-components-bundle#531, PR components-web-app/api-components-bundle#535). The module uses it for the "Shared · N places" badge and its list of places.

Please document, in the API section on components (content/4.api/):

  • The response keeps positionCount, pageDataCount and total, and adds locations for ROLE_ADMIN only. Anyone else who may read the component still gets the counts, without the locations key.
  • Each location is one counted use: componentPosition (a position IRI) or pageData + property (a page data property holding the component). A dynamic position whose fallback is the component is listed with pageDataProperty set. total - locations.length is the number of uses not listed.
  • layout is {iri, reference} for a use in a layout (directly or through components in the layout); renderedOn is then empty for the layout, since every page using it shows the component.
  • renderedOn lists each page or page data the use renders on: {iri, title, routePath}, where routePath is the route's own path without the import prefix, or null when unrouted. A template position renders on the template and every page data using it; a position inside a component renders wherever that component is placed, up the chain.
  • Order: layout uses first, then routed uses by route path, then unrouted uses by title. renderedOn is ordered by route path, then unrouted by title.
  • Caps: 50 locations and 20 renderedOn per location; total and renderedOnCount are exact.
  • The response is private, no-store: a shared cache never stores it, since nothing purges it when a placement changes.
Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Merge medio
1 h 20 min
PR fusionados (30 d)
1

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 components-web-app/docs

Todos los issues de components-web-app/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.