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

EPIC slug aggregator

Abierto
  • ¿Algo no está bien?
#151 7 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
api, backend, databases

Línea de trabajo

Comienza siguiendo las rutas de solicitud documentadas /v1/id/slug y /since/slug, y después revisa el manejo de CREATE POST y de las actualizaciones para la cabecera slug y la cadena de consulta ?slug=. Usa las reglas indicadas de normalización, propiedad, unicidad, longitud y versionado como criterios de aceptación, incluida la distinción entre las búsquedas por slug y por _id.

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

Descripción

We've got some light slug functionality, but we need it to work all the time. Here's what they do...

9.7. The Slug Header link

Slug is an HTTP entity-header whose presence in a POST to a Collection constitutes a request by the client to use the header’s value as part of any URIs that would normally be used to retrieve the to-be-created Entry or Media Resources.

Servers MAY use the value of the Slug header when creating the Member URI of the newly created Resource, for instance, by using some or all of the words in the value for the last URI segment.

In addition to the "get by _id" lookup for documents, a request like "https://store.rerum.io/v1/id/slug-life" should return the document matching { "__rerum.slug" : "slug-life" } in the repository.

An application suggests a slug by passing in a slug header in the CREATE POST or by adding a "?slug=" query string. If both exist, the header is used as the server will ignore query strings.

RERUM saves a new object with the __rerum.slug property and separate generated _id. RERUM responds with the normalized slug in the @id field of the response object.

In an update, a document owner can move the slug to a new version, prompting RERUM to update the __rerum.slug properties for both records.

API behaviors will be listed below as they may each interreact differently. Slug conditions in all cases are clear:

  1. Only one document can hold a slug at any time.
  2. Only the owner can move slug from one document to another.
  3. Slugs are entirely lowercase, with accented characters replaced by letters from the English alphabet and whitespace characters replaced by a dash or an underscore, in order to avoid being encoded. Punctuation marks are generally removed.
    • This, That & the Other! Various Outré Considerations <= input
    • this-that-the-other-various-outre-considerations <= stored slug
  4. Slugs are trimmed to 50 characters.
  5. A document may only have one slug assigned to it at a time.
  6. Slugs are helpful and efficient, but not a promise of durability, so the _id must be used in all versioning.
    • A "/since/slug" request with a slug is not idempotent, because the slug may have moved, but "since/_id" is.
    • An "/id/slug" request may not always return the same document and may go 404, which a deleted document does not.
Lenguaje dominante
JavaScript
Estrellas
3
Forks
6
Merge medio
3 d 16 h
PR fusionados (30 d)
6

Preparar el entorno

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 CenterForDigitalHumanities/rerum_server_nodejs

Todos los issues de CenterForDigitalHumanities/rerum_server_nodejs

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.