Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI Extension Annotations #51

Merged
merged 14 commits into from
Dec 1, 2024
Merged

OpenAPI Extension Annotations #51

merged 14 commits into from
Dec 1, 2024

Conversation

RoshniNaveenaS
Copy link
Collaborator

@RoshniNaveenaS RoshniNaveenaS commented Oct 23, 2024

In this PR , we will be supporting @OpenAPI.Extensions in three levels:

  1. Schema Level
  2. Entity level
  3. Operation level ( action or function)

Example:
In CDS:
image

In OpenAPI:
1extension.openapi3.json

Link to list of possible annotations : https://github.com/SAP/openapi-specification/tree/main/sap-schemas/v3.0

List of special handling:
If other values/ fields are given for the extensions mentioned below, then

Extension Allowed Values/ Fields
x-sap-compliance-level allowedValues: ["sap:base:v1", "sap:core:v1", "sap:core:v2" ]
x-sap-api-type allowedValues: [ "ODATA", "ODATAV4", "REST" , "SOAP"]
x-sap-direction allowedValues: ["inbound", "outbound", "mixed"] , default : "inbound"
x-sap-dpp-entity-semantics allowedValues: ["sap:DataSubject", "sap:DataSubjectDetails", "sap:Other"]
x-sap-dpp-field-semantics allowedValues: ["sap:DataSubjectID", "sap:ConsentID", "sap:PurposeID", "sap:ContractRelatedID", "sap:LegalEntityID", "sap:DataControllerID", "sap:UserID", "sap:EndOfBusinessDate", "sap:BlockingDate", "sap:EndOfRetentionDate"]
------ Schema --------
x-sap-stateInfo ['state', 'deprecationDate', 'decomissionedDate', 'link']
x-sap-ext-overview ['name', 'values']
x-sap-deprecated-operation ['deprecationDate', 'successorOperationRef', "successorOperationId"]
x-sap-odm-semantic-key ['name', 'values']

Copy link
Collaborator

@jeevitha011 jeevitha011 left a comment

Choose a reason for hiding this comment

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

lgtm

@RoshniNaveenaS RoshniNaveenaS merged commit 2a4934c into main Dec 1, 2024
4 checks passed
@RoshniNaveenaS RoshniNaveenaS deleted the openapiExtension branch December 1, 2024 06:19
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.

2 participants