API keys: tidy up the routes #4555

ikapelyukhin · 2020-09-02T14:02:32Z

Description

A subset of API endpoints moved under /api/v1 and documented with Swagger.

Motivation and Context

#4532

How Has This Been Tested?

Tested manually & with existing test suite.

Types of changes

Bug fix (non-breaking change which fixes an issue)
Docs update
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have followed the guidelines in CONTRIBUTING.md, including the required formatting of the commit message

codecov-commenter · 2020-09-02T14:42:38Z

Codecov Report

Merging #4555 into master will decrease coverage by 0.09%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4555      +/-   ##
==========================================
- Coverage   58.50%   58.41%   -0.10%     
==========================================
  Files         883      883              
  Lines       29239    29298      +59     
  Branches     4234     4252      +18     
==========================================
+ Hits        17105    17113       +8     
- Misses      12134    12185      +51

richard-cox

Need to ...

associate with an issue as a breaking change, Neil or I will do this
decide what serves Swagger UI and how swagger.json is generated, Neil will do this
do a second pass to additional routes from from pp into api, I will create an issue for this
thoroughly test when ready to merge
- echo update related things, lile web sockets
- deployment mechanisms (cf push, AIO, etc) for swagger file changes

richard-cox · 2020-09-04T09:43:47Z

build/proxy.conf.localdev.js

@@ -12,6 +12,16 @@ const PROXY_CONFIG = {
    "ws": true,
    "secure": false,
    "changeOrigin": true,
+  },
+  "/api": {
+    "target": {


There's a node script ./build/dev-setup.js that copies this file to proxy.conf.js. For people who already have this their copy won't get update. The script should, if it already exists, replace "/pp" with `"/api".

Not all of the /pp endpoints have been migrated to /api, just the ones outlined in #4532. So replacing /pp with /api will break the leftover endpoints.

@nwmac hmm, should I add some fancy logic to ./build/dev-setup.js to add an /api section to proxy.conf.localdev.js if it's missing, or should this be left to the developer?

@ikapelyukhin I think we should add the fancy logic OR if that's a i real pain, a simpler option is:

if the file proxy.conf.js does not exist, create it as we do now

if proxy.conf.js exists but has not been changed (same MD5), then overwrite it with the new version

otherwise, warn the user that they need to update it manyally

OK, sounds reasonable, done.

richard-cox · 2020-09-04T10:09:42Z

src/jetstream/docs/swagger.json

@@ -0,0 +1,56 @@
+{


This file won't automatically be include when deployed, we'd need to ensure it gets included in container images.

It doesn't need to be deployed. There's docs/docs.go which is then served as /swagger/doc.json by the middleware.
Assuming that we want to use the middleware approach that is.

nwmac · 2020-09-04T10:29:14Z

@ikapelyukhin Had a look through with Richard - he's left some comments.

I like the godoc comments for the APIs - you mentioned that it doesn't support OpenAPI V3, specifically the bearer auth - one option would be to submit a PR to swaggo with support for that feature, if that is what is needed to use it.

I think there are two main use cases for the OpenAPI:

Generate static API documentation for inclusion in the stratos docs site (stratos.app) - I assume this would generate from swagger.json
Provide a UI that the user can use to browser and experiment with the API against their Stratos backend.

ikapelyukhin · 2020-09-04T10:40:17Z

I like the godoc comments for the APIs - you mentioned that it doesn't support OpenAPI V3, specifically the bearer auth - one option would be to submit a PR to swaggo with support for that feature, if that is what is needed to use it.

That'd probably result in a non-standard API doc (a mix of v2 and v3) -- that doesn't sound too thrilling.

Implementing a middleware for OpenAPI v3 or just bundling some front-end code to render the API doc seems like a more realistic solution.

* Provide a UI that the user can use to browser and experiment with the API against their Stratos backend.

@nwmac @richard-cox run the code from the current branch and see https://localhost:5443/swagger/index.html and https://localhost:5443/swagger/doc.json. Sorry, I should have probably mentioned that earlier.

ikapelyukhin · 2020-09-05T08:50:20Z

I've dropped docs/docs.go from the repo, now it's generated automatically during build and tests.

ikapelyukhin · 2020-09-23T21:57:29Z

curl commands for testing the API:

export API_SECRET='replaceme'
export USERNAME='replaceme'
export PASSWORD='replaceme'
export API_ENDPOINT='https://api.cap.explore.suse.dev/'

# add endpoint
curl -k -X POST "https://localhost:5443/api/v1/endpoints" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET" -F "endpoint_type=cf" -F "cnsi_name=Potato" -F "api_endpoint=$API_ENDPOINT"

# list endpoints
curl -k -X GET "https://localhost:5443/api/v1/endpoints" -H  "accept: application/json" -H "Authentication: Bearer $API_SECRET"

endpoint_guid=$(curl -k -X GET "https://localhost:5443/api/v1/endpoints" -H  "accept: application/json" -H "Authentication: Bearer $API_SECRET" | jq -r '.[] | select(.name=="Potato").guid')

# login to endpoint
curl -k -X POST "https://localhost:5443/api/v1/tokens" -H  "accept: application/json"  -H "Authentication: Bearer $API_SECRET" -F "cnsi_guid=$endpoint_guid" -F "system_shared=false" -F "connect_type=creds" -F "username=$USERNAME" -F "password=$PASSWORD"

# rename endpoint
curl -k -X POST "https://localhost:5443/api/v1/endpoints/$endpoint_guid" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET" -F "name=Endpoint McEndpointface"

# log out from endpoint
curl -k -X DELETE "https://localhost:5443/api/v1/tokens/$endpoint_guid" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET"

# delete endpoint
curl -k -X DELETE "https://localhost:5443/api/v1/endpoints/$endpoint_guid" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET"

ikapelyukhin · 2020-09-28T09:24:07Z

curl commands with JSON bodies:

export API_SECRET='replaceme'
export USERNAME='replaceme'
export PASSWORD='replaceme'
export API_ENDPOINT='https://api.cap.explore.suse.dev/'

# add endpoint
curl -k -X POST "https://localhost:5443/api/v1/endpoints" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET" -H "Content-Type: application/json" -d "{\"endpoint_type\":\"cf\",\"cnsi_name\":\"Potato\",\"api_endpoint\":\"$API_ENDPOINT\"}"

# list endpoints
curl -k -X GET "https://localhost:5443/api/v1/endpoints" -H  "accept: application/json" -H "Authentication: Bearer $API_SECRET"

endpoint_guid=$(curl -k -X GET "https://localhost:5443/api/v1/endpoints" -H  "accept: application/json" -H "Authentication: Bearer $API_SECRET" | jq -r '.[] | select(.name=="Potato").guid')

# login to endpoint
curl -k -X POST "https://localhost:5443/api/v1/tokens" -H  "accept: application/json"  -H "Authentication: Bearer $API_SECRET" -H "Content-Type: application/json" -d "{\"cnsi_guid\":\"$endpoint_guid\",\"system_shared\":\"false\",\"connect_type\":\"creds\",\"username\":\"$USERNAME\",\"password\":\"$PASSWORD\"}"

# rename endpoint
curl -k -X POST "https://localhost:5443/api/v1/endpoints/$endpoint_guid" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET" -H "Content-Type: application/json" -d "{\"name\": \"Endpoint McEndpointface\"}"

# log out from endpoint
curl -k -X DELETE "https://localhost:5443/api/v1/tokens/$endpoint_guid" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET"

# delete endpoint
curl -k -X DELETE "https://localhost:5443/api/v1/endpoints/$endpoint_guid" -H  "accept: application/json" -H  "Authentication: Bearer $API_SECRET"

nwmac

LGTM

ikapelyukhin force-pushed the api-keys-tidy-up-routes branch 2 times, most recently from bba394c to 295a030 Compare September 3, 2020 22:31

richard-cox changed the base branch from master to acme September 4, 2020 09:44

richard-cox changed the base branch from acme to master September 4, 2020 09:44

richard-cox suggested changes Sep 4, 2020

View reviewed changes

ikapelyukhin force-pushed the api-keys-tidy-up-routes branch from b351060 to 551d059 Compare September 5, 2020 00:43

ikapelyukhin added 8 commits September 24, 2020 12:50

Add APIKeysEnabled to /info, check it in the middleware

2acfd7d

Fix failing test

8940d39

Rename token endpoints

18e6cc5

Rename endpoint endpoints

c65452b

Fix e2e test helper

fae7780

Bump echo to v4 and add swaggo/swag

315192c

Generate OpenAPI docs during build; tidy up the dependencies

a06888a

Add annotations for exposed endpoints

9babf6a

ikapelyukhin force-pushed the api-keys-tidy-up-routes branch from 3ae4726 to 9babf6a Compare September 24, 2020 10:58

ikapelyukhin added 4 commits September 24, 2020 13:13

Fix failing frontend lint

8b41f79

Add support for JSON bodies

64360c3

Change bool type to string with Enums(true, false) in API spec

c824b15

Fix code broken due to masked variable

1efd381

ikapelyukhin marked this pull request as ready for review September 28, 2020 09:20

Use new config template to update local config

6d85f5d

ikapelyukhin requested a review from nwmac September 28, 2020 13:54

nwmac approved these changes Sep 29, 2020

View reviewed changes

ikapelyukhin merged commit 1d18271 into master Sep 29, 2020

ikapelyukhin deleted the api-keys-tidy-up-routes branch September 29, 2020 09:02

thomasmitchell mentioned this pull request Oct 23, 2020

SSO Auth Doesn't Work for Endpoints #4716

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API keys: tidy up the routes #4555

API keys: tidy up the routes #4555

ikapelyukhin commented Sep 2, 2020 •

edited

Loading

codecov-commenter commented Sep 2, 2020 •

edited

Loading

richard-cox left a comment

richard-cox Sep 4, 2020

ikapelyukhin Sep 4, 2020

ikapelyukhin Sep 28, 2020

nwmac Sep 28, 2020

ikapelyukhin Sep 28, 2020

richard-cox Sep 4, 2020

ikapelyukhin Sep 4, 2020

nwmac commented Sep 4, 2020

ikapelyukhin commented Sep 4, 2020

ikapelyukhin commented Sep 5, 2020

ikapelyukhin commented Sep 23, 2020

ikapelyukhin commented Sep 28, 2020 •

edited

Loading

nwmac left a comment

API keys: tidy up the routes #4555

API keys: tidy up the routes #4555

Conversation

ikapelyukhin commented Sep 2, 2020 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

codecov-commenter commented Sep 2, 2020 • edited Loading

Codecov Report

richard-cox left a comment

Choose a reason for hiding this comment

richard-cox Sep 4, 2020

Choose a reason for hiding this comment

ikapelyukhin Sep 4, 2020

Choose a reason for hiding this comment

ikapelyukhin Sep 28, 2020

Choose a reason for hiding this comment

nwmac Sep 28, 2020

Choose a reason for hiding this comment

ikapelyukhin Sep 28, 2020

Choose a reason for hiding this comment

richard-cox Sep 4, 2020

Choose a reason for hiding this comment

ikapelyukhin Sep 4, 2020

Choose a reason for hiding this comment

nwmac commented Sep 4, 2020

ikapelyukhin commented Sep 4, 2020

ikapelyukhin commented Sep 5, 2020

ikapelyukhin commented Sep 23, 2020

ikapelyukhin commented Sep 28, 2020 • edited Loading

nwmac left a comment

Choose a reason for hiding this comment

ikapelyukhin commented Sep 2, 2020 •

edited

Loading

codecov-commenter commented Sep 2, 2020 •

edited

Loading

ikapelyukhin commented Sep 28, 2020 •

edited

Loading