mybuilder/kongfig

Use /<auth-type> endpoint to get all authentications

Open

#98 opened on Nov 10, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (373 stars) (78 forks)batch import
good first issuehelp wanted

Description

To get all the keys present in Kong, the approach currently being used is:

for_each consumer {
 GET /consumers/:consumer_id_or_name/<auth-type>
}

Recently in Kong, a number of endpoints have been added to auth plugins to ease This will make the process of getting all the keys much more efficient!

To not break things with different Kong versions out there, internally we could hit GET /<auth-type>, if a 404 is returned then we fall back on the iteration approach, but if we get a 200 then, we're good.

Thoughts?

Contributor guide

Tech stack
javascriptrest api
Domain
backendapiperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Kong API basicsHTTP status handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the current consumer iteration code (likely in a service or utility file) and identify where the GET /consumers/:id/<auth type> call is made. Investigate the Kong plugin endpoints documentation to confirm the availability of GET /<auth type> for each auth type. Implement a conditional request to the new endpoint first, falling back to the iteration if a 404 is returned.