You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/05/18 06:53:05 UTC
[GitHub] [apisix-ingress-controller] neverCase opened a new pull request, #1025: doc: add apisix_pluginconfig document
neverCase opened a new pull request, #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025
<!-- Please answer these questions before submitting a pull request -->
### Type of change:
<!-- Please delete options that are not relevant. -->
- [ ] Bugfix
- [x] New feature provided
- [ ] Improve performance
- [ ] Backport patches
### What this PR does / why we need it:
issue: #638
### Pre-submission checklist:
<!--
Please follow the requirements:
1. Use Draft if the PR is not ready to be reviewed
2. Test is required for the feat/fix PR, unless you have a good reason
3. Doc is required for the feat PR
4. Use a new commit to resolve review instead of `push -f`
5. Use "request review" to notify the reviewer once you have resolved the review
-->
* [ ] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [ ] Have you modified the corresponding document?
* [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix-ingress-controller#community) first**
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] neverCase commented on pull request #1025: doc: add apisix_pluginconfig document
Posted by GitBox <gi...@apache.org>.
neverCase commented on PR #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025#issuecomment-1129649530
@tao12345666333
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] neverCase commented on a diff in pull request #1025: doc: add apisix_pluginconfig document
Posted by GitBox <gi...@apache.org>.
neverCase commented on code in PR #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025#discussion_r877681226
##########
docs/en/latest/references/apisix_pluginconfig.md:
##########
@@ -0,0 +1,33 @@
+---
+title: ApisixPluginConfig/v2beta3 Reference
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Spec
+
+Spec describes the desired state of an ApisixPluginConfig object.
+
+| Field | Type | Description |
+|---------------|----------|----------------------------------------------------|
+| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
+| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
+| plugins[].enable | boolean | Whether the plugin is in use |
Review Comment:
ok, i will open another one
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tao12345666333 commented on a diff in pull request #1025: doc: add apisix_pluginconfig document
Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on code in PR #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025#discussion_r876919702
##########
docs/en/latest/references/apisix_pluginconfig.md:
##########
@@ -0,0 +1,33 @@
+---
+title: ApisixPluginConfig/v2beta3 Reference
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Spec
+
+Spec describes the desired state of an ApisixPluginConfig object.
+
+| Field | Type | Description |
+|---------------|----------|----------------------------------------------------|
+| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
+| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
+| plugins[].enable | boolean | Whether the plugin is in use |
Review Comment:
@neverCase PTAL
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] neverCase commented on pull request #1025: doc: add apisix_pluginconfig document
Posted by GitBox <gi...@apache.org>.
neverCase commented on PR #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025#issuecomment-1129732438
> thanks
>
> You should modify this file also https://github.com/apache/apisix-ingress-controller/blob/master/docs/en/latest/config.json
ok
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] juzhiyuan commented on a diff in pull request #1025: doc: add apisix_pluginconfig document
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025#discussion_r877677477
##########
docs/en/latest/references/apisix_pluginconfig.md:
##########
@@ -0,0 +1,33 @@
+---
+title: ApisixPluginConfig/v2beta3 Reference
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Spec
+
+Spec describes the desired state of an ApisixPluginConfig object.
+
+| Field | Type | Description |
+|---------------|----------|----------------------------------------------------|
+| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
+| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
+| plugins[].enable | boolean | Whether the plugin is in use |
Review Comment:
I will merge first, for those small suggestions @neverCase could help to create a new PR :)
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] juzhiyuan commented on a diff in pull request #1025: doc: add apisix_pluginconfig document
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025#discussion_r876869760
##########
docs/en/latest/references/apisix_pluginconfig.md:
##########
@@ -0,0 +1,33 @@
+---
+title: ApisixPluginConfig/v2beta3 Reference
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Spec
+
+Spec describes the desired state of an ApisixPluginConfig object.
+
+| Field | Type | Description |
+|---------------|----------|----------------------------------------------------|
+| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
+| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
+| plugins[].enable | boolean | Whether the plugin is in use |
+| plugins[].config | object | The plugin configuration, fields should be same as in APISIX. |
Review Comment:
```suggestion
| plugins[].config | object | The plugin configuration, and fields should be the same as in APISIX. |
```
##########
docs/en/latest/references/apisix_pluginconfig.md:
##########
@@ -0,0 +1,33 @@
+---
+title: ApisixPluginConfig/v2beta3 Reference
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Spec
+
+Spec describes the desired state of an ApisixPluginConfig object.
+
+| Field | Type | Description |
+|---------------|----------|----------------------------------------------------|
+| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
+| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
+| plugins[].enable | boolean | Whether the plugin is in use |
Review Comment:
```suggestion
| plugins[].enable | boolean | Whether the plugin should be enabled |
```
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] juzhiyuan merged pull request #1025: doc: add apisix_pluginconfig document
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #1025:
URL: https://github.com/apache/apisix-ingress-controller/pull/1025
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org