[gen] dictionaries with referenced keys extension

[hochgi]

• works with or without alias flag properly.
• validates non-string references.
• tests for all UUID/aliased/non-string

fixes #3030
/claim #3030

[987Nabil]

I am not sure we should make it this complicated. Maybe it is okay we say we only support a certain sub set. Like only one key annotated schema?

[hochgi]

only one key means that of the 2 dictionaries: 1 is unconstrained, and 1 has a schema. in this case, code resorts to None, since we cannot have any schema.
The only applicable case is when we have 2 schemas.
I chose to implement "intersection" semantics when possible, over "union".

This is an important decision, which I'm not sure about.
What's your take? should we relax the key schema to be a union of both, or restrict to be the intersection of both?

Also, when does combine is called anyway?

[987Nabil]

I think, id we have something that we can't resolve successfully, we should throw. At least something like not impl exception. Dropping it silently is hell for debugging

[hochgi]

In general I agree with the principle, not sure it applies here.

• We're not dropping silently
• it's an extension that is ignored by OpenAPI (anything that starts with x- is passed on transparently), thus I think we should avoid throwing as much as possible.

lets start with the obvious: if both are the same (either None, or identical Some(x)) - preserve.

The question is when they differ.
If only 1 is defined, i.e. combining 2 dictionaries, one restricted (e.g. UUID keys), the other is not.
So I assume the combined should not be constrained?

If both are defined, then some properties can be reconciled (e.g. min/max length or pattern), while others less so (format).
So I tried to do the best here.

What I lack, is the context of when combining actually happens.

[hochgi]

@987Nabil IIUC, combine is called only when generating JsonSchema from zio Schema, i.e. when we define the endpoint in scala, and generate the schema from it.
If that's the case, I think that my decision to do an "intersection" was wrong, and I should do a "union".
I.e. max of maxLength (instead min of maxLength), | instead of lookahead assertions in pattern, etc'…

I'll change accordingly.

[987Nabil]

Please also resolve the conflicts

[hochgi]

/claim #3030

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 39.43662% with 43 lines in your changes missing coverage. Please review.

Project coverage is 65.56%. Comparing base (e2f2cb5) to head (2e0fa22).
Report is 26 commits behind head on main.

Files with missing lines	Patch %	Lines
...n/scala/zio/http/endpoint/openapi/JsonSchema.scala	39.43%	43 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3043      +/-   ##
==========================================
- Coverage   65.65%   65.56%   -0.09%     
==========================================
  Files         155      157       +2     
  Lines       10134    10246     +112     
  Branches     1899     1949      +50     
==========================================
+ Hits         6653     6718      +65     
- Misses       3481     3528      +47     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.