cloudfoundry / cloudfoundry/stratos
Clarify entityKey vs entityType
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 267
- Forks
- 137
- Avg merge
- 5h 14m
- Merged PRs (30d)
- 77
Description
As the work on the extensions moves forward we need to be clear on the differences between entityKey and entityType.
Here is a short explanation:
entityType
The type of the entity.
Example:
Given the types of houses in Game of Thrones, the type could be:
- targaryen
- stark
- lannister
- greyjoy
entityKey
The key used to identify the entity in the app store. This is mostly going to be a combination of endpointType and entityType.
Example:
For an entity type of targaryen from the endpoint type house the key will be houseTargaryen.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Stratos extension documentation or user-facing references where entityKey and entityType are defined. Compare those references with the distinction and examples in this issue, then update the relevant documentation so both terms and their relationship are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100