Skip to main content

​
Overview

Some endpoint pages include request and response schemas expressed with the Neuron assignment pattern-matching notation. This makes it explicit which fields are required, what types are expected, and any constraints.

​
Common patterns

  • Required(Str(PUserName)): required string value.
  • Optional(Int(PSeconds)): optional integer value.
  • Required(Int(0 < PSeconds <= 3600)): required integer with a range.
  • Optional(DateTime(PExpires)): optional date-time value.

​
How to read it

  • The outer wrapper (Required or Optional) tells you if the field must be present.
  • The inner type (Str, Int, Bool, DateTime) defines the expected type.
  • Parameter names (PUserName, PJwt) map to the tables in the page.