Upgrade uw inhoudsfragmenten voor UUID-verwijzingen

Laatst bijgewerkt: 22 november 2024

Gemaakt voor:

  • Beheerder
  • Ontwikkelaar
IMPORTANT
Verschillende functies van de GraphQL API voor gebruik met inhoudsfragmenten zijn beschikbaar via het programma Vroege adopter.
Om de status te zien, en hoe te om toe te passen als u geinteresseerd bent, controleer de Nota's van de Versie.

Om de stabiliteit van uw filters van GraphQL te optimaliseren, kunt u de inhoud en fragmentverwijzingen in uw Inhoudsfragmenten bevorderen zodat zij universeel unieke herkenningstekens (UUID) gebruiken.

Oorspronkelijk verstrekten de Modellen van het Fragment van de Inhoud de gegevenstypes van Verwijzing van de Inhoud en Verwijzing van het Fragment. Beide verwijzingen gebruiken een weg om aan het referenced middel te richten, en deze weg kan verouderd worden als het middel wordt bewogen. Hoewel dergelijke verwijzingen in de meeste scenario's meer dan toereikend zijn, zijn de Modellen van het Fragment van de Inhoud uitgebreid om verwijzingen ook te verstrekken die op UUID worden gebaseerd:

  • Verwijzing van de Inhoud (UUID)
  • Verwijzing van het Fragment (UUID).

Deze nieuwe referentietypen kunnen zowel in nieuwe modellen en fragmenten van het Fragment van de Inhoud worden gebruikt als bestaande instanties uitbreiden.

Als u bestaande inhoudsfragmenten en -modellen wilt bijwerken, kunt u de hier beschreven procedure uitvoeren.

CAUTION
Alvorens de verbeteringsprocedure in werking te stellen zou u een droge looppasaltijd moeten uitvoeren om het even welke potentiële kwesties met uw inhoud te benadrukken.

Wat is bijgewerkt

De volgende updates worden uitgevoerd:

  • Velden van de gegevenstypen:

    • Verwijzing van de Inhoud wordt omgezet in Verwijzing van de Inhoud (UUID)
    • Verwijzing van het fragment wordt omgezet in Verwijzing van het Fragment (UUID)

  • De waarden van de op paden gebaseerde verwijzingen in deze velden worden vervangen door de overeenkomstige UUID's

NOTE
Na de verbetering zijn beide Types van Gegevens nog beschikbaar in de Modelredacteur van het Fragment van de Inhoud. U kunt nieuwe velden maken op basis van beide typen (hoewel u de op UUID gebaseerde typen zult gebruiken) en de upgrade indien nodig opnieuw uitvoeren.

Wat NIET is bijgewerkt

De volgende referenties worden niet bijgewerkt:

  • Paginaverwijzingen - UUID's worden nog niet ondersteund

  • Ongeldige verwijzingen, bijvoorbeeld wanneer het doel van het pad van het inhoudsfragment of het middelenpad niet bestaat

    • Ongeldige verwijzingen worden niet bijgewerkt, alsof het pad van het inhoudsfragment of het middelenpad ongeldig is. Er is geen overeenkomstige UUID die moet worden toegewezen. De oorspronkelijke verwijzing blijft ongewijzigd.

    • Gebruik a droge looppasom het even welke ongeldige verwijzingen te ontmoedigen.

    NOTE
    Als ongeldig, zijn zij niet bruikbaar, ongeacht de verbetering.

Wanneer u geen upgrade moet uitvoeren

Geen upgrade uitvoeren:

  • Wanneer een van uw inhoudsfragmenten paginaverwijzingen gebruikt; aangezien UUID's nog niet worden ondersteund voor paginaverwijzingen

Beperkingen van UUID-verwijzingen

Momenteel zijn de volgende beperkingen van toepassing wanneer het gebruiken van verwijzingen die op een UUID worden gebaseerd:

  • Modellen

    • Nieuwe Content Fragment-modellen met UUID-velden voor inhoudsfragment of UUID-velden voor inhoudsverwijzing kunnen niet worden gemaakt met OpenAPI.
    • Het veld id voor modellen is niet gewijzigd in UUID-gebaseerd. Het gebruikt base64 gedecodeerde weg van het model. Modellen kunnen niet worden verplaatst, zodat deze waarde nog steeds stabiel is.

  • Assets

    • Wanneer u een inhoudsfragment maakt via OpenAPI, moeten fragment-reference - of content-reference -veldtypen worden gebruikt voor het opgeven van verwijzingen naar respectievelijk een fragment of element, zelfs wanneer u de waarde van een verwijzingsveld op basis van UUID instelt.

Upgradeplanning

Er zijn een paar voorbereidingsstappen voordat u de upgrade uitvoert.

Een droge run uitvoeren

Het wordt geadviseerd dat elke tijd u uw inhoud bevordert, u eerst een droge looppas uitvoert. Hiermee worden logbestanden gemaakt met items die mogelijke problemen aangeven:

  • Ongeldige verwijzingen
  • Paginaverwijzingen

Voer de upgrade van de inhoud in de modus dryRun uit naar:

  • eventuele ongeldige verwijzingen identificeren; door deze weer te geven in de logbestanden
    U kunt deze verwijzingen vervolgens corrigeren voordat u de daadwerkelijke upgrade van de inhoud uitvoert.
  • alle paginaverwijzingen identificeren; door deze weer te geven in de logbestanden
    Wanneer de paginaverwijzingen worden ontdekt zou u niet de inhoudsverbeteringin werking moeten stellen.