Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Kong PDK v1.0 not updated #1132

Closed
radudd opened this issue Jan 28, 2019 · 3 comments
Closed

Documentation for Kong PDK v1.0 not updated #1132

radudd opened this issue Jan 28, 2019 · 3 comments

Comments

@radudd
Copy link

radudd commented Jan 28, 2019

  • https://docs.konghq.com/1.0.x/plugin-development/admin-api/
  • https://docs.konghq.com/1.0.x/plugin-development/custom-entities/

Summary

Old DAO has been removed in Kong 1.0 - https://github.com/Kong/kong/blob/master/CHANGELOG.md#100, but the documentation still mentioned to use it.

The old DAO implementation is removed, along with the old schema validation library (apis was the last entity using it). Use the new schema format instead in custom plugins. To ease the transition of plugins, the plugin loader in 1.0 includes a best-effort schema auto-translator, which should be sufficient for many plugins.

https://docs.konghq.com/1.0.x/plugin-development/custom-entities/

Same issue also about the extension of the Admin API documentation:

The kong.api.crud_helpers module was removed (deprecated since the introduction of the new DAO in 0.13.0). Use kong.api.endpoints instead if you need to customize the auto-generated endpoints.

But the documentation still points to use crud_helpers
https://docs.konghq.com/1.0.x/plugin-development/admin-api/

Steps To Reproduce

  1. Trying to migrate a custom plugin from Kong 0.14 to Kong 1.0
  2. Documentation is not updated with the new breaking changes added in Kong 1.0, instead still points to use the old API resources
@subnetmarco
Copy link
Member

subnetmarco commented Feb 11, 2019

@thibaultcha any comments on this?

@thibaultcha
Copy link
Member

@subnetmarco Followed up privately

@falondarville
Copy link
Contributor

Documentation for PDX v 1.0 is no longer being maintained. As of now, the most current version is available here:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants