Update @API vocabulary: API.entity.releaseState and related#179
Update @API vocabulary: API.entity.releaseState and related#179frankejoe wants to merge 5 commits into
Conversation
Enhanced the API annotation definition with the definition for entities.
|
| type: string | ||
| x-extension-targets: | ||
| - Type | ||
| "@API.entity": |
There was a problem hiding this comment.
@frankejoe : I think this has to be the full path already like this:
| "@API.entity": | |
| "@API.entity.releaseState": |
Reason is that we decided to not have deeply nested annotations in objects but always use the full path, only the final value may be an object in case it's a reference or complex value object
See also https://sap.github.io/csn-interop-specification/spec-v1/extensions/semantics how we did it there
| description: This is the interface description of @API. | ||
| type: object | ||
| definitions: | ||
| "@API.element": |
There was a problem hiding this comment.
Dropping this is a breaking change, we need to check if it has been used. If yes, we need to keep it, but should mark it as deprecated.
There was a problem hiding this comment.
LoBs have already used the Annotation in its nested form:
https://github.tools.sap/bdc-fos/dp-metadata/blob/e927f5b2718c3debeb9ecdfb9e769a8d8acec794/environments/eu10/prod/defaults/csn_documents/sap/bdc/sf/analytics/RecruitmentInterviewData_1.1.0.json#L122

Enhanced the API annotation definition with the definition for entities.