How to use custom resource types in schema generation?

[lodi-g]

Hi,

Thanks for the lib. I was wondering how does one uses this with custom resource types?

The documentation mentions

Resource Type Limitations:
Default resource types (User, UserGroup, Application) are automatically included
Custom resource types must be referenced in action definitions
If a resource type is referenced but not defined in schemas, it gets an empty record shape

I am not sure I understand what is meant with "Custom resource types must be referenced in action definitions"?

I tried to generate a schema using the PetStore API test file that exists in the repository, and while the schema is correct, all the actions have the field appliesTo.resourceTypes set to Application. I would expect this value to either be Pet, User, or Application.

Thanks

[Swolebrain]

Sorry we missed this! What you need to do is make your OpenAPI spec define the cedar resource type that a particular endpoint targets. The openAPI converter will pick that up and put it in the schema and then this library will also pick that up and craft the correct resource type

This is an example of how you can express it in the openapi schema: https://github.com/verifiedpermissions/examples/blob/main/express-notebook-app/notebook-app-backend/api-spec.json#L27-L30

If you prefer your code to be the source of truth, here's an example of how you can add some openapi utilities to your express handlers so they generate the API spec as you want it: https://github.com/verifiedpermissions/examples/blob/main/express-notebook-app/notebook-app-backend/index.js

That index.js file above is all that's necessary to generate the openAPI spec I linked in the first link