View

À venir

Fonctionnalité en préparation. Cette page décrit l'interface cible pour recueillir vos retours ; rien n'est encore utilisable.

Les API générées sont en préparation : ce manifeste n'est pas encore accepté par sng apply.

apiVersion	apibuilder.stackngo.io/v1alpha1
kind	View
Appliqué par	sng apply (à venir)

À quoi ça sert

Une View expose un Model sur un chemin HTTP, en lecture (get) et/ou en écriture (post), au format JSON, texte ou fichier.

Rattachement à une API

Un Model ou une View se rattache à sa GeneratedAPI par spec.application, qui porte le nom de la GeneratedAPI du même tenant (application: blog). Sans spec.application, une ressource n'est retenue que par une GeneratedAPI qui la choisit par ses labels (selector).

Exemple minimal

apiVersion: apibuilder.stackngo.io/v1alpha1
kind: View
metadata:
  name: posts-json
spec:
  application: blog
  path: /posts
  model: posts
  get:
    application: json

Exemple complet commenté

apiVersion: apibuilder.stackngo.io/v1alpha1
kind: View
metadata:
  name: posts-json
spec:
  application: blog              # nom de la GeneratedAPI qui sert cette vue
  path: /posts                   # obligatoire
  model: posts                   # obligatoire : modelName d'un Model rattaché
  get:
    application: json            # json | text | file
  post:
    application: json

Champs

View

View déclare une route HTTP de votre API générée.

Champ	Description	Défaut	Validation
apiVersion string	apibuilder.stackngo.io/v1alpha1
kind string	View
metadata ObjectMeta	Seul metadata.name est à renseigner (nom de la ressource dans votre tenant).
spec ViewSpec
status ViewStatus

ViewSpec

ViewSpec décrit le chemin, le modèle servi et les méthodes HTTP acceptées.

Champ	Description	Défaut	Validation
application string	Application est le nom de l'API générée (GeneratedAPI) du même tenant qui utilise cette vue.		MaxLength: 253 Optional: {}
path string	Path est le chemin de la route (ex. "/posts", "/api/users").
model string	Model est le nom du modèle servi par la route (ModelName du Model).
get ViewVerb	Get active la méthode GET (facultatif).
post ViewVerb	Post active la méthode POST (facultatif).

ViewStatus

ViewStatus est l'état constaté par la plateforme.

Champ	Description	Défaut	Validation
observedGeneration integer	ObservedGeneration est la dernière version du manifeste prise en compte.

ViewVerb

ViewVerb règle une méthode HTTP de la route.

Champ	Description	Défaut	Validation
application string	Application est le format de la réponse : json, text ou file.

Statut et conditions

status.observedGeneration indique la dernière version prise en compte. Deux vues sur le même chemin font échouer la fusion sur la GeneratedAPI.

Ce qui se passe à l'application

Modifier une View regénère l'API qui la rattache.

Voir aussi

• GeneratedAPI, Model
• Manifestes : index