Merge pull request #9813 from mfo/US/api.document.email-usager

documentation(api): ou trouver l'email de l'usager qui dépose le dossier

app/graphql/schema.graphql

@@ -1423,6 +1423,10 @@ type Dossier {
   """
   state: DossierState!
   traitements: [Traitement!]!
+
+  """
+  Profile de l'usager déposant le dossier
+  """
   usager: Profile!
 }
 
@@ -3504,7 +3508,13 @@ type PoleEmploiChampDescriptor implements ChampDescriptor {
   type: TypeDeChamp! @deprecated(reason: "Utilisez le champ `__typename` à la place.")
 }
 
+"""
+Profil d'un usager connecté (déposant un dossier, instruisant un dossier...)
+"""
 type Profile {
+  """
+  Email de l'usager
+  """
   email: String!
   id: ID!
 }

app/graphql/types/dossier_type.rb

@@ -49,7 +49,7 @@ module Types
     field :geojson, Types::File, "L’URL du GeoJSON contenant les données cartographiques du dossier.", null: true
     field :attestation, Types::File, "L’URL de l’attestation au format PDF.", null: true
 
-    field :usager, Types::ProfileType, null: false
+    field :usager, Types::ProfileType, "Profile de l'usager déposant le dossier", null: false
     field :groupe_instructeur, Types::GroupeInstructeurType, null: false
     field :revision, Types::RevisionType, null: false, deprecation_reason: 'Utilisez le champ `demarche.revision` à la place.'
 

app/graphql/types/profile_type.rb

@@ -1,6 +1,8 @@
 module Types
   class ProfileType < Types::BaseObject
+    description "Profil d'un usager connecté (déposant un dossier, instruisant un dossier...)"
+
     global_id_field :id
-    field :email, String, null: false
+    field :email, String, "Email de l'usager", null: false
   end
 end