diff options
| author |   ToineSiebelink <toine.siebelink@est.tech> | 2024-07-01 17:50:54 +0100 |
|---|---|---|
| committer | ToineSiebelink <toine.siebelink@est.tech> | 2024-07-03 16:23:19 +0100 |
| commit | 8593baef64f2e3e6ae347edfc6ff4cf12c62123f (patch) | |
| tree | f8eb22184931d22cc39b1f3f2999127492b1c3c3 /docs/policy-executor.rst | |
| parent | 37e328eeaa3e79416e70f348da79cff3ad2e547b (diff) | |
Add Policy Executor Open API Interface definition
- OPenApi in RTD only (for now)
- Bear authentication included in OpenApi
- Placeholder RTD page (to be completed upon feature delivery)
- For consistency (and color coding in editors) I put all Description and Example strings inside double qoutes "..."
Issue-ID: CPS-2291
Change-Id: I7f16cdce2a06cb011997005fa8b86b54c044304a
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
Diffstat (limited to 'docs/policy-executor.rst')
| -rw-r--r-- | docs/policy-executor.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/policy-executor.rst b/docs/policy-executor.rst new file mode 100644 index 0000000000..b934a579b1 --- /dev/null +++ b/docs/policy-executor.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2024 Nordix Foundation + +.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING +.. _policy_executor: + + +Policy Executor +############### + +.. toctree:: + :maxdepth: 1 + +Introduction +============ + +Work In Progress: This feature is not yet completed and does not affect current NCMP functionality. + +Consumed APIs +------------- + +:download:`Policy Executor OpenApi Specification <api/swagger/policy-executor/openapi.yaml>` |