| --- |
| { |
| "title": "Help Action", |
| "language": "en" |
| } |
| --- |
| |
| <!-- |
| 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. |
| --> |
| |
| # Help Action |
| |
| ## Request |
| |
| `GET /rest/v1/help` |
| |
| ## Description |
| |
| Used to obtain help through fuzzy query. |
| |
| ## Path parameters |
| |
| None |
| |
| ## Query parameters |
| |
| * `query` |
| |
| Keywords to be matched, such as array and select. |
| |
| ## Request body |
| |
| None |
| |
| ## Response |
| |
| ``` |
| { |
| "msg":"success", |
| "code":0, |
| "data":{"fuzzy":"No Fuzzy Matching Topic","matching":"No Matching Category"}, |
| "count":0 |
| } |
| ``` |
| |
