GET /v3/apps/:guid/routes accepts include but ignores it

Aperta Adatta ai principianti
#5,560 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
ruby
Ambito
api, backend

Direzione di ricerca

Inizia da index_by_app in app/controllers/v3/routes_controller.rb e confrontalo con index, che applica già i decorator in base a message.include. Controlla le specifiche delle richieste del controller delle route per entrambi gli endpoint e la documentazione dell’endpoint in docs/v3/source/includes/resources/routes/_list_for_app.md.erb. Il lavoro è completo quando l’endpoint delle route dell’app gestisce i parametri include validi in modo coerente con l’endpoint generale delle route e il comportamento è riportato nella documentazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

GET /v3/routes?include=domain returns the domains under included; GET /v3/apps/:guid/routes?include=domain returns 200 with no included at all.

Both actions build a RoutesListMessage, which allows and validates include (routes_list_message.rb:12,19):

validates_with IncludeParamValidator, valid_values: ['domain', 'space', 'space.organization', 'route_policies']

index turns it into decorators (routes_controller.rb:46-50):

decorators = []
decorators << IncludeRouteDomainDecorator if IncludeRouteDomainDecorator.match?(message.include)
decorators << IncludeSpaceDecorator if IncludeSpaceDecorator.match?(message.include)
decorators << IncludeOrganizationDecorator if IncludeOrganizationDecorator.match?(message.include)
decorators << IncludeRoutePoliciesDecorator if IncludeRoutePoliciesDecorator.match?(message.include)

index_by_app (routes_controller.rb:299-327) validates the same message and renders PaginatedListPresenter without decorators:, so a valid include is accepted and dropped.

The v3 docs for this endpoint don't list include (routes/_list_for_app.md.erb), so either fix is consistent with them: apply the same decorators in index_by_app (and document include), or reject include there. Applying them seems the expected behaviour, since every other route list supports it. Happy to send a PR for whichever you prefer.

Found with a contract check of the v3 docs, the OpenAPI spec and the request messages (see #5496).

Lingua principale
Ruby
Stelle
208
Fork
374
Merge medio
2g 17h
PR unite (30g)
78

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cloudfoundry/cloud_controller_ng

Tutte le issue di cloudfoundry/cloud_controller_ng

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.