Skip to content

Update @API vocabulary: API.entity.releaseState and related#179

Open
frankejoe wants to merge 5 commits into
mainfrom
Add-API-Entity-Aannotation
Open

Update @API vocabulary: API.entity.releaseState and related#179
frankejoe wants to merge 5 commits into
mainfrom
Add-API-Entity-Aannotation

Conversation

@frankejoe

Copy link
Copy Markdown
Contributor

Enhanced the API annotation definition with the definition for entities.

Enhanced the API annotation definition with the definition for entities.
@frankejoe frankejoe requested a review from Fannon June 25, 2026 05:33
@open-resource-discovery-bot

open-resource-discovery-bot commented Jun 25, 2026

Copy link
Copy Markdown
PR Preview

QR code for preview link

🚀 View preview at:
https://sap.github.io/csn-interop-pr-preview/csn-interop-specification/pr-179/

Built to branch main at 2026-07-01 15:22 UTC.
open-resource-discovery/pr-preview-action

Comment thread spec/v1/annotations/api.yaml Outdated
type: string
x-extension-targets:
- Type
"@API.entity":

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@frankejoe : I think this has to be the full path already like this:

Suggested change
"@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

@Fannon Fannon requested a review from maiargu June 30, 2026 16:34
@Fannon Fannon changed the title Update api.yaml Update @API.entity.releaseState and related Jul 1, 2026
description: This is the interface description of @API.
type: object
definitions:
"@API.element":

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Fannon Fannon changed the title Update @API.entity.releaseState and related Update @API vocabulary: API.entity.releaseState and related Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants