cloudfoundry / cloudfoundry/cloud_controller_ng

No application summary in v3 API

Open
#1,990 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Issue

Missing application summary in v3 API

Context

Hello folks,

We're migrating from v2 to v3 API and our code depends on the application summary resource in several places since everything about the application is required in certain scenarios and it is the fastest and also an elegant way to get the full information about an application with only 1 call (https://apidocs.cloudfoundry.org/15.2.0/apps/get_app_summary.html). If we try to gather this information by using the v3 API and executing separate calls for everything required like env, service instances, routes, domains, buildpacks, packages, etc. it gets much slower and generates quite a lot of calls which may easily result in exceeding the rate limits for some users. Is there a way to achieve the result returned from v2/app/GUID/summary by using the v3 API somehow?
I've checked the "include" parameter but it only supports: 'space', 'org', 'space.organization', which unfortunately is not enough. I've also noticed the "fields" parameters for service but it is only supported for: service instances, shared spaces, service offerings, and service plans. Is it possible for this parameter to be integrated with the apps? Is there a way to bring back the application summary response as it very optimal in certain cases?

Thanks and best regards,
Ivan

Steps to Reproduce

Try to get the full information about an application with as few calls as possible (preferably 1).

Expected result

Similar response as in the v2/apps/GUID/summary

Current result

No way to get similar full information about an application

Possible Fix

Probably the parameters "fields" may work for apps and may include more resources or "includes" may include more parameters. Or implementing a similar resource like the v2 apps summary?

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 by comparing the v2/apps/GUID/summary response with the v3 application endpoint and its current include and fields parameters. Review how v3 exposes environment, service instances, routes, domains, buildpacks, and packages, then determine whether a summary endpoint or expanded fields are appropriate. Done means documenting or implementing a way to obtain the required application information with fewer calls.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.