Projet

Général

Profil

Amélioration #6571

Url des documents => ajout des éléments manquants et découpage en parties logiques

Ajouté par Matthieu Codron il y a plus de 2 ans. Mis à jour il y a plus de 2 ans.

Statut:
Intégré
Priorité:
Normal
Assigné à:
Version cible:
Début:
09/09/2016
Echéance:
% réalisé:

100%

Version source:
Solution proposée:

Après discussion voila les différentes parties d'url identifiés :

path :
initid, revisionId, viewId
documents/<initid>/revisions/<revisionId>/views/<viewId>.html

query :
=> customClientData => json_encode des customClientData

hash :
=> option du widget #widgetValue<jsonEncodedValue>

Ce qui donne en mode full cacahuète :

/api/v1/documents/1232/revisions/11/views/!defaultEdition.html?customClientData={"ChipsKiDance":true}#widgetValue{"noRouter":true}

/api/v1/documents/1232.html?customClientData={"ChipsKiDance":true}#widgetValue{"noRouter":true}

/api/v1/documents/1232/views/chipsKiChante.html#widgetValue{"noRouter":true}

/api/v1/documents/1232.html#widgetValue{"noRouter":true}

/api/v1/documents/1232.html

Principaux fichiers impactés:
Wiki Détail:
Contrôle:
Thèmes UIs:
Widget
Jalons: 3.2 R17, 3.2 R18

Description

Il doit être possible de récupérer l'url, avec les modalités suivantes :
  • format (html, json, autre)
  • canonique ? (si oui, c'est l'url de consultation, vue par défaut, sans customClientData ; si non, c'est l'url de la vue actuelle, comprenant la révision, les customClientData et autres inbformations permettant de récupérer un document avec le même rendu)
  • avec les valeurs ? (si oui, les valeurs en cours sont également transmises, permettant par exemple de réouvrir un formulaire de consultation dans un nouvel onglet et de conserver les valeurs qui avaient déjà été saisies)

Peut-être d'autres modalités sont-elles nécessaires également


Demandes liées

Bloque Document UIs - Amélioration #6577: Méthode de récupération/Génération des URL de document Fermé 13/09/2016

Historique

#1 Mis à jour par Matthieu Codron il y a plus de 2 ans

  • Sujet changé de Ajout d'une méthode permettant de récupérer l'url d'une ressource à Ajout d'une méthode permettant de récupérer l'url d'un document

#2 Mis à jour par Matthieu Codron il y a plus de 2 ans

  • Assigné à mis à Matthieu Codron

#3 Mis à jour par Charles Bonnissent il y a plus de 2 ans

Après discussion avec matthieu, les points suivants ressortent :

la partie path de l'url doit contenir les éléments suivants initid, revision => ces éléments permettent de pointer vers une ressource document précise sans ambiguïté
(on autorise aussi initid uniquement dans ce cas cela pointe vers la dernière révision valide)

les autres éléments à indiquer (vue, customClientData) sont des éléments permettant de modifier la représentation et le traitement du document, ces éléments ont du sens côté serveur mais ne modifie pas la ressource que l'on consulte et doivent donc se retrouver dans la partie query de l'url

les derniers éléments sont des instructions à donner au client pour personnaliser son fonctionnement, celle-ci passe donc dans la partie hash du document.

Cela donne donc les urls suivantes :

  • /api/v1/documents/TOTO.html
  • /api/v1/documents/TOTO/revision/12.html
  • /api/v1/documents/TOTO.html?viewId=!defaultEdition
  • /api/v1/documents/TOTO.html?viewId=!defaultEdition&customClientData={"superCustomClientData":["test": "tata]}#widgetElement:{"noRouter":true}

#4 Mis à jour par Charles Bonnissent il y a plus de 2 ans

  • Solution proposée mis à jour (diff)

#5 Mis à jour par Charles Bonnissent il y a plus de 2 ans

  • Solution proposée mis à jour (diff)

#6 Mis à jour par Charles Bonnissent il y a plus de 2 ans

  • Solution proposée mis à jour (diff)

#7 Mis à jour par Charles Bonnissent il y a plus de 2 ans

  • Solution proposée mis à jour (diff)

#8 Mis à jour par Charles Bonnissent il y a plus de 2 ans

  • Sujet changé de Ajout d'une méthode permettant de récupérer l'url d'un document à Url des documents => ajout des éléments manquant et découpage en partie

#9 Mis à jour par Charles Bonnissent il y a plus de 2 ans

  • Sujet changé de Url des documents => ajout des éléments manquant et découpage en partie à Url des documents => ajout des éléments manquants et découpage en parties logiques

#10 Mis à jour par Charles Bonnissent il y a plus de 2 ans

  • Bloque Amélioration #6577: Méthode de récupération/Génération des URL de document ajouté

#11 Mis à jour par Marc Claverie il y a plus de 2 ans

  • Version cible mis à 1.1.0

#12 Mis à jour par Matthieu Codron il y a plus de 2 ans

  • Assigné à Matthieu Codron supprimé

#13 Mis à jour par Éric Brison il y a plus de 2 ans

  • Assigné à mis à Éric Brison
  • Statut changé de Nouveau à Assigné

#14 Mis à jour par Éric Brison il y a plus de 2 ans

  • % réalisé changé de 0 à 100
  • Statut changé de Assigné à Intégré

Appliqué par commit commit:dynacase-document-uis|1f31ae068ca8a4d17ad82cdb6cc959c425f05654.

Formats disponibles : Atom PDF