f5devcentral
diff --git a/‎.gitignore‎
Lines changed: 1 addition & 1 deletion b/‎.gitignore‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 34 additions & 0 deletions b/‎CONTRIBUTING.md‎
Lines changed: 34 additions & 0 deletions
diff --git a/‎FEATURES.md‎
Lines changed: 31 additions & 24 deletions b/‎FEATURES.md‎
Lines changed: 31 additions & 24 deletions
diff --git a/‎README.md‎
Lines changed: 10 additions & 3 deletions b/‎README.md‎
Lines changed: 10 additions & 3 deletions
@@ -20,6 +20,6 @@ Thumbs.db
 =======
 /.idea/
 /src/__pycache__/
-/src/Contrib/__pycache__/
+/src/v3_1/__pycache__/
 /contrib/devportal/src/__pycache__/
 /venv/
@@ -0,0 +1,34 @@
+# Contributing Guidelines
+
+The following is a set of guidelines for contributing to NGINX Declarative API. We really appreciate that you are considering contributing!
+
+## Getting Started
+
+Follow our [Getting Started Guide](README.md) to get NGINX Declarative API up and running.
+
+## Contributing
+
+### Report a Bug
+
+To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported.
+
+### Suggest a Feature or Enhancement
+
+To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement`. Please ensure the feature or enhancement has not already been suggested.
+
+### Open a Pull Request
+
+- Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
+
+## Code Guidelines
+
+### Git Guidelines
+
+- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
+- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated
+- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
+  - In the subject line, use the present tense ("Add feature" not "Added feature").
+  - In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
+  - Limit the subject line to 72 characters or less.
+  - Reference issues and pull requests liberally after the subject line.
+  - Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).
@@ -2,27 +2,34 @@
 
 ### NGINX `http` and `stream` servers
 
-Currently supported features:
-
-| Feature                    | API v3.1                                                                                | Notes                                                                      |
-|----------------------------|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------|
-| Upstreams                  | CRUD                                                                                    | Snippets supported: static and from source of truth                        |
-| HTTP servers               | CRUD                                                                                    | Snippets supported (`http`, `servers`, `locations`): static and from source of truth |
-| TCP/UDP servers            | CRUD                                                                                    | Snippets supported (`streams`, `servers`): static and from source of truth |
-| TLS                        | CRUD                                                                                    | Certificates and keys can be dynamically fetched from source of truth      |
-| mTLS                       | CRUD                                                                                    | Certificates and keys can be dynamically fetched from source of truth      |
-| Rate limiting              | X                                                                                       |                                                                            |
-| Active healthchecks        | X                                                                                       |                                                                            |
-| Cookie-based stickiness    | X                                                                                       |                                                                            |
-| Maps                       | X                                                                                       |                                                                            |
-| NGINX Plus REST API access | X                                                                                       |                                                                            |
-| NGINX App Protect WAF      | Per-policy CRUD at `server` and `location` level with dataplane-based bundle compilation | Security policies can be dynamically fetched from source of truth          |
-
-### API Gateway use case
-
-Currently supported features:
-
-| Feature                    | API v3.1                                                                                | Notes                                                                                                                                                                              |
-|----------------------------|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| API Gateway                | Swagger and OpenAPI YAML and JSON schema support                                        | <li>Automated configuration</li><li>HTTP methods enforcement</li><li>per-URI rate limiting</li><li>per-URI JWT authentication: JWT key hardwired or referenced as HTTP(S) URL</li> |
-| API Developer Portal       | Swagger and OpenAPI YAML and JSON schema support                                        | Based on Redocly                                                                                                                                                                   |
+| Feature                    | API v3.1 | API v4.0 | Notes                                                                                                                                                                              |
+|----------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Upstreams                  | CRUD     | CRUD    | <li>Snippets supported: static and from source of truth</li>                                                                                                                       |
+| HTTP servers               | CRUD     | CRUD    | <li>Snippets supported (`http`, `servers`, `locations`): static and from source of truth</li>                                                                                      |
+| TCP/UDP servers            | CRUD     | CRUD    | <li>Snippets supported (`streams`, `servers`): static and from source of truth</li>                                                                                                |
+| TLS                        | CRUD     | CRUD    | <li>Certificates and keys can be dynamically fetched from source of truth</li>                                                                                                     |
+| mTLS                       | CRUD     | CRUD    | <li>Certificates and keys can be dynamically fetched from source of truth</li>                                                                                                     |
+| JWT client authentication  |          | X       | <li>JWT key can be hardwired or fetched from source of truth</li>                                                                                                                  |
+| Rate limiting              | X        | X       |                                                                                                                                                                                    |
+| Active healthchecks        | X        | X       |                                                                                                                                                                                    |
+| Cookie-based stickiness    | X        | X       |                                                                                                                                                                                    |
+| Maps                       | X        | X       |                                                                                                                                                                                    |
+| NGINX Plus REST API access | X        | X       |                                                                                                                                                                                    |
+| NGINX App Protect WAF      | X        | X       | <li>Per-policy CRUD at `server` and `location` level</li><li>Support for dataplane-based bundle compilation</li><li>Security policies can be fetched from source of truth</li>     |
+
+
+### API Gateway
+
+| Feature                                      | API v3.1 | API v4.0 | Notes                                                    |
+|----------------------------------------------|----------|----------|----------------------------------------------------------|
+| Configuration generation from OpenAPI schema | X        | X        |                                                          | 
+| HTTP methods enforcement                     | X        | X        |                                                          |
+| per-URI rate limiting                        | X        | X        |                                                          |
+| per-URI JWT authentication                   | X        | X        | JWT key can be hardwired or fetched from source of truth |
+
+
+### API Gateway - Developer Portal
+
+| Feature                                         | API v3.1 | API v4.0 | Notes                                                                                                                                                                              |
+|-------------------------------------------------|----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Developer Portal generation from OpenAPI schema | X        | X        | <li>Based on Redocly</li>                                 |
@@ -140,8 +140,8 @@ See the [features list](/FEATURES.md)
 
 Usage details and JSON schema are available here:
 
-- [API v3.1](/USAGE-v3.1.md) - latest
-- [API v3](/USAGE-v3.md)
+- [API v4.0](/USAGE-v4.0.md) - latest
+- [API v3.1](/USAGE-v3.1.md)
 
 A sample Postman collection and usage instructions can be found [here](/contrib/postman)
 
@@ -163,7 +163,10 @@ Docker images can be built and run using:
     docker build --no-cache -t nginx-declarative-api-devportal .
     docker run --name devportal -d -p 5001:5000 nginx-declarative-api-devportal
 
-Pre-built docker images are available on Docker Hub at https://hub.docker.com/repository/docker/fiorucci/nginx-declarative-api/general
+Pre-built docker images are available on Docker Hub at
+- https://hub.docker.com/repository/docker/fiorucci/nginx-declarative-api/general
+- https://hub.docker.com/repository/docker/fiorucci/nginx-declarative-api-devportal/general
+
 Configuration can be customized mounting `config.toml` as a volume `nginx-declarative-api` docker image as a volume to customize 
 
 ## REST API documentation
@@ -182,6 +185,10 @@ This repository is licensed under the Apache License, Version 2.0. You are free
 
 See [Support](/SUPPORT.md)
 
+## Contributing
+
+See [Contributing](/CONTRIBUTING.md)
+
 ## Code of Conduct
 
 See the [Code of Conduct](/code_of_conduct.md)