This release is a pre-release and may not be stable for production use.
Neon Data Models
This repository contains Pydantic models and JSON schemas for common data
structures. The models module contains Pydantic models, organized by application.
Configuration
To allow passing or handling parameters that are not explicitly defined in the
models provided by this package, the NEON_DATA_MODELS_ALLOW_EXTRA envvar may
be set to true. This is generally not necessary and helps to prevent sending
extraneous data, but may help in cases where the server and client are using
different revisions of this package.
Organization
Models are broadly organized into the following categories.
API
These schemas are used in API requests and responses. They are grouped by the applicable API (node, HANA, mq). Use these schemas for sending requests and parsing responses.
Client
These schemas are specific to client applications (i.e. Nodes). Use these schemas for client-specific configuration.
User
These schemas define user-specific data structures. Use these schemas for user-specific configuration.
Messagebus
These schemas define messages sent on the messagebus. Historically, messagebus events have not used any validation, so there is greater risk of Message objects failing validation than other schemas defined here.
Access Roles
This module defines AccessRoles for use with Role-Based Access Control (RBAC).
The AccessRoles enum defines some specific roles and is structured such that
roles correspond to an integer value in the range of -inf-50.
Roles are structured such that 0 corresponds to no permissions and 50 is
reserved for unlimited permissions. A role will always include the permissions
available to any role with a smaller positive number. For example, an ADMIN
role with a value of 30 will have access to everything a USER with value 20
does, and possibly more.
A role is defined per service, so a user may have greater access to some resources than others. For example, a user may have unlimited access to manage LLM deployments, but only read access to the DIANA backend.
Service Roles
Roles with a value <0 are intended for use by non-user service accounts. These roles contain specific access that is limited to the requirements of a specific program or service.
For example, the AccessRoles.NODE role is used by a node device making
API requests.
Guest Role
The AccessRoles.GUEST role is used by a guest user, which is usually implemented
as a single account with public credentials.
User Role
The AccessRoles.USER role is used by a registered user. It should NOT be
assumed that a registered user has been verified or validated in any way.
Admin Role
The AccessRoles.ADMIN role is assigned to a user who is responsible to
administration of a resource.
Owner Role
The AccessRoles.OWNER role is assigned to a user who owns a resource.
1 maintainer
Metadata
1 maintainer
Release files for neon-data-models 0.0.3a6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| neon_data_models-0.0.3a6.tar.gz | 37.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| neon_data_models-0.0.3a6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 111.3 kB
Release files / neon_data_models-0.0.3a6.tar.gz
| Download URL | neon_data_models-0.0.3a6.tar.gz |
|---|---|
| Size | 37.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3e1bbdfb4b117acc715f443d434c8891c7de5036873fd0934a85a3a2354290d7
|
|
BLAKE2b-256 checksum How to use checksums |
ef18f207f8ecf5a4d8591ad2861915bf22e487ef0569e0c1a7021d29c60c6999
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / neon_data_models-0.0.3a6-py3-none-any.whl
| Download URL | neon_data_models-0.0.3a6-py3-none-any.whl |
|---|---|
| Size | 73.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e196971da791478c08005351c64aa14507f877d6200fb233ec257cd5d15e07a4
|
|
BLAKE2b-256 checksum How to use checksums |
dbb20c99f6ebc4c83ad2534c38fd77fe871e458307ff90fd84982d97a4fa5f6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
