Add OEKG Web-API & Scenario Bundle feature documentation

[jh-RLI]

Description of the issue

We want to provide documentation that contains all the necessary information to understand the functions that create the scenario bundle feature.

Additionally, we want to provide the oekg Web-API documentation that shows how to query oekg and how to create scenario bundles using the Web-API by sending a json formatted request.

Ideas of solution

Scenario Bundle Code documentation

• [x] Provide docstrings
• [x] Provide short text descriptions

OEKG Web-API

• [x] Provide endpoint (url) & functionality that endpoint provides
• [x] Show structure of the json request object that must be send to the endpoint in the http get/post request

In the compendium

• [x] show schema of the oekg and some text
• [x] add screenshots of the scenario bundle page and also some text

General

• [x] Link to general information in the compendium

What is documented where?

Technical information (OEP-DOCS)

• OEKG Web-API - https://openenergyplatform.github.io/oeplatform/install-and-documentation/oeplatform-code/web-api/oekg-api/
• Scenario Bundles OEP feature - https://openenergyplatform.github.io/oeplatform/install-and-documentation/oeplatform-code/features/scenario-bundles/

Non / less technical (Compendium)

• What is a scenario bundle? - https://openenergyplatform.github.io/organisation/family_members/templates-and-specification/scenario-bundles/
• What is the oekg , and how scenario bundles are stored there? - https://openenergyplatform.github.io/organisation/family_members/knowledge-representation/oekg/

Workflow checklist

• [x] I am aware of the workflow in CONTRIBUTING.md

[jh-RLI]

@adelmemariani I had a second look at the documentation you provided and realized that we need a bit more. You provided documentation on the function that creates the scenario bundle feature on the Django side. This of course includes the functions that provide the Web API functions. The documentation is still missing information about what endpoints we have (URLs that provide the WEB API), such as a post request to schenario-bundles/add and so on. It is also necessary to know how the json request body must be structured when sending the request.

[jh-RLI]

The less technical documentation about the scenario bundles and oekg schema will be available in our compendium. See this issue https://github.com/OpenEnergyPlatform/organisation/issues/74

[jh-RLI]

Example for how to document the web-api https://oeplatform.readthedocs.io/en/latest/api.html https://user-images.githubusercontent.com/38939526/171179814-ab85e94e-4f96-49d0-a71c-32dc89215bc8.png

[jh-RLI]

Implemented by https://github.com/OpenEnergyPlatform/oeplatform/pull/1481