cloudfoundry / cloudfoundry/stratos
V3 API: Update validation process
Open
Nobody has claimed this yet.
v3 api
- Dominant language
- TypeScript
- Stars
- 267
- Forks
- 137
- Avg merge
- 5h 14m
- Merged PRs (30d)
- 77
Description
- take into account new
relationsandincludes.- relations are what's included in the entity (request an app and it's space, get both entities in response)
- includes are urls to fetch related entities (request an app and in response get a url to fetch processes)
- at the moment we have have schema, which covers both relations and includes
- need do somehow split schema into two to cover both definitions
- from that need to be able to cover optional relations (current
includeRelations) and fetch missing relations when required
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
No files, tests, or entry points are named in the issue. First trace the V3 API validation schema and how relations, includes, includeRelations, and required relations are handled; done means separate schemas cover both definitions and optional or missing relations behave as specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100