Skip to content

API gateway: api-keys in webserver, gateway services and client sdk #1460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 33 commits into from
Apr 28, 2020
Merged

API gateway: api-keys in webserver, gateway services and client sdk #1460

merged 33 commits into from
Apr 28, 2020

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented Apr 23, 2020 •
edited
Loading

What do these changes do?

  • webserver service:
    • frontend UI to add API keys (by @odeimaiz )
    • extends API specs auth section: see auth/api-keys path
  • api-gateway service:
    • exposes basic API with two resources: me and studies (dummy handles in this PR)
    • customized autodoc with vendor extensions e.g. logo or client-sdk examples
    • drafts client-sdk calls (marked as tests to skip for this PR)
    • still not part of the swarm in this PR
    • only roles>=USER can create API keys

Related issue number

part of #1268
part of #1269

How to test

make devenv
cd services/api-gateway
make install-dev tests
cd ../web/server
make devenv
make install-dev tests

Checklist

  • Did you change any service's API? Then make sure to bundle document and upgrade version (make openapi-specs, git commit ... and then make version-*)
  • Unit tests for the changes exist
  • Runs in the swarm
  • Documentation reflects the changes
  • New module? Add your github username to .github/CODEOWNERS

@codecov
Copy link

codecov bot commented Apr 23, 2020 •
edited
Loading

Codecov Report

Merging #1460 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1460   +/-   ##
=======================================
  Coverage   52.55%   52.55%           
=======================================
  Files          32       32           
  Lines         666      666           
  Branches       33       33           
=======================================
  Hits          350      350           
  Misses        310      310           
  Partials        6        6

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 00e9bf6...00e9bf6. Read the comment docs.

@pcrespov pcrespov changed the title api gateway and client sdk WIP: api gateway and client sdk Apr 23, 2020
@pcrespov pcrespov force-pushed the is1268/api-gateway branch from 0f349a4 to c8626ef Compare April 28, 2020 05:24
@pcrespov pcrespov self-assigned this Apr 28, 2020
@pcrespov pcrespov added this to the Zhong Zi milestone Apr 28, 2020
pcrespov added 23 commits April 28, 2020 08:23
@pcrespov
Infra fixes
021a89c
@pcrespov
Fixes make run-devel
50f2687 
 - sets up a system with environs for devel
 -
@pcrespov
api_version_prefix by api_vtag
29c4d35
@pcrespov
Fixes start_db not called
3a80a36
@pcrespov
Add helpers for fastapi
6547e7a
@pcrespov
Using new shortcuts
e976ef5
@pcrespov
Fixes logging
31cffe8
@pcrespov
Doc and minor cleanup
ef9aa0a 
- logging
- fixes tests
- / and /health untagged
@pcrespov
Bump version: 0.1.0 → 0.1.1
59487c3
@pcrespov
improves make info and formatting
2684511
@pcrespov
redoc: adds vender extensions
85f9985
@pcrespov
Minor
820e59e
@pcrespov
Drafting client api sdk
36e14c3
@pcrespov
Kills processes in 8001 upon make down
606e3b8
@pcrespov
Defining API entrypoints
04ce0fc
@pcrespov
minimum tests pass
c8f3b2a
@pcrespov
fixes frontend linter
5f10ab5
@pcrespov
Minor
940b0fe
@pcrespov
Cleanup front-end messages/labels
d06526f
@pcrespov
Adds new table for client credentials api_keys
c152577
@pcrespov
Added api-keys section on webserver API
c5b7c54
@pcrespov
Minors
2941e63
@pcrespov
Adding api-keys handlers
7385de9
@pcrespov pcrespov force-pushed the is1268/api-gateway branch from c8626ef to 7385de9 Compare April 28, 2020 11:40
@pcrespov pcrespov marked this pull request as ready for review April 28, 2020 13:48
@pcrespov pcrespov changed the title WIP: api gateway and client sdk API gateway: API-keys in webserver, gateway services and client sdk Apr 28, 2020
@pcrespov pcrespov requested review from sanderegg, mguidon and GitHK April 28, 2020 13:49
@pcrespov pcrespov requested a review from odeimaiz April 28, 2020 14:46
odeimaiz
odeimaiz approved these changes Apr 28, 2020
View reviewed changes
Copy link
Member

@odeimaiz odeimaiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Frontend looks very very good

@pcrespov pcrespov changed the title API gateway: API-keys in webserver, gateway services and client sdk API gateway: api-keys in webserver, gateway services and client sdk Apr 28, 2020
sanderegg
sanderegg approved these changes Apr 28, 2020
View reviewed changes
Copy link
Member

@sanderegg sanderegg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@pcrespov pcrespov merged commit b234629 into ITISFoundation:master Apr 28, 2020
@pcrespov pcrespov deleted the is1268/api-gateway branch April 28, 2020 15:37
@sanderegg sanderegg mentioned this pull request May 26, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@odeimaiz odeimaiz odeimaiz approved these changes

@sanderegg sanderegg sanderegg approved these changes

@mguidon mguidon Awaiting requested review from mguidon

@GitHK GitHK Awaiting requested review from GitHK GitHK is a code owner

Assignees

@pcrespov pcrespov

Labels
None yet
Projects
None yet
Milestone
Zhong Zi
Development

Successfully merging this pull request may close these issues.
3 participants
@pcrespov @odeimaiz @sanderegg