Skip to content

Commit

Permalink
Merge pull request #110 from datakaveri/swaminathanvasanth-patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
gopal-mahajan authored Oct 30, 2024
2 parents 0ace613 + 3cae6fc commit d94d524
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@

## Introduction

The DX Resource proxy server is Data Exchange(DX) data discovery portal.
The DX Resource proxy server is Data Exchange(DX) data access portal.
It also facilitates data providers to register a connector to process the request and allows consumers to access data in
accordance with the provider's access policies.
The server ensures secure data access by integrating with an authorization server, requiring consumers to present access
tokens validated through token introspection APIs before serving protected data and supports advanced search
functionalities like temporal and geo-spatial queries through a data broker(RMQ) integration.
functionalities like temporal and geo-spatial queries.
Consumers can access the data using HTTPs protocols.

<p align="center">
Expand All @@ -32,7 +32,7 @@ Consumers can access the data using HTTPs protocols.
- Integration with authorization server (token introspection) to serve private data as per the access control policies
set by the provider
- Automate connector registration process for data provider
- Integrates with AX Auditing server for logging and auditing the access for metering purposes
- Integrates with DX Auditing server for logging and auditing the access for metering purposes
- Secure data access over TLS
- Scalable, service mesh architecture based implementation using open source components: Vert.X API framework, Postgres
and RabbitMQ.
Expand All @@ -49,18 +49,15 @@ Consumers can access the data using HTTPs protocols.
Reference : [postman-collection](src/test/resources/IUDX-Resource-Proxy-Server-Consumer-APIs.postman_collection_5.5.0.json), [postman-environment](src/test/resources/Resource-Proxy-Server-Consumer-APIs.postman_environment.json)

# How To Guide

## Setup and Installation

Setup and Installation guide is available [here](./docs/SETUP-and-Installation.md)

# Reference

## API Docs

API docs are
available [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/datakaveri/iudx-rs-proxy/master/docs/openapi.yaml)

## FAQ

FAQs are available [here](./docs/FAQ.md)

0 comments on commit d94d524

Please sign in to comment.