Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

EPIC slug aggregator

Aperta
  • Qualcosa non va?
#151 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
api, backend, databases

Direzione di ricerca

Inizia tracciando i percorsi delle richieste documentati /v1/id/slug e /since/slug, quindi esamina la gestione di CREATE POST e degli aggiornamenti per l’header slug e la stringa di query ?slug=. Usa le regole indicate di normalizzazione, ownership, unicità, lunghezza e versioning come criteri di accettazione, inclusa la distinzione tra le ricerche per slug e per _id.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
JavaScript
Stelle
3
Fork
6
Merge medio
3g 16h
PR unite (30g)
6

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CenterForDigitalHumanities/rerum_server_nodejs

Tutte le issue di CenterForDigitalHumanities/rerum_server_nodejs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.