[GitHub] [apisix-dashboard] juzhiyuan commented on a change in pull request #992: feat: use Swagger to maintain API document for Manager API

[GitBox <gi...@apache.org>]

juzhiyuan commented on a change in pull request #992:
URL: https://github.com/apache/apisix-dashboard/pull/992#discussion_r540722978



##########
File path: api/internal/handler/handler.go
##########
@@ -14,6 +14,24 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+// API doc of Manager API.
+//
+// Manager API directly operates ETCD and provides data management for APISIX, provides APIs for Front-end or other clients.

Review comment:
       Always Apache APISIX

##########
File path: api/internal/handler/upstream/upstream.go
##########
@@ -85,6 +85,40 @@ type ListInput struct {
 	store.Pagination
 }
 
+// swagger:operation GET /apisix/admin/upstreams getSSLList

Review comment:
       SSLList?

##########
File path: docs/api/api.md
##########
@@ -0,0 +1,359 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+# API doc of Manager API.
+Manager API directly operates ETCD and provides data management for APISIX, provides APIs for Front-end or other clients.

Review comment:
       Apache APISIX

##########
File path: docs/api/api.md
##########
@@ -0,0 +1,359 @@
+<!--

Review comment:
       This file is generated automatically or maintain by ourseleves?

##########
File path: docs/FAQ.zh-CN.md
##########
@@ -0,0 +1,74 @@
+<!--

Review comment:
       We don't have docs in Chinese anymore, please sync the latest codes from master.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org