Skip to content

azammel-reply/poc-api-3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

poc-api-3 — User Management API

Internal IAM API for managing user accounts, roles, and permissions.

📋 Status

Item Status
OpenAPI Spec specs/openapi.yaml (OAS 3.0)
Spectral Linting ✅ Automated via GitHub Actions
Kong Gateway Not deployed — Design Only
Dashboard ✅ Appears on Governance Hub

🔍 What this PoC demonstrates

This API is intentionally not deployed on Kong Konnect, to showcase the dashboard's ability to differentiate between:

  • Design-time governance (Spectral linting, API scoring)
  • Runtime governance (Kong plugins, traffic analytics)

On the dashboard, this API will appear with:

  • Design Only status (no Kong runtime)
  • None plugins
  • - traffic
  • A governance score based purely on OpenAPI spec quality

🏗️ API Endpoints

Method Path Description
GET /users List all users (paginated)
POST /users Create a new user
GET /users/{userId} Get user by ID
PUT /users/{userId} Update user
DELETE /users/{userId} Delete user
GET /users/{userId}/roles Get user roles
POST /users/{userId}/roles Assign a role

🚀 Running the Linter Locally

npx -y @stoplight/spectral-cli lint specs/openapi.yaml \
  -r https://raw.githubusercontent.com/azammel-reply/central-hub-gouv-poc/main/rulesets/owasp23-ruleset.spectral.yml

About

PoC API 3 — User Management API (Design Only, not deployed on Kong)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors