Référence du Model

Tous les contrats, champs, variantes et valeurs du Model Surface.

Le Model décrit la structure, les données, les comportements et les interfaces d’une app Surface. Cette référence sert à vérifier une propriété précise, explorer une variante ou produire des sources avec un outil. Pour apprendre à composer une app, commencez par le guide des Models.

Comment lire la référence

Les tableaux distinguent le nom exact du champ, ses valeurs admises et son rôle. Les versions sont des discriminants de contrats : elles ne sont pas des paramètres métier à demander à l’usager. Le Studio et les outils d’auteur prennent en charge la structure technique; les intégrateurs utilisent cette référence pour les sources et les artefacts.

Structures validées

Types nommés et formats natifs

Utilisation avec l’AI

Chaque page possède une version Markdown et un bouton Copier. Le fichier /llms.txt répertorie les pages et leurs adresses. Fournissez à l’AI les sections concernées par votre changement, puis faites valider le Model complet avant publication.

Exemples appliqués : Lire un profil et une vue complets

Comparez les propriétés aux contrats référencés avant d’insérer chaque fragment dans le Model.

Configuration

Fragment à placer dans presentation.recordProfiles[]. Propriétés et valeurs admises.

{
  "key": "client",
  "definitionPaths": [
    "workspace/clients/surface/client"
  ],
  "editActionKey": "edit-client",
  "identity": {
    "title": {
      "kind": "field",
      "fieldPath": "fields/company"
    },
    "avatar": {
      "kind": "initials",
      "maximumLetters": 2
    },
    "subtitle": {
      "kind": "field",
      "fieldPath": "fields/status"
    }
  },
  "valueLabels": [
    {
      "fieldPath": "fields/status",
      "values": [
        {
          "value": "prospect",
          "label": "Prospect"
        },
        {
          "value": "active",
          "label": "Actif"
        }
      ]
    }
  ],
  "card": {
    "summary": {
      "kind": "field",
      "fieldPath": "fields/notes"
    },
    "tags": {
      "namespace": "user",
      "maximumVisible": 3
    },
    "metricKeys": [],
    "openLabel": "Ouvrir le client"
  },
  "queryBindings": [],
  "metrics": [],
  "detail": {
    "primaryActionKey": null,
    "creationActionKeys": [],
    "actionKeys": [],
    "sections": [
      {
        "kind": "fields",
        "key": "follow-up",
        "label": "Suivi du client",
        "fieldPaths": [
          "fields/notes",
          "fields/status"
        ]
      }
    ],
    "settings": {
      "fieldPaths": [
        "fields/email"
      ]
    },
    "tags": {
      "namespace": "user",
      "maximumVisible": 3
    },
    "relatedGroups": [],
    "primaryActionLabel": null
  }
}

Variante et raccordement

Fragment à placer dans presentation.tableViews[]. Propriétés et valeurs admises.

{
  "viewKey": "quotes-table",
  "columns": [
    {
      "key": "number",
      "label": "Numéro",
      "source": {
        "kind": "native",
        "property": "title"
      }
    },
    {
      "key": "status",
      "label": "État",
      "source": {
        "kind": "field",
        "fieldPath": "fields/status"
      }
    },
    {
      "key": "amount",
      "label": "Montant",
      "source": {
        "kind": "field",
        "fieldPath": "fields/amount"
      }
    }
  ],
  "openLabel": "Ouvrir la soumission"
}

Exemple de disposition UI

La disposition illustrative ci-dessous situe cette configuration dans l’app Clients/Soumissions. Chaque fragment s’insère à l’emplacement indiqué; ses références aux Fields, Queries et Actions correspondent aux déclarations du Model.

Propriété
Valeur
Référence
Validation

DISPOSITION ILLUSTRATIVEApp Clients / Soumissions

Référence du ModelLire un profil et une vue complets

Clients

CONTEXTE DU MODELAtelier NordConfiguration déclarative

key: client
definitionPaths: 1 élément
editActionKey: edit-client
identity: Objet déclaré
valueLabels: 1 élément

Les valeurs ci-dessus reprennent le fragment de configuration; les références se résolvent dans le Model complet.