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

Fm use case #246

Merged
merged 4 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions frinx-device-inventory/index.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Label: Device Inventory
icon: codespaces
order: 1500
Binary file added frinx-machine/api-docs/api-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added frinx-machine/api-docs/api-gateway.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions frinx-machine/api-docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
icon: plug
expanded: false
order: 9300
---

# API Gateway

Communication with FRINX Machine is facilitated through both a user-friendly UI and a robust REST API.
All our services offer REST and GraphQL APIs, allowing seamless interaction for both users and automated systems.

Our architecture employs an API Gateway to consolidate all endpoints into a single, accessible location. Each service is assigned a unique path, simplifying access.
To connect with a specific service, you only need to know the FM KrakenD/OAuth2-Proxy ingress host and the designated path for your desired service.
This streamlined approach ensures efficient and straightforward communication with FRINX Machine.

## Api Gateway diagram

![API Gateway](api-gateway.png)

## Api Docs

API documentation is accesibla via Frinx Machine installation

![API Docs](api-docs.png)
Binary file removed frinx-machine/azure-ad/azure_api_permissions.png
Binary file not shown.
Binary file removed frinx-machine/azure-ad/azure_client_secret.png
Binary file not shown.
Binary file removed frinx-machine/azure-ad/azure_tenant.png
Binary file not shown.
Binary file not shown.
127 changes: 0 additions & 127 deletions frinx-machine/azure-ad/readme.md

This file was deleted.

Binary file removed frinx-machine/getting-started/components.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user23.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user24.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user25.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user26.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user27.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user28.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user29.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user30.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user31.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user32.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_0.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_1.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_10.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_12.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_13.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_14.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_15.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_16.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_17.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_18.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_19.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_1_0.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_2.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_20.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_21.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_22.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_3.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_4.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_5.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_6.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_7.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_8.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_9.png
Diff not rendered.
102 changes: 0 additions & 102 deletions frinx-machine/getting-started/introduction.rst-DEL

This file was deleted.

111 changes: 0 additions & 111 deletions frinx-machine/getting-started/operating-frinx-machine.rst-DEL

This file was deleted.

Loading
Loading