Merge pull request #8788 from demarches-simplifiees/8787-add-doc-to-graphql-fields

ameliore la documentation de certains champs graphql

app/graphql/schema.graphql

@@ -910,6 +910,9 @@ Ceci est une version abrégée du type `Demarche`, qui n’expose que les métad
 Cela évite l’accès récursif aux dossiers.
 """
 type DemarcheDescriptor {
+  """
+  URL du cadre juridique qui justifie le droit de collecter les données demandées dans la démarche
+  """
   cadreJuridiqueUrl: String
 
   """
@@ -941,13 +944,25 @@ type DemarcheDescriptor {
   Pour une démarche déclarative, état cible des dossiers à valider automatiquement
   """
   declarative: DossierDeclarativeState
+
+  """
+  fichier contenant le cadre juridique
+  """
   deliberation: File
+
+  """
+  URL pour commencer la démarche
+  """
   demarcheUrl: String
 
   """
   Description de la démarche.
   """
   description: String!
+
+  """
+  URL ou email pour contacter le Délégué à la Protection des Données (DPO)
+  """
   dpoUrl: String
 
   """
@@ -956,6 +971,10 @@ type DemarcheDescriptor {
   dureeConservationDossiers: Int!
   id: ID!
   logo: File
+
+  """
+  notice explicative de la démarche
+  """
   notice: File
   noticeUrl: String
 
@@ -966,18 +985,30 @@ type DemarcheDescriptor {
   opendata: Boolean!
   revision: Revision!
   service: Service
+
+  """
+  URL où les usagers trouvent le lien vers la démarche
+  """
   siteWebUrl: String
 
   """
   État de la démarche.
   """
   state: DemarcheState!
+
+  """
+  mots ou expressions attribués à la démarche pour décrire son contenu et la retrouver
+  """
   tags: [String!]!
 
   """
   Titre de la démarche.
   """
   title: String!
+
+  """
+  ministère(s) ou collectivité(s) qui mettent en oeuvre la démarche
+  """
   zones: [String!]!
 }
 
@@ -3333,9 +3364,25 @@ type SelectionUtilisateur implements GeoArea {
 
 type Service {
   id: ID!
+
+  """
+  nom du service qui met en oeuvre la démarche
+  """
   nom: String!
+
+  """
+  nom de l'organisme qui met en oeuvre la démarche
+  """
   organisme: String!
+
+  """
+  n° siret du service qui met en oeuvre la démarche
+  """
   siret: String
+
+  """
+  type d'organisme qui met en oeuvre la démarche
+  """
   typeOrganisme: TypeOrganisme!
 }
 

app/graphql/types/demarche_descriptor_type.rb

@@ -25,24 +25,24 @@ Cela évite l’accès récursif aux dossiers."
 
     field :duree_conservation_dossiers, Int, "Durée de conservation des dossiers en mois.", null: false
 
-    field :demarche_url, String, null: true
-    field :site_web_url, String, null: true
-    field :dpo_url, String, null: true
+    field :demarche_url, String, "URL pour commencer la démarche", null: true
+    field :site_web_url, String, "URL où les usagers trouvent le lien vers la démarche", null: true
+    field :dpo_url, String, "URL ou email pour contacter le Délégué à la Protection des Données (DPO)", null: true
     field :notice_url, String, null: true
-    field :cadre_juridique_url, String, null: true
+    field :cadre_juridique_url, String, "URL du cadre juridique qui justifie le droit de collecter les données demandées dans la démarche", null: true
 
     field :opendata, Boolean, null: false
-    field :tags, [String], null: false
-    field :zones, [String], null: false
+    field :tags, [String], "mots ou expressions attribués à la démarche pour décrire son contenu et la retrouver", null: false
+    field :zones, [String], "ministère(s) ou collectivité(s) qui mettent en oeuvre la démarche", null: false
 
     field :revision, Types::RevisionType, null: false
     field :service, Types::ServiceType, null: true
 
     field :logo, Types::File, null: true, extensions: [{ Extensions::Attachment => { root: :procedure } }]
-    field :notice, Types::File, null: true, extensions: [{ Extensions::Attachment => { root: :procedure } }]
-    field :deliberation, Types::File, null: true, extensions: [{ Extensions::Attachment => { root: :procedure } }]
+    field :notice, Types::File, "notice explicative de la démarche", null: true, extensions: [{ Extensions::Attachment => { root: :procedure } }]
+    field :deliberation, Types::File, "fichier contenant le cadre juridique", null: true, extensions: [{ Extensions::Attachment => { root: :procedure } }]
 
-    field :dossiers_count, Int, null: false, internal: true
+    field :dossiers_count, Int, "nb de dossiers déposés", null: false, internal: true
 
     def service
       Loaders::Record.for(Service).load(procedure.service_id)

app/graphql/types/service_type.rb

@@ -8,9 +8,9 @@ module Types
 
     global_id_field :id
 
-    field :nom, String, null: false
-    field :type_organisme, TypeOrganisme, null: false
-    field :organisme, String, null: false
-    field :siret, String, null: true
+    field :nom, String, "nom du service qui met en oeuvre la démarche", null: false
+    field :type_organisme, TypeOrganisme, "type d'organisme qui met en oeuvre la démarche", null: false
+    field :organisme, String, "nom de l'organisme qui met en oeuvre la démarche", null: false
+    field :siret, String, "n° siret du service qui met en oeuvre la démarche", null: true
   end
 end