Skip to content

LNI40/Implementation-View

Repository files navigation

LNI4.0 Business View

https://lni40.de/lni40-content/uploads/2021/03/BusinessView-LNI_Testbed-Edge-Management_V2.0.pdf

LNI4.0 Usage View

http://lni40.de/lni40-content/uploads/2020/04/UsageView-TestbedEdgeConfiguration_publish-10032020.pdf

LNI4.0 Functional View

https://github.com/LNI40/Implementation-View/blob/main/FunctionalView-TestbedEdgeConfiguration_V8.4.pdf (Draft, not released yet.)

LNI4.0 Implementation View

image

OpenAPI specification for an edge management REST API: The basic idea is to specify system interfaces between the entities within the edge architecture by analyzing the interactions in the Functional View document. Creating formal interface specifications using well-known standards like openAPI and asyncApi will allow automatic testcase creation and the use of a wide range of tools for the testbed. We do not want to re-invent the wheel: Participants may come forward with already existing solutions and we may adopt them as much as possible!

image

View current state in Swagger-Editor: http://editor.swagger.io/open?url=https://github.com/LNI40/Implementation-View/blob/main/OpenApi-Implementation-View.yml

OpenAPI

OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including:

  • Available endpoints (/users) and operations on each endpoint (GET /users, POST /users)
  • Operation parameters Input and output for each operation
  • Authentication methods
  • Contact information, license, terms of use and other information.

API specifications can be written in YAML or JSON. The format is easy to learn and readable to both humans and machines. The complete OpenAPI Specification can be found on GitHub: OpenAPI 3.0 Specification

(Source https://swagger.io/docs/specification/about/)

Tooling

Legal Disclaimer

© Copyright 2022 Labs Network Industrie 4.0

This work is licenced under the Creative Commons Zero Licence (https://creativecommons.org/publicdomain/zero/1.0/deed.de)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification.

THE SPECIFICATION IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SPECIFICATION OR THE USE OR OTHER DEALINGS IN THE SPECIFICATION.

About

OpenAPI specification for an edge management REST API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published