SAMS - Improved Client Code-Gen Type Mappings

[cdhanna]

We need to:

• Allow users to create their own Semantic Types.
• Allow users to use our semantic types.
• Allow users to use any of our AutoGenerated types from the first pass of types (maybe via an attribute that holds information about the C# type onto its originating OAPI schema).
• Map some of our C# types to explicit semantic types:
  • ContentId/Ref being the main example.

If we can find a way to keep this tracing between C# and OAPI, we can make these types readily available without additional generation in UE (and potentially other non-C# engines).

[cdhanna]

Imagine you had this class,

public class Message {
 public GamerTag id;
}

public struct GamerTag {
 // plus maybe implicit conversions to string and long
 public string strValue;
 public long numValue;
}

Then you could have json for the Message like this,

{
 "id": 12345
}

[allister-beamable]

For reference, some (but not all) ambiguously-typed fields in the backend have @JsonSemantic annotation hints that make their way into the OpenAPI. Getting this system right-er might require a thorough sweep of backend code to ensure that these semantic annotations are used everywhere they can be.

Example:

case class StatUpdateRequest(
  @JsonSemantic(Semantic.StatType)
  objectId: Option[String] = None,
  set: Option[Map[String, Any]] = None,
  add: Option[Map[String, Any]] = None,
  emitAnalytics: Option[Boolean] = None
) extends NetworkSerializable

[cdhanna]

Maybe a better solution is just to rename the actual backend field names from stuff like "id" to "playerId". And if we do a rename, then we need to consider compatibility

[PedroRauizBeamable]

Another potential way to think about this is to have the semantic types in our microservice/common packages and I can generate them as part of our OAPI code-gen?

This has the side-benefit that whatever we use to tag our types as semantic types can be reused by our customer to tag their types in their client callable signatures.

[cdhanna]

related to #4184