id not allowed in requestbody for date/location/person annotator, but id is part of the returned clinical notes about nlpsandbox-schemas HOT 4 CLOSED

Do you remember when I mentioned that I was considering creating two schemas to solve the issue where a property should be part of the input and not the output or vice versa? OpenAPI options readOnly and writeOnly intend to solve this problem in a DRY way.

The problem that you report is actually due to connexion-Flask not respecting the option readOnly and writeOnly when generating examples of request bodies. Here id is marked as readOnly and so should only be included in output objects. You can confirm this by looking at the schema of the request body where id is not included.

Here is what OpenApi doc says for readOnly:

Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.

Note the use of "SHOULD NOT" and not "MUST NOT" in "SHOULD NOT be sent as part of the request". This means that connexion-Flask should not throw an error if a property marked as readOnly is included in the request body.

See nlpsandbox/data-node#81

Open discussion in connexion project:
spec-first/connexion#942
spec-first/connexion#350

The solution described here as part of 942 complicates the code too much and I don't want this to confuse our developers since we provide this code as example.

from nlpsandbox-schemas.

Open tickets for OpenAPITools/openapi-generator:
OpenAPITools/openapi-generator#4190

from nlpsandbox-schemas.

The resolution is that 'id' needs to be removed from clinical notes prior to annotation.

from nlpsandbox-schemas.

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

from nlpsandbox-schemas.