Repository navigation
Expand file tree
/
Copy pathrelease-notes.xml
More file actions
118 lines (118 loc) · 39.3 KB
/
Copy pathrelease-notes.xml
File metadata and controls
118 lines (118 loc) · 39.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<ReleaseNotes>
<ChangeSet guid="g6d48f4a-b886-260c-bf73-3aa3c4d7a54f" version="1.2.623.523" date="2023-05-23">
<Change type="feature">Update the Patchhelper to patch list of guid, string or something else.</Change>
</ChangeSet>
<ChangeSet guid="bd08bd0a-9828-4302-ad26-0e3426494d80">
<Change type="feature">Update the Patchhelper to be able to patch a list of tuples when configured correctly.</Change>
</ChangeSet>
<ChangeSet guid="7630d406-4817-47b9-a349-069d8448b2f5">
<Change type="bug">Fix issue allowing to query all organizations when no organization id is set in the request context.</Change>
</ChangeSet>
<ChangeSet guid="0762397b-792e-4704-8fa8-7e1318e9817c">
<Change type="enhancement">Update to .net 7.</Change>
<Change type="feature">Add scoped services for hangfire</Change>
<Change type="enhancement">Switch open-telemetry from beta-libraries to stable libraries</Change>
</ChangeSet>
<ChangeSet guid="2ec0c75f-1cc9-4b90-ab07-dd542ea45612">
<Change type="feature">Add generic parameter to scoped jobs.</Change>
</ChangeSet>
<ChangeSet>
<Change type="bug">Fixes a bug where Update and Delete using Data.ITransactions do not successfully add the commands to the data transaction in MongoRepositoryBase.</Change>
</ChangeSet>
<ChangeSet>
<Change type="feature">Add Organization settings as optional configuration for each microservice to organization needs.</Change>
<Change type="feature">Add group organization support to settings with groupKey, groupDisplayKey, and groupDisplayName properties for better UI organization and management.</Change>
<Change type="enhancement">Update OrganizationSettingResult classes to include group information in API responses for frontend organization capabilities.</Change>
</ChangeSet>
<ChangeSet>
<Change type="feature">Add the Ox schema: every service publishes GET /schema, an organisation-independent document describing its queryable entities, their types, keys, relationships and REST operations, with a content-derived revision and ETag. The wire contract, the configuration and the upgrade notes are in OX_SCHEMA.md.</Change>
<Change type="feature">GET /schema is anonymous by default, the same posture as /ModelDefinition, because build tooling and client generators fetch it without credentials. It discloses the persisted shape of every entity (property names and kinds, storage names, enum members, keys, references, routes) and no CLR namespace, no data and nothing about an organisation. A host that does not want that sets OxSchema:RequireAuthorization to true; GET /schema then requires an authenticated caller like GET /schema/addons does.</Change>
<Change type="enhancement">Serve /ModelDefinition from memory. The document is built once at startup from the same controller list and nothing writes ModelDefinition/ModelDefinition.json any more; the endpoint now answers GET only, and a controller the generator cannot describe is left out instead of replacing the whole document. The per-organisation addon merge of the previous controller is removed: it never applied to the generated document, which is a JSON array the merge could not read, so the served content does not change for any caller; it is written with LF line endings on every platform. An organisation's addon keys are published by GET /schema/addons.</Change>
<Change type="enhancement">ModelDefinitionController is sealed, derives from OxSController and takes the OxSchemaRegistry alone.</Change>
<Change type="feature">Add Bootstrap.ConfigureOxSchema so a host can declare the ids an entity retired when it was renamed; they are published as aliases of the entity.</Change>
<Change type="enhancement">Mark ModelDefinitionBuilder.AddControllerDefinitions obsolete; the registry replaces it and Bootstrap no longer calls it.</Change>
<Change type="enhancement">The schema is built while the host starts. In the Development and Local environments and under continuous integration (the CI or the TF_BUILD environment variable) an ambiguous document stops the start; every other host logs the findings and serves the document with its diagnostics. A build that throws never stops such a host either: it is logged as critical, /schema serves a document without types that carries the entity-scan-failed diagnostic, and every other route is unaffected.</Change>
<Change type="enhancement">Bootstrap calls ConfigureModelDefinitions and GetOxQLTypeAssemblies during ConfigureServices. The schema build looks up the MongoDB serializer of every entity and every type reachable from one when the host starts, which freezes their class maps: register class maps and serializers in RegisterServices, not in a static constructor, a hosted service or on first use.</Change>
</ChangeSet>
<ChangeSet>
<Change type="feature">Move to OxQL 2 (OxQL.AspNetCore, OxQL.Core, OxQL.Mongo and OxQL.Studio 2.x, and the new OxQL.Model). The query engine binds against the entity model the schema is built from, and takes every option from the host's OxQL configuration section (limits, OxQL:Compat:Enabled, OxQL:Explain:Enabled, OxQL:Cursor:SigningKey, which falls back to Auth:Token). A host without the section keeps the previous page sizes (MaxPageSize 500, DefaultPageSize 100). A service that references an OxQL package itself has to move to the same version.</Change>
<Change type="enhancement">Remove OxQLOrganizationFilter. Bootstrap registers OxQLScopeProvider through AddOxQLScope instead, and the engine applies the organisation at every entry into an entity and refuses a request without one. A service that registered the filter itself no longer compiles; delete the registration.</Change>
<Change type="feature">Add POST internal/oxql/batch (internal api key, hidden from the API explorer) and the RemoteQueryClient, through which the engine resolves references into entities another service owns. The calling service needs InternalHosts:{service} and, for an owner that does not answer on v1, the new InternalApiVersions:{service} key; without it the owner appears unreachable.</Change>
<Change type="feature">Add addon definitions: the AddonDefinition controller (GET {entity}, GET by-id/{id}, POST, PUT {id}, DELETE {id}) stores an organisation's typed addon keys in the service's collection model_definition.addon_definition.{service}, the engine filters and sorts on them, and GET /schema/addons publishes them in the schema's descriptor format.</Change>
<Change type="enhancement">The OpenAPI document of every service changes: GET /OxQL/types is removed (GET /schema replaces it), POST /OxQL/batch is added, the request and result schemas of the OxQL routes are those of contract 2, and the five AddonDefinition operations are added. Generated API clients change on their next regeneration. Callers written against contract 1 keep working at runtime while OxQL:Compat:Enabled is on, which is the default.</Change>
<Change type="enhancement">OxQL engine faults carry their message in the Development and local environments only.</Change>
<Change type="enhancement">AuthorizeInternalApiKey compares the key in constant time, refuses every call when the configured Auth:InternalApiKey is blank, and answers a controller that does not derive from OxSInternalController with 400 without running the action.</Change>
<Change type="enhancement">The query engine's startup check of the model's remote references fails fast on the same continuous-integration value as the schema build: the CI or the TF_BUILD environment variable, or what a host states through ConfigureOxSchema. A host is strict in both checks or in neither.</Change>
</ChangeSet>
<ChangeSet>
<Change type="feature">Move to the OxQL 2.1 packages with contract 2 (OxQL.AspNetCore, OxQL.Model, OxQL.Core, OxQL.Mongo, OxQL.Studio). The base package compiles only against 2.1; a service that references an OxQL package itself moves to the same version, and the engine and this package are deployed together on every service that calls or is called.</Change>
<Change type="enhancement">POST /OxQL/explain is on by default, never executes a query and is rate limited per user and host. OxQL:Explain:Enabled=false turns it off, together with POST internal/oxql/explain.</Change>
<Change type="enhancement">A /OxQL/batch maxTimeMs bounds the whole batch, not each query.</Change>
<Change type="feature">A request without the X-OxQL-Contract header is answered by the engine's contract 1 legacy pipeline, unchanged for existing callers. It is the default (OxQL:Compat:Enabled, OxQL:Compat:Legacy:Enabled and OxQL:Compat:Legacy:Always are true) and temporary; OX_SCHEMA.md section 4.3 lists the keys. The header takes 1 or 2; any other value is answered 400 (UNKNOWN_REQUEST_MEMBER) on query, batch and explain.</Change>
<Change type="enhancement">The caller's organisation is always matched before any stage of a contract 1 request. A contract 1 lookup names a collection of the service's database and reads the caller's organisation's documents of it; OxQL:Compat:Legacy:AllowedLookupSources restricts it to named collections. Such a request is bounded by OxQL:Compat:Legacy:MaxTimeMs (ten minutes), not by OxQL:Execution:MaxTimeMs.</Change>
<Change type="enhancement">Under contract 2 a long and a decimal are JSON numbers in query results (rows, group keys and outputs, addon values), with every digit, as the REST API writes them; they were strings. A client typed against string changes its types; a reader that parses JSON numbers into doubles keeps 15 to 17 significant digits. Contract 1 answers are unchanged.</Change>
<Change type="feature">Publish Ox schema format 1.1: descriptions, constraints and deprecations, variants with their discriminator, onlyFor members and the name of a concrete base (baseVariant), reference cases and relation names (relation), members that are not stored (stored) and values stored otherwise than their kind says (storedAs), host-side reference declarations (OxSchemaOptionsBuilder) and the limits for continued stages, flatten depth and the report page. A 1.0 reader keeps reading the document.</Change>
<Change type="feature">Publish the model's own type member: a get-only string member of a polymorphic type that is a constant of each class (type: "driver") carries the value per variant (byVariant) and the distinct values (values). The query engine answers it in rows from the stored discriminator and filters it with eq, neq, in and nin; the entity lists its path in notSortable and no longer in notFilterable.</Change>
<Change type="enhancement">Every service's schema revision changes once when it takes this package, without a change to its model (the engine's published limits, the 1.1 format; and byVariant, values and notSortable where a service has a type member). A client that holds a schema document reloads it, and generated OxQL modules are regenerated.</Change>
<Change type="feature">Add POST internal/oxql/explain (internal api key) so another service checks the stages it continues here, as one batched call per round, at most OxQL:Explain:MaxConcurrentPerCaller (4) in flight per calling service (X-OxQL-Caller, sent by the RemoteQueryClient) and within the budget the origin has left, and pass internal batches to the engine as internal calls. The RemoteQueryClient reads an owner's shallow health before its first batch, names the routed API version and hands the engine the schema revision.</Change>
<Change type="enhancement">Store addon definitions in a collection per service (model_definition.addon_definition.{service}) with a unique index on organisation, entity and path among the rows not deleted; a write the index refuses is answered 409. The package creates the index at a process's first definition write; where the service's account may not create one, the writes go on, one warning is logged and the creation is asked for again an hour later. Read an entity's addon definitions under its current and every retired id in one query; a live row wins over a retired one.</Change>
<Change type="enhancement">Cache addon definitions per instance and serve them past their lifetime for at most ten lifetimes and never more than five minutes while one background read replaces them; requests that miss together share one read, and a request that waited for the read says it in its timing as database time. There is no invalidation across instances.</Change>
<Change type="enhancement">Bound addon definitions: a path of at most 256 characters in 8 segments, a display name, a value and a value label of 256 characters, a description of 2000, a value list of 500 values, and 500 definitions that are not retired per organisation and entity. A request over a limit is answered 400.</Change>
<Change type="enhancement">GET /schema is answered in the content coding the caller accepts.</Change>
<Change type="enhancement">The OxQL Studio console is served at {pathBase}/oxql (it answered only under a doubled path before) and only while OxQL:Studio:Enabled is true, which defaults to true in every environment but Production.</Change>
<Change type="enhancement">AuthorizeInternalApiKey runs before every other action filter, so a call without the key is answered 401 whatever its body holds.</Change>
</ChangeSet>
<ChangeSet>
<Change type="feature">Add Bootstrap.RegisterBsonClassMaps, the place for a service's MongoDB class maps and serializers. Bootstrap calls it once per process for a startup type, during ConfigureServices, before RegisterServices, the mapper and the Ox schema build, which freezes the class map of every type it reaches.</Change>
<Change type="enhancement">The AutoMapper instance is created while the host starts, right before the Ox schema is built, not on the first request that needs one. Class maps and serializers a service registers in RegisterMapperProfiles are therefore in place for the schema and are registered once per host; an exception thrown in RegisterMapperProfiles stops the start in every environment, with the original exception.</Change>
<Change type="enhancement">The startup log writes polymorphic-subtype-unregistered as an error and adds one line that counts the stored subtypes without a class map and names RegisterBsonClassMaps.</Change>
<Change type="enhancement">The startup log writes entity-id-off-grammar as an error, and the finding names the id to declare (service.entity) and the RetireEntityId line that keeps the present id resolving. The new finding entity-id-foreign-service marks an entity id whose prefix is not the host's service name, in the same form. One more line counts such ids and says what to do. Neither finding refuses a start in any environment, and neither is published: a service with such ids starts after the bump as before. A service whose name can prefix no id (it holds a hyphen) gets one warning instead, service-name-no-id-prefix: its entities cannot be referenced from another service, and no id is held to the prefix.</Change>
<Change type="enhancement">The host logs, once at start, the batch route of every service a declared reference points into and that has an InternalHosts entry, and where the api version of the route comes from (InternalApiVersions:{service} or the default v1).</Change>
<Change type="enhancement">The HTTP client of the owner calls (OxQL.Remote) waits two seconds for a connection, or what the host configures as OxQL:Remote:ConnectTimeoutMs in milliseconds (zero or less: no connect timeout of its own). An owner that accepts none fails the call as an unreachable owner without using up the call's budget; a call on an established connection is bounded by its budget as before.</Change>
<Change type="feature">Add OxSchemaCheck (Simplic.OxS.Server.OxSchema): OxSchemaCheck.Build<Startup>() builds a service's Ox schema in a unit test, without a host, the way the host does (RegisterBsonClassMaps, the mapper profiles, GetOxQLTypeAssemblies, ConfigureModelDefinitions, ConfigureOxSchema), and returns the document, every finding and every declared reference. The test project needs a reference to the service's server project only. OX_SCHEMA.md section 3.5 has the example.</Change>
<Change type="enhancement">A host that configures OpenTelemetry metrics (the Monitoring section) exports the meter named OxQL beside the service's own meters.</Change>
<Change type="enhancement">Upgrade notes (OX_SCHEMA.md sections 2.1, 2.4, 5.4 and 5.5). A service that references a sibling package directly raises it to at least Simplic.OxS.ModelDefinition.Service 3.0.1226.825, Simplic.OxS.ModelDefinition.Extension 3.0.826.1012, Simplic.OxS.ServiceDefinition 3.0.1426.1012, Simplic.OxS.ServiceDefinition.Repository 3.0.926.1012 the OxQL packages 2.1.226.1013 and OxQL.Studio 2.1.126.1012, or removes the reference, since Simplic.OxS.Server brings them; restore names one package per run (NU1605). The owning service of an entity is the prefix of its id: an owner renames an id without its prefix to service.entity and retires the old one with RetireEntityId first, then other services declare references to the new id, and every service a reference points into needs InternalHosts:{service} and, where the owner does not answer on v1, InternalApiVersions:{service} on the calling service.</Change>
<Change type="enhancement">The guid serializer Bootstrap registers is left in place when the process already holds it, so a second host of one process starts (integration tests).</Change>
<Change type="enhancement">GET /schema and GET /schema/addons are part of every service's OpenAPI document: summary, description, the If-None-Match header, 200 with its model, the ETag header and an example, 304, and 401 and 403 where the route answers them. GET /schema carries no security requirement unless the host sets OxSchema:RequireAuthorization. The schema document's models (OxSchemaDocument and the types it uses) join components.schemas, and a client generated from the document gains the two operations on its next regeneration. The document of a service's own controllers does not change. OX_SCHEMA.md section 5.3 says what a service gets and that it has nothing to do.</Change>
<Change type="feature">The package brings build targets (build and buildTransitive) that copy OxQL.AspNetCore.xml beside a service's assemblies when it is built and published, and the OpenAPI setup includes every OxQL.*.xml found there, so the parameters and body members of the OxQL routes are described; a file it cannot read is left out with a warning and the document is generated without it. A service edits nothing; SimplicOxSCopyQueryApiComments=false leaves the file out.</Change>
<Change type="enhancement">Add OxSchemaRegistry.Degraded: true when the schema build threw or its entity scan failed, false for every model the service meant to build, a service without entities included. The host hands it to the query engine with the model, which publishes it on GET /OxQL/health as model.degraded and degrades the status while it is true.</Change>
<Change type="enhancement">POST internal/oxql/batch and POST internal/oxql/explain answer a contract 2 body the host cannot bind in the query engine's refusal envelope (400 validation_error, INVALID_REQUEST_BODY with params), as the public routes do. An entry of an internal batch that does not read is refused in its place of results with params.entry and the other entries run. The internal key is still checked first, and a contract 1 request is answered as before.</Change>
<Change type="feature">The RemoteQueryClient reads which entities an owner publishes (IRemoteSchemaSource, RemoteQueryClient.SchemaUrl): a conditional GET of the owner's /schema over the route of every other owner call, without a key, kept for the health probe's time to live. The query engine checks the target of every declared reference against it in the background and names a target the owner does not publish in the log, on GET /OxQL/health (references per service) and in explain. The read is bounded by two seconds and by 16 MiB of body, is shared by the callers that ask while it is under way, and never throws; an owner that does not answer, has no schema route, requires authorization for its document or serves no schema document or a larger one leaves its references not validated. Nothing about the start or a query depends on it. A service has nothing to configure.</Change>
<Change type="enhancement">The OpenAPI document of every service describes the OxQL routes as the query engine describes them: summary and description with the address of the OxQL documentation (the query language is not in the document), X-OxQL-Contract (1 or 2) and X-OxQL-Timing as optional header parameters, the JSON bodies and answers by the engine's models of the wire (OxQLQueryBody, OxQLQueryAnswer, OxQLBatchBody, OxQLExplainBody, OxQLHealthAnswer, OxQLError and the types they use), every status a route answers and no other, 401 and 404 as problem+json, If-None-Match and ETag on explain, Retry-After on its 429, no security requirement on health, and one example of every request and answer. The contract 1 body and answer of the query route are published as deprecated schemas (OxQLContract1QueryBody, OxQLContract1QueryAnswer) and named in the description. A client generated from the document is a contract 2 client and sends X-OxQL-Contract: 2; it changes on its next regeneration (OX_SCHEMA.md section 5.3). The document of a service's own controllers does not change.</Change>
<Change type="enhancement">A REST client regenerated from a service's OpenAPI document names the types of the query routes anew, and the new types describe contract 2, so code that moves to them sends X-OxQL-Contract: 2 with every request: QueryRequest is OxQLQueryBody, QueryResult is OxQLQueryAnswer, PageInfo and CountInfo are OxQLPageInfo and OxQLCount, BatchRequest and BatchResponse are OxQLBatchBody and OxQLBatchAnswer, ExplainRequest is OxQLExplainBody, ExplainResult is OxQLExplainAnswer (its parts, ExplainStage, ExplainColumn, ExplainPlan and the other Explain* types, are objects without a type of their own), Refusal and QueryValidationError are OxQLError and OxQLErrorDetail, Diagnostic is OxQLDiagnostic, PipelineStage is OxQLStage, PageStage is OxQLPageStage (limit, cursor, count), LookupStage, ResolveStage, UnwindStage, GroupStage and ValuesStage carry the OxQL prefix, GroupByField and DateTruncExpression are OxQLGroupKey and OxQLDateTrunc. MatchStage, ProjectStage, SortField, FilterCondition, FilterConditionOptions, AggregationExpression, QueryExpression, QueryVariables, ResolveBranch, KeyedByMember, JsonNode and JsonNodeOptions have no successor: those members are plain objects and arrays. New are the operations GET /schema and GET /schema/addons with the OxSchema* types, of which OxSchemaProperty refers to itself (of, value), the typed answer of GET /OxQL/health (OxQLHealthAnswer) and the deprecated contract 1 shapes OxQLContract1QueryBody, OxQLContract1QueryAnswer and OxQLContract1PageInfo. OX_SCHEMA.md section 5.3 has the table.</Change>
</ChangeSet>
<ChangeSet>
<Change type="enhancement">The package holds the query engine's comments (OxQL.AspNetCore.xml, of the engine version it references) beside its build targets, and the targets copy that file, so a service's OpenAPI document describes the parameters and body members of the OxQL routes alike in every build, also in a build that restores without documentation files (NUGET_XMLDOC_MODE=skip, the setting of the .NET SDK container images). A service edits nothing; SimplicOxSCopyQueryApiComments=false leaves the file out as before (OX_SCHEMA.md section 5.3).</Change>
<Change type="enhancement">The OpenAPI document of every service describes the five /AddonDefinition operations as it describes the query and schema routes: summary and description (what an addon definition is, with the address of OX_SCHEMA.md), the path parameters and the request bodies with a description, every member of CreateAddonDefinitionRequest, UpdateAddonDefinitionRequest, AddonDefinitionResponse and their value types with a description, one example of every request and answer, and every status a route answers and no other: 401, 403 and 404 as problem+json, 400 and 409 as the sentence the route answers (a string), 400 also as problem+json for a body the host cannot read. No route, status, body or model changes. A client generated from the document keeps the names of the operations and types and, on its next regeneration, types the error of a 400 and of a 409 as string (OX_SCHEMA.md section 5.3).</Change>
</ChangeSet>
<ChangeSet>
<Change type="enhancement">The answer to every request carries a correlation id in X-Correlation-ID: the id the caller sent in that header, as the caller wrote it, where it is a guid (the form the request context reads), and a new one where the caller sent none or something else. A caller can therefore find its request in the logs by the id it chose.</Change>
<Change type="enhancement">The public explain route counts its limit (OxQL:Explain:RatePerMinute, OxQL:Explain:RateBurst) per caller: the user of an organisation, read from the authenticated request by the rules the request context is filled by, so the callers of a service behind one ingress address each have a limit of their own. A request that names neither user nor organisation is counted by its remote address. The scope provider answers the query engine with the same user, organisation and correlation id before the request context is filled as after; the forwarded UserId and OrganizationId headers of an internal call count only once its key was checked (OX_SCHEMA.md section 4.3).</Change>
<Change type="enhancement">A host whose configuration has no MongoDB section serves the routes that read no data: GET /schema answers the document, GET /OxQL/health answers with and without shallow, and such a host starts where its services are validated when it is built, as a Development host's are. GET /schema/addons answers 404 as problem+json there, with a detail that names the missing section (the status is listed in the OpenAPI document), and a query answers the engine's internal_error while the log names the missing section. The schema controller asks for the addon definitions in the route that serves them; its constructor with the addon source is kept (OX_SCHEMA.md section 4.4).</Change>
<Change type="enhancement">The client of the calls between services sends a call to the configured owner and nowhere else. An InternalHosts value is a host with an optional port (a name of letters, digits, dots, hyphens and underscores, an IPv4 address or an IPv6 address in brackets; port 1 to 65535): a value with a scheme, a user, a path, a query or whitespace is never called, the service counts as not configured (RemoteQueryClient.IsConfigured, health, references into it), and the host logs one error at start per such service the model references, naming the key and the form and never the value; where a missing entry stops the start (Development, Local, continuous integration) such a value stops it with that sentence, unless OxQL:Startup:StrictRemoteReferences is false. The named HttpClient OxQL.Remote follows no redirect: an owner that answers a batch or an explain with one is reported as an owner that does not serve the route. New: RemoteQueryClient.HostEntryForm and RefusedHostOf (OX_SCHEMA.md section 4.2).</Change>
<Change type="enhancement">Where a registration of a service meets the MongoDB driver's "There is already a serializer registered for type …" (RegisterSerializer) or "There is already a different serializer registered for type …" (TryRegisterSerializer) while the host starts (in RegisterBsonClassMaps, RegisterServices, RegisterMapperProfiles or ConfigureOxSchema, also as the cause of what is thrown there), the exception the host stops with is of the driver's type, keeps what was thrown as its inner exception, and says after the driver's sentence where it was thrown and what to do: the type had a serializer before, one registered earlier or the default the driver creates when an earlier registration first looks the serializer up; register the serializer at the top of RegisterBsonClassMaps(), before anything that constructs a serializer or a class map; TryRegisterSerializer does not help, because the serializer in place stays and the earlier registration keeps it. OxSchemaCheck says the same.</Change>
<Change type="enhancement">OxSchemaCheck with RunRegisterServices runs RegisterServices once per process for a startup type, as it runs the class map hook and the mapper profiles, also where a host of that type was built before: several checks of one test run work for a service that registers a serializer or a class map there without a guard (OX_SCHEMA.md section 3.5).</Change>
<Change type="enhancement">The schema of a host built on Bootstrap is the one the host registers, with the step that runs the mapper profiles before the build, also where the service calls the public AddOxSchema itself: a call before the host's registration is merged into it (the names, the api version and the environment are the host's; the type assemblies and controllers are the host's and then the call's; retired ids, reference declarations and a required authorization of the call are kept), a call after it changes nothing as before, and an OxSchemaRegistry the service registered by itself is replaced by the host's. The start logs each as one warning that names ConfigureOxSchema as the place for a service's schema options. AddOxSchema stays public, for a host that is not built on Bootstrap. The [Obsolete] text of ModelDefinitionBuilder.AddControllerDefinitions says to delete the call and that ConfigureModelDefinitions() is where the controllers come from (OX_SCHEMA.md section 3).</Change>
<Change type="enhancement">The OpenAPI document marks the members an addon definition is not stored without as required and not nullable: entity, path and kind of CreateAddonDefinitionRequest and value of AddonDefinitionValueRequest. No route answers differently; a client generated from the document types these members as mandatory on its next regeneration (OX_SCHEMA.md section 5.3).</Change>
<Change type="enhancement">The OpenAPI document of every service describes the models of the schema document: each of the 19 OxSchema* models, and 92 of their 102 members (the other ten point to a model, which carries the description). The sentences are the package's own comments on those models in the terms of the wire: a member is named by its JSON name, a list of values by its values, each description on one line; the description of a relation's name states where the name lies. The package holds its own comments (Simplic.OxS.Server.xml) beside its build targets, as it holds the query engine's, and the targets copy both, also in a build that restores without documentation files (NUGET_XMLDOC_MODE=skip); SimplicOxSCopyQueryApiComments=false leaves both out. Of that file the document takes the schema models and the two schema routes and nothing else: every other controller and model of the package, and every controller of a service, is in the document as it was. A service edits nothing; a client generated from the document gets the descriptions as comments on its next regeneration (OX_SCHEMA.md section 5.3).</Change>
<Change type="enhancement">The upgrade notes (OX_SCHEMA.md sections 5.2, 5.4 and 5.5) say when a service leaves its start-up order alone and when it moves its MongoDB registrations into RegisterBsonClassMaps(): only where class maps can run after the schema build or more than once, and then together with every serializer registration, in the order plain serializers, class maps, serializers that keep another one (the example of the hook shows it). They name the driver's "There is already a serializer registered for type Object." with where it is thrown, why and what to do, and what TryRegisterSerializer does there; that registrations in the mapper profiles run before the schema build and after the service's hosted services have started; that a stored subclass without a class map or a known-types entry is described by one process and not by another; what a model project references (OxQL.Model or OxQL.Core, at the version this package depends on and never a higher one) and that a restore reports a downgrade only for a direct reference of the project that references this package; that the environment name decides the default of OxQL:Studio:Enabled; what a local run needs; and when the schema test sets RunRegisterServices. The checklist has six steps.</Change>
<Change type="enhancement">The routes of the package's own controllers (/schema, /schema/addons, /AddonDefinition, /AddonField, /OrganizationSettings, /ServiceContract, /ServiceDefinition, /ModelDefinition, /HealthCheck, the internal query routes) are served whatever SDK the server project of a service is built with: the host names the package's assembly as an application part where the project does not, once. A service built with Microsoft.NET.Sdk instead of Microsoft.NET.Sdk.Web adds nothing (OX_SCHEMA.md section 5.2).</Change>
<Change type="enhancement">An entity that is declared extendable and has no addon member is named when the host starts: the finding extendable-without-addon, a warning with the entity and what to do (add the addon member or drop the flag), which stops no start and is not published. The schema document publishes extendable for it as declared, as before, and GET /schema/addons lists the entities that take addon definitions, as before; its summary and description in the OpenAPI document now say exactly that (OX_SCHEMA.md section 3.3).</Change>
<Change type="enhancement">A service that returns an empty list from GetOxQLTypeAssemblies() declares that it has no entities: its schema document carries no types and no diagnostic, nothing is reported, and the start says so in one information line. entity-assemblies-missing stays the finding of a startup that returns no list (null). New: OxSchemaOptionsBuilder.NoEntitiesDeclared and OxSchemaBuildOptions.NoEntitiesDeclared, for a host that registers the schema itself. The revision of such a service's document changes with the diagnostic that is no longer in it (OX_SCHEMA.md section 3.3).</Change>
<Change type="enhancement">The summary line of the schema at start names the number of entities beside the number of types (entities=N types=M), and the lines that say what to do about subtypes without a class map and about entity ids speak of one where there is one. A log query that reads the summary line by position follows the new member; one that reads it by name does not change.</Change>
<Change type="enhancement">OX_SCHEMA.md: section 3.3 lists every finding code of the package and of the query engine's model build, reference-target-unprefixed among them, and a test holds the list against the code; sections 4.2 and 4.3 describe OxQL:Startup:StrictRemoteReferences, the key the refusal of a start names; section 5.1 says that the member names of the /ModelDefinition document are camel case as JSON spells it from Simplic.OxS.ModelDefinition.Service 3.0.1226.825 on (QRCode is qrCode, formerly qRCode; IBAN is iban, formerly iBAN), so whatever is keyed on the earlier names follows; section 5.5 says in which projects of a service the package is raised.</Change>
<Change type="enhancement">A request that authenticates with an api key finds its user and organisation in the request context whatever the case its header name is written in (x-api-key, X-Api-Key): the name is matched as HTTP header names are, without regard to case.</Change>
<Change type="enhancement">The forwarded UserId and OrganizationId headers of a call between services are read into the request context only after the internal key was checked: on a controller that derives from OxSInternalController (or carries [AuthorizeInternalApiKey]), as every route the internal client calls is.</Change>
<Change type="enhancement">An InternalHosts value may end in one dot, a fully qualified host name (vehicle.namespace.svc.cluster.local.). Whatever fails while the package's own comments are read for the OpenAPI document leaves them out with one warning, and the document is generated. OX_SCHEMA.md says exactly what a host without the Redis section does in which environment (section 4.4), and which route groups a server project of the plain SDK serves and documents from this version on (section 5.2).</Change>
<Change type="enhancement">RemoteQueryClient.IsReachableAsync throws an HttpRequestException with status 404 where an owner answers 404 to its health route, as BatchAsync and ExplainBatchAsync do for theirs, so the query engine can tell an owner without the route from an owner that is down; every other answer that is no success stays "not reachable". The refusal of a start for an InternalHosts value that is no host names the number of services and the switch OxQL:Startup:StrictRemoteReferences; the key and the service are in the error lines of the log.</Change>
<Change type="enhancement">The package builds on OxQL.AspNetCore and OxQL.Core 2.1.426.1014, OxQL.Mongo 2.1.326.1014, OxQL.Model 2.1.226.1013 and OxQL.Studio 2.1.126.1012, and holds the comments of OxQL.AspNetCore 2.1.426.1014 beside its build targets. A service that references one of these packages directly raises it to at least that version or removes the reference (OX_SCHEMA.md section 5.4).</Change>
<Change type="enhancement">A contract 1 request on POST /OxQL/query, /OxQL/batch, /OxQL/explain or internal/oxql/batch whose body holds text that is not valid Unicode (half of a surrogate pair in a string) is answered 400 in the host's own form, as every contract 1 body the host cannot bind: application/problem+json with type, title, status, detail, instance, traceId and errors, the one place $ in errors. Bootstrap sets ApiBehaviorOptions.InvalidModelStateResponseFactory to ValidationActionFilter.Answer, so a filter that answers an invalid model state through that factory, as the query engine does for such a body, writes the same Simplic problem document ValidationActionFilter writes for an invalid model state; the framework's own model-state filter stays off (SuppressModelStateInvalidFilter). OX_SCHEMA.md section 4.2.</Change>
</ChangeSet>
<ChangeSet>
<Change type="enhancement">The package builds on OxQL.Core 2.1.526.1026 and OxQL.Mongo 2.1.426.1026 (OxQL.AspNetCore 2.1.426.1014, OxQL.Model 2.1.226.1013 and OxQL.Studio 2.1.126.1012 are unchanged): a contract 2 join alias the projection keeps whole shows the target's whole row, and the binder, keyed fetch and explain messages carry the params a client needs to word them itself. A service that references one of these packages directly raises it to at least that version or removes the reference (OX_SCHEMA.md section 5.4).</Change>
<Change type="enhancement">The OxQL Studio console under {pathBase}/oxql is served in every environment, Production included: OxQL:Studio:Enabled defaults to true and no longer depends on the environment name. A host that should not serve it sets OxQL__Studio__Enabled=false (OX_SCHEMA.md sections 5.1 and 5.2).</Change>
</ChangeSet>
<ChangeSet>
<Change type="enhancement">The package builds on OxQL.Core 2.1.626.1028, OxQL.Model 2.1.326.1028 and OxQL.Mongo 2.1.526.1028 (OxQL.AspNetCore 2.1.426.1014 and OxQL.Studio 2.1.126.1012 are unchanged): a defined addon key is filtered, sorted, grouped and aggregated by its value converted to its defined kind, whether stored plain or wrapped; an addon key defined as date is published in GET /schema/addons with kind dateTime (the definition API still answers date) and takes timestamps, and a bare YYYY-MM-DD operand on it is refused. A service that references one of these packages directly raises it to at least that version or removes the reference (OX_SCHEMA.md sections 1 and 5.4).</Change>
</ChangeSet>
</ReleaseNotes>