Settings for scaffolding out an entity for your BFF.
While you app won't be made up of strictly CRUD based and scaffolded items, this template should help you get some of the boilerplate out of the way
| Name | Required | Description | Default |
|---|---|---|---|
| Name | Yes | The name of the entity | None |
| Plural | No | The plural of the entity name, if needed (e.g. Cities would prevent Citys) | Entity Name appended with an s |
| Properties | Yes | A list of BFF entity properties assigned to your entity described in the entity properties section. | None |
| Features | Yes | This is a list of BFF features that you want to add for a particular entity. | None |
A list of properties that can be assigned to a BFF entity.
| Name | Required | Description | Default |
|---|---|---|---|
| Name | Yes | The name of the property | None |
| Type | Yes | The data type for the property. These are not case sensitive and they can be set to nullable with a trailing ?. All standard typescript data types can be used here. You can add custom types for items like foreign objects, but you'll need to do some manual resolution on these. | string |
💡 Add a
?at the end of the type to make the property nullable.
| Name | Required | Description | Default |
|---|---|---|---|
| Type | Yes | The type of feature you want to add. The accepted values are AdHoc, GetRecord, GetList, DeleteRecord, UpdateRecord, PatchRecord, AddRecord, and CreateRecord (same as AddRecord but available as an alias in case you can't remember!) | None |
| IsProtected | No | Determines whether or not the feature is protected with an authorization policy attribute. | false |
| PermissionName | No | The name of the authorization policy attribute. | Can[FEATURENAME] |
GetRecord, GetList, DeleteRecord, UpdateRecord, and AddRecord are all standard CRUD features along with their endpoints and associated tests. Additional
features from your boundary scaffolding need to be manually configured.
Entities:
- Name: Recipe
Features:
- Type: GetList
- Type: GetRecord
- Type: AddRecord
- Type: UpdateRecord
- Type: DeleteRecord
Properties:
- Name: Title
- Name: Directions
- Name: RecipeSourceLink
- Name: Description
- Name: ImageLink
- Name: Rating
Type: number?
- Name: Ingredient
Features:
- Type: GetList
- Type: GetRecord
- Type: AddRecord
- Type: UpdateRecord
- Type: DeleteRecord
Properties:
- Name: Title
- Name: Directions
- Name: RecipeSourceLink
- Name: Description
- Name: ImageLink
- Name: Rating
Type: number?