cloudfoundry / cloudfoundry/cloud_controller_ng

No support for "include" for /v3/processes

Open
#1,422 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement PM Review unscheduled v3-only
Dominant language
Ruby
Stars
207
Forks
373
Avg merge
2d 12h
Merged PRs (30d)
56

Description

Issue

It seems that the V3 API has somewhat limited support for the include query parameter. When talking about the processes resource it's not supported at all whereas it makes a ton of sense to have it present so that one can obtain information about:

  1. The application to which this process is related
  2. The CF org & space in which the application resides
  3. The current process stats

This way it will be perfectly possible to obtain information for applications by sending just one instead of multiple requests enabling the implementation of dashboards etc. or even raising alerts for threshold being reached.

Context

Monitoring applications state for apps running in CF

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the /v3/processes API entry point and inspect how the include query parameter is handled for this resource. The requested result should include the related application, its Cloud Foundry organization and space, and current process stats in one request; verify the behavior with the relevant API tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.