Package org.praxisplatform.uischema.annotation

Annotation Interface UiSurface

@Target(METHOD) @Retention(RUNTIME) public @interface UiSurface
Marca uma operacao HTTP real como surface semantica de UI.

A anotacao nao define schema inline nem substitui o contrato OpenAPI da operacao. Ela apenas atribui metadados semanticos para discovery, sempre apontando para uma operacao canonicamente documentada e para o schema resolvivel via /schemas/filtered.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    id
    Identificador local da surface dentro do recurso.
    SurfaceKind
    kind
    Tipo semantico da surface.
    SurfaceScope
    scope
    Escopo da surface.
    String
    title
    Titulo principal consumido pela UX e por clientes documentais.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    allowedStates
    Estados canonicos do recurso em que a surface pode ficar disponivel.
    String
    description
    Descricao opcional da surface.
    String
    intent
    Intencao semantica adicional da surface.
    int
    order
    Ordem estavel para renderizacao/listagem.
    String[]
    requiredAuthorities
    Authorities/roles canonicamente exigidas para a surface.
    String[]
    tags
    Tags opcionais de organizacao semantica.

  • Element Details

    • id

      String id
      Identificador local da surface dentro do recurso.

    • kind

      SurfaceKind kind
      Tipo semantico da surface.

    • scope

      SurfaceScope scope
      Escopo da surface.

    • title

      String title
      Titulo principal consumido pela UX e por clientes documentais.

    • description

      String description
      Descricao opcional da surface.
      Default:
      ""

    • intent

      String intent
      Intencao semantica adicional da surface. Quando omitida, o runtime usa id().
      Default:
      ""

    • order

      int order
      Ordem estavel para renderizacao/listagem.
      Default:
      0

    • requiredAuthorities

      String[] requiredAuthorities
      Authorities/roles canonicamente exigidas para a surface.

      O starter nao impoe framework de seguranca especifico. Quando um principal com authorities estiver disponivel no runtime, a avaliacao de availability pode bloquear a surface se alguma authority declarada estiver ausente.

      Default:
      {}

    • allowedStates

      String[] allowedStates
      Estados canonicos do recurso em que a surface pode ficar disponivel.

      A avaliacao usa um ResourceStateSnapshotProvider plugavel para resolver o estado do recurso uma vez por request item-level, sem custo N+1 por surface.

      Default:
      {}

    • tags

      String[] tags
      Tags opcionais de organizacao semantica.
      Default:
      {}