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

isDerived property of a UML attribute - API gen behaviour #145

Open
onthebreeze opened this issue May 23, 2021 · 1 comment
Open

isDerived property of a UML attribute - API gen behaviour #145

onthebreeze opened this issue May 23, 2021 · 1 comment
Assignees

Comments

@onthebreeze
Copy link
Contributor

In many cases there are some fields in an API response that are determined by the back end and, although they are visible in a GET, the cannot be created or modified (in POSt/PUT/PATCH). Examples are things like "status" (of back end processing) or "versionID" (automatically updated), etc.

Suggest we use the "isDerived" property of a starUML attribute to drive Open API generation. when an attribute is marked with "isDerived" then

  • it appears in GET operation responses
  • it is not in the data model of POST/PATCH/PUT operations.
@kshychko
Copy link
Contributor

After discussion it has been agreed to use isReadOnly property, as it aligns with OpenAPI readOnly flag for properties.

@kshychko kshychko assigned onthebreeze and unassigned kshychko May 26, 2021
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

No branches or pull requests

2 participants