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

Reflect attribute/relationship capabilities in resource object schemas #1056

Open
maurei opened this issue Sep 1, 2021 · 2 comments
Open

Comments

@maurei
Copy link
Member

maurei commented Sep 1, 2021

Attribute capabilities will affect the listed properties in the attribute object of a resource object.

  • The AttrCapabilities.AllowView flag must be set for a field to be present in the schema associated to a GET operation.
  • The AttrCapabilities. AllowCreate flag must be set for a field to be present in the schema associated to a POST operation.
  • The AttrCapabilities.AllowChange flag must be set for a field to be present in the schema associated to a PATCH operation.

These flags are currently already parsed in the custom schema generation of the current integration, but thorough testing is required.

Note that filter/sort-ability/can-include are out of scope as this requires query parameters to be implemented, see #1058.

@maurei maurei added the OpenAPI label Sep 1, 2021
@bkoelman bkoelman changed the title Reflect attribute capabilities in resource object schemas Reflect attribute/relationship capabilities in resource object schemas Nov 8, 2022
@bkoelman
Copy link
Member

This should include relationship capabilities as well.

@bkoelman
Copy link
Member

This should include tests for get-only and set-only properties.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants