feat: expose JSON Schema through API #1592

nic-chen · 2021-03-14T16:02:49Z

Please answer these questions before submitting a pull request

Why submit this pull request?
Bugfix
New feature provided
Improve performance
Backport patches
Related issues
close feat: support exposing schema of route, upstream, service and ssl through Manager API #1450

New feature or improvement

Describe the details and related test reports.

The APISIX ingress controller needs to use the json schema (dashboard FE or other projects may also need it), and it still use the admin api interface.
At present, the manager api only supports to expose the json schema of plugins.

so we now support exposing JSON Schema of all resources and plugins through API

Please add the corresponding test cases if necessary.

added.

juzhiyuan · 2021-03-14T16:04:46Z

also cc @guoqqqi to review

codecov-io · 2021-03-14T16:10:41Z

Codecov Report

Merging #1592 (8edf1a9) into master (01c9528) will increase coverage by 1.12%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1592      +/-   ##
==========================================
+ Coverage   71.46%   72.58%   +1.12%     
==========================================
  Files         132       86      -46     
  Lines        5375     2356    -3019     
  Branches      592      592              
==========================================
- Hits         3841     1710    -2131     
+ Misses       1290      646     -644     
+ Partials      244        0     -244

Flag	Coverage Δ
backend-e2e-test	`?`
backend-e2e-test-ginkgo	`?`
backend-unit-test	`?`
frontend-e2e-test	`72.58% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
api/internal/filter/cors.go
api/internal/utils/utils.go
api/internal/handler/tool/tool.go
api/internal/handler/healthz/healthz.go
api/internal/core/store/validate.go
api/internal/handler/handler.go
api/internal/handler/data_loader/route_import.go
api/internal/handler/data_loader/route_export.go
api/internal/core/storage/etcd.go
api/internal/conf/conf.go
... and 34 more

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 01c9528...8edf1a9. Read the comment docs.

bisakhmondal

Great work 👍
Just minor changes

bisakhmondal · 2021-03-14T18:52:24Z

api/test/e2enew/schema/plugin_test.go

+	"github.com/onsi/ginkgo"
+	"github.com/onsi/ginkgo/extensions/table"
+
+	"e2enew/base"


e2enew module path has been updated in #1578

Suggested change

"e2enew/base"

"github.com/apisix/manager-api/test/e2enew/base"

api/test/e2enew/schema/schema_test.go

moonming · 2021-03-15T00:31:04Z

why this PR will decrease coverage by 12.25%？

nic-chen · 2021-03-15T01:39:25Z

why this PR will decrease coverage by 12.25%？

Because the coverage of the last PR merged into the master only counts the coverage of frontend-e2e-test, see:

#1587 (comment)

And in this PR it’s calculated
The coverage of frontend-e2e-test and backend-e2e-test, so the statistical result is decreased.

We have contacted codecov to see if we can solve this unstable problem.

starsz · 2021-03-15T01:45:47Z

api/internal/handler/schema/plugin.go

-		if res, ok := conf.Plugins[pluginName]; !ok || !res {
-			continue
+		if pluginName != "serverless-post-function" && pluginName != "serverless-pre-function" {
+			ret = append(ret, pluginName)


The logic had changed？

api/internal/handler/schema/plugin_test.go

api/internal/handler/schema/schema.go

starsz · 2021-03-15T01:48:31Z

api/test/e2enew/schema/schema_suite_test.go

@@ -23,5 +23,5 @@ import (
 )

 func TestPlugin(t *testing.T) {


Rename to TestSchema?

gxthrj

LGTM

api/internal/handler/schema/schema.go

starsz · 2021-03-16T06:11:24Z

@LiteSun Help looks at the Frontend CI.

LiteSun · 2021-03-16T06:42:03Z

@LiteSun Help looks at the Frontend CI.

OK, I will check it.

tokers · 2021-03-16T12:21:42Z

api/internal/handler/schema/schema.go

+func (h *SchemaHandler) Schema(c droplet.Context) (interface{}, error) {
+	input := c.Input().(*SchemaInput)
+
+	ret := conf.Schema.Get("main." + input.Resource).Value()


Wht not return an error like "schema not found" when the schema doesn't exist.

updated. thanks.

tokers · 2021-03-16T12:22:39Z

api/test/e2enew/schema/plugin_test.go

+	table.DescribeTable("test plugin basic", func(testCase base.HttpTestCase) {
+		base.RunTestCase(testCase)
+	},
+		table.Entry("get all plugins", base.HttpTestCase{


Keep the indent aligned with table.DescribeTable.

oh, this is formatted by go fmt @tokers

LiteSun · 2021-03-17T01:40:14Z

FE CI failed and I will check it. https://github.com/apache/apisix-dashboard/pull/1592/checks?check_run_id=2126651425

Jaycean

LGTM

bzp2010

😆👍

feat: expose JSON Schema through API

dd1740b

juzhiyuan requested review from starsz, gxthrj and LiteSun March 14, 2021 16:04

bisakhmondal reviewed Mar 14, 2021

View reviewed changes

fix CI failed

314eead

starsz reviewed Mar 15, 2021

View reviewed changes

johzchen added 3 commits March 15, 2021 10:28

fix: review

894ed4a

Merge branch 'master' into expose-schema

63e53bc

fix ExpectBody

eb2b1ca

gxthrj approved these changes Mar 15, 2021

View reviewed changes

starsz reviewed Mar 16, 2021

View reviewed changes

api/internal/handler/schema/schema.go Show resolved Hide resolved

fix: code style

e19c888

nic-chen requested review from starsz, imjoey, Jaycean and tokers March 16, 2021 09:02

tokers reviewed Mar 16, 2021

View reviewed changes

johzchen added 3 commits March 16, 2021 22:07

fix review

1c31f88

fix: unit test failed

73495e3

fix: code style

d8247ce

starsz approved these changes Mar 17, 2021

View reviewed changes

Jaycean approved these changes Mar 17, 2021

View reviewed changes

nic-chen requested a review from tokers March 17, 2021 02:45

bzp2010 approved these changes Mar 17, 2021

View reviewed changes

LiteSun and others added 4 commits March 17, 2021 15:40

feat: enhance serch route testcase

c2ef358

Merge branch 'master' into expose-schema

b91aff7

fix: FE ci

4c754de

Update import_export_route.spec.js

8edf1a9

LiteSun merged commit 4b8774f into apache:master Mar 17, 2021

nic-chen deleted the expose-schema branch March 17, 2021 16:04

mscb402 mentioned this pull request Feb 9, 2023

fix: Plugin disable invalid in API /plugin?all=true #2737

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: expose JSON Schema through API #1592

feat: expose JSON Schema through API #1592

nic-chen commented Mar 14, 2021

juzhiyuan commented Mar 14, 2021

codecov-io commented Mar 14, 2021 •

edited

Loading

bisakhmondal left a comment

bisakhmondal Mar 14, 2021

moonming commented Mar 15, 2021

nic-chen commented Mar 15, 2021

starsz Mar 15, 2021

nic-chen Mar 15, 2021

starsz Mar 15, 2021

nic-chen Mar 15, 2021

gxthrj left a comment

starsz commented Mar 16, 2021

LiteSun commented Mar 16, 2021

tokers Mar 16, 2021

nic-chen Mar 16, 2021

tokers Mar 16, 2021

nic-chen Mar 16, 2021

LiteSun commented Mar 17, 2021

Jaycean left a comment

bzp2010 left a comment •

edited

Loading

	"e2enew/base"
	"github.com/apisix/manager-api/test/e2enew/base"

feat: expose JSON Schema through API #1592

feat: expose JSON Schema through API #1592

Conversation

nic-chen commented Mar 14, 2021

New feature or improvement

Please add the corresponding test cases if necessary.

juzhiyuan commented Mar 14, 2021

codecov-io commented Mar 14, 2021 • edited Loading

Codecov Report

bisakhmondal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moonming commented Mar 15, 2021

nic-chen commented Mar 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gxthrj left a comment

Choose a reason for hiding this comment

starsz commented Mar 16, 2021

LiteSun commented Mar 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LiteSun commented Mar 17, 2021

Jaycean left a comment

Choose a reason for hiding this comment

bzp2010 left a comment • edited Loading

Choose a reason for hiding this comment

codecov-io commented Mar 14, 2021 •

edited

Loading

bzp2010 left a comment •

edited

Loading