ischema.md•2.89 kB
### ISchema
Um schema é uma estrutura de dados que define as características e propriedades de entidades relacionadas em um sistema. No contexto da plataforma, um schema é usado para definir a estrutura de times e entidades associadas.
**Características Principais:**
~~~csharp
namespace Api.DigitalPages.Interfaces.Models
{
public interface IEntitySchema : IBaseModelV3
{
/// <summary>
/// Nome do esquema
/// </summary>
string Name { get; set; }
/// <summary>
/// Informa se o esquema autoriza o auto registro de um usuário em uma entidade
/// </summary>
[Obsolete]
bool SelfRegister { get; set; }
/// <summary>
/// Limita a visibilidade do usuário quanto as entidades abaixo que ele tem acesso direto.
/// </summary>
int? LimitDepthInHierarchy { get; set; }
/// <summary>
/// Tags aplicadas ao schema (separada por ponto e virgula).
/// </summary>
List<ITag> Tags { get; set; }
/// <summary>
/// Tipo de estrutura.
/// </summary>
SchemaType Type { get; set; }
[Obsolete]
bool Public { get; set; }
/// <summary>
/// Propriedades existentes na entidade
/// </summary>
List<IEntityProperty> Properties { get; set; }
/// <summary>
/// Entidades cadastradas no esquema
/// </summary>
List<IEntityItem> Items { get; set; }
/// <summary>
/// Membros não aceitos pelo Schema.
/// </summary>
List<ObjectType> UnauthorizedMembersType { get; set; }
void AddProperty(string name, string regesValidation, DynamicPropertyType type);
}
public enum SchemaType
{
Category,
Security
}
}
~~~
**Flexibilidade das Entities:**
As entidades associadas a um schema podem variar em sua estrutura com base nas propriedades definidas no schema. Isso permite uma flexibilidade significativa na definição de diferentes tipos de entidades para diferentes contextos. Por exemplo, um schema pode ser usado para definir times, entidades de aprendizado, repositórios de arquivos, salas de chat, etc., cada um com suas próprias propriedades customizadas e comportamentos específicos.
**Serialização do modelo em JSON:**
```json
{
"uid": "7c1e35b6-7506-ef11-96f5-00224821b633",
"name": "Validação",
"type": "Security",
"public": false,
"created_at": "2024-04-29T22:13:31.9584793Z",
"updated_at": "2024-04-29T22:13:31.9575562Z",
"self_register": false,
"properties": [
{
"name": "Cor",
"type": "ColorHex",
"regex_validation": null
},
{
"name": "Valor",
"type": "NumberInteger",
"regex_validation": null
}
],
"tags": []
}
```