You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ti...@apache.org on 2019/10/29 09:23:05 UTC
[servicecomb-kie] branch master updated: change wrong copyright
(#49)
This is an automated email from the ASF dual-hosted git repository.
tianxiaoliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-kie.git
The following commit(s) were added to refs/heads/master by this push:
new 5247704 change wrong copyright (#49)
5247704 is described below
commit 5247704cf7318dc02ec5bddbf38af4876d789ad4
Author: Shawn <xi...@gmail.com>
AuthorDate: Tue Oct 29 17:22:56 2019 +0800
change wrong copyright (#49)
* change wrong copyright
* change readme, and fix wrong API doc
---
README.md | 8 +-
docs/README.md | 4 +-
docs/conf.py | 6 +-
server/resource/v1/kv_resource.go | 1 -
swagger/servicecomb-kie.yaml | 235 --------------------------------------
5 files changed, 10 insertions(+), 244 deletions(-)
diff --git a/README.md b/README.md
index ba4b88d..f3bf240 100644
--- a/README.md
+++ b/README.md
@@ -90,10 +90,12 @@ this will generate a "servicecomb-kie-0.0.1-linux-amd64.tar" in "release" folder
and a docker image "servicecomb/kie:0.0.1"
# API Doc
-swagger/servicecomb-kie.yaml
-
+After you launch kie server, you can browse API doc in http://127.0.0.1:30110/apidocs,
+copy this doc to http://editor.swagger.io/
# Documentations
-follow [here](docs/README.md) to generate it in local
+https://servicecomb.apache.org/docs/users/
+
+or follow [here](docs/README.md) to generate it in local
## Contact
diff --git a/docs/README.md b/docs/README.md
index b7dab2a..eae6341 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -21,10 +21,10 @@ make.bat html
In linux
```shell
cd docs
-make html
+make html
```
## Check the result
1. See html pages in _build folder
-1. You can start a http server using `python -m http.server` which will serve at http://0.0.0.0:8000/.
+2. You can start a http server using `python -m http.server` which will serve at http://0.0.0.0:8000/.
diff --git a/docs/conf.py b/docs/conf.py
index f20b763..432b9ac 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -38,8 +38,8 @@ import sphinx_rtd_theme
# -- Project information -----------------------------------------------------
project = u'servicecomb-kie'
-copyright = u'2018, xiaoliang'
-author = u'xiaoliang'
+copyright = u'2019-2019, The Apache Software Foundation'
+author = u'The Apache Software Foundation'
# The short X.Y version
version = u''
@@ -160,7 +160,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'servicecomb-kie.tex', u'servicecomb-kie Documentation',
- u'xiaoliang', 'manual'),
+ u'The Apache Software Foundation', 'manual'),
]
diff --git a/server/resource/v1/kv_resource.go b/server/resource/v1/kv_resource.go
index 788478a..92cad46 100644
--- a/server/resource/v1/kv_resource.go
+++ b/server/resource/v1/kv_resource.go
@@ -240,7 +240,6 @@ func (r *KVResource) URLPatterns() []restful.Route {
},
Consumes: []string{goRestful.MIME_JSON, common.ContentTypeYaml},
Produces: []string{goRestful.MIME_JSON, common.ContentTypeYaml},
- Read: &KVBody{},
}, {
Method: http.MethodGet,
Path: "/v1/{project}/kie/kv",
diff --git a/swagger/servicecomb-kie.yaml b/swagger/servicecomb-kie.yaml
deleted file mode 100644
index 3a09dd0..0000000
--- a/swagger/servicecomb-kie.yaml
+++ /dev/null
@@ -1,235 +0,0 @@
-# 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.
-
-swagger: "2.0"
-info:
- title: ""
- version: ""
-basePath: /
-paths:
- /v1/{project}/kie/kv:
- get:
- summary: search key values by labels combination
- operationId: SearchByLabels
- parameters:
- - name: q
- in: query
- description:
- "the combination format is {label_key}:{label_value}+{label_key}:{label_value}
- for example: /v1/test/kie/kv?q=app:mall&q=app:mall+service:cart that will query key
- values from 2 kinds of labels"
- type: string
- consumes:
- - application/json
- produces:
- - application/json
- responses:
- "200":
- description: get key value success
- schema:
- type: array
- items:
- $ref: "#/definitions/KVResponse"
- /v1/{project}/kie/kv/{key}:
- get:
- summary: get key values by key and labels
- operationId: GetByKey
- parameters:
- - name: project
- in: path
- required: true
- type: string
- - name: key
- in: path
- required: true
- type: string
- - name: X-Depth
- in: header
- description:
- integer, default is 1, if you set match policy, you can set,depth
- to decide label number
- type: string
- - name: body
- in: body
- required: true
- schema:
- $ref: "#/definitions/*v1.KVBody"
- consumes:
- - application/json
- produces:
- - application/json
- responses:
- "200":
- description: get key value success
- schema:
- type: array
- items:
- $ref: "#/definitions/KVResponse"
- put:
- summary: create or update key value
- operationId: Put
- parameters:
- - name: project
- in: path
- required: true
- type: string
- - name: key
- in: path
- required: true
- type: string
- - name: X-Realm
- in: header
- description: set kv to heterogeneous config server, not implement yet
- type: string
- - name: body
- in: body
- required: true
- schema:
- $ref: "#/definitions/v1.KVBody"
- consumes:
- - application/json
- produces:
- - application/json
- responses:
- "200":
- description: "true"
- /v1/{project}/kie/kv/{kvID}:
- delete:
- summary:
- Delete key by kvID and labelID,If the labelID is nil, query the collection
- kv to get it.It means if only get kvID, it can also delete normally.But if
- you want better performance, you need to pass the labelID
- operationId: Delete
- parameters:
- - name: project
- in: path
- required: true
- type: string
- - name: key
- in: path
- required: true
- type: string
- responses:
- "204":
- description: Delete success
- "400":
- description: Failed,check url
- "500":
- description: Server error
- /v1/{project}/kie/revision/{label_id}:
- get:
- summary: get history revisions by label id
- operationId: GetRevisionsByLabelID
- parameters:
- - name: project
- in: path
- required: true
- type: string
- - name: label_id
- in: path
- required: true
- type: string
- consumes:
- - application/json
- produces:
- - application/json
- responses:
- "200":
- description: get history revisions success
- schema:
- type: array
- items:
- $ref: "#/definitions/LabelRevisionResponse"
- "403":
- description: label_id must not be empty
- "404":
- description: no revisions found
- "500":
- description: internal server error
-
-definitions:
- KVDoc:
- type: object
- properties:
- _id:
- type: array
- items:
- type: integer
- format: byte
- check:
- type: string
- domain:
- type: string
- key:
- type: string
- label_id:
- type: string
- labels:
- type: object
- additionalProperties:
- type: string
- revision:
- type: integer
- format: int32
- value:
- type: string
- value_type:
- type: string
- KVResponse:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: "#/definitions/KVDoc"
- label:
- $ref: "#/definitions/LabelDocResponse"
- LabelDocResponse:
- type: object
- properties:
- label_id:
- type: string
- labels:
- type: object
- additionalProperties:
- type: string
- LabelRevisionResponse:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: "#/definitions/KVDoc"
- label_id:
- type: string
- labels:
- type: object
- additionalProperties:
- type: string
- revision:
- type: integer
- format: int32
-
- v1.KVBody:
- type: object
- properties:
- labels:
- type: object
- additionalProperties:
- type: string
- value:
- type: string
- valueType:
- type: string