Releases: datakaveri/iudx-catalogue-server
Releases · datakaveri/iudx-catalogue-server
v5.5.0
Version Summary
Version Number : v5.5.0 [tag: v5.5.0]
Date: 03-April-2024
Projects / Repos Included in this release: IUDX Catalogue Server, IUDX Deployment and installation, IUDX's Documentation
Release Summary :
India Urban Data Exchange (IUDX) | Catalogue Server v5.5.0 is released with enhanced features.
Highlights:
- Added APIs and features for Popular datasets, Dataset summary to understand data usage
- Included pagination support for mLayer APIs
- Updated Software Client libraries
- Updated Auditing Flow
- Updated Software Testing
- Updated Postman Collection
- Included REST Assured based integration testing
- Improved test coverage
- Software License:
- With this release, all IUDX Softwares will be distributed under Apache 2.0 License
Test Reports:
Please find the release test details and reports here
API Docs
The api docs can be found here.
How to use the Release:
External Dependencies Installation
The catalogue server connects with various external dependencies namely
- ELK stack
- PostgreSQL
- ImmuDB
Once the above setup is ready as mentioned in the deployment, you can install the IUDX Catalogue Server.
Prerequisite - Make configuration
Make a config file based on the template in ./configs/config-example.json
- Generate a certificate using Lets Encrypt or other methods
- Make a Java Keystore File and mention its path and password in the appropriate sections
- Modify the database url and associated credentials in the appropriate sections
Docker based
- Install docker and docker-compose
- Clone this repo
- Build the images
./docker/build.sh - Modify the
docker-compose.ymlfile to map the config file you just created - Start the server in production (prod) or development (dev) mode using docker-compose
docker-compose up prod
Maven based
- Install java 11 and maven
- Use the maven exec plugin based starter to start the server
mvn clean compile exec:java@catalogue-server
Redeployer
A hot-swappable redeployer is provided for quick development
./redeploy.sh
License
With this release, all IUDX Softwares will be distributed under Apache 2.0 License
Issues and Suggestions
Any Release related issues/suggestions, please raise here
For all other issues/suggestions related specific projects, please raise them to the respective project repo/issues.
What's Changed
- Written Integration Tests using RestAssured for Rating APIs , Mlayer APIs , Count APIs, GeoCoding APIs and NLP APIs in Catalogue Server by @DivyaSreeMunagavalasa in #294
- Add RestAssured integration tests for APIs in the Catalogue Server. by @Kranthi-Guribilli in #296
- Jenkins CI image tag update by @karun-singh in #297
- PR Changes- Removing Debug Logs by @DivyaSreeMunagavalasa in #299
- Committing the updated API docs for cat server into master branch. by @Kranthi-Guribilli in #302
- Automated the access of tokens from ITs by @Kranthi-Guribilli in #303
- mlayer-dataset fix by @tanvi029 in #304
- Fix : Provider Validation by @pranavrd in #308
- total count and montly count and size api by @ankitmashu in #306
- fix: response for bad request - invalid schema - more detailed resp by @pranavrd in #311
- M-layer by @ankitmashu in #310
- mlayer summary api for exclude ids by @ankitmashu in #317
- updated jenkins to exclude interfaces by @ankitmashu in #319
- Jenkins: update unit test stage by @karun-singh in #320
- Enhancement/stack api by @ananjaykumar2 in #315
- Software updates by @Kranthi-Guribilli in #314
- Added Pagination by @Gaurav-git06 in #318
- License information update by @sushanthakumar in #316
- allowing parenthesis and brackets for provider name by @pranavrd in #322
- popularDatasetAPI fix by @tanvi029 in #324
- Add /summary script requirements.txt by @karun-singh in #327
- correct postman collection and added updated env files by @ankitmashu in #328
New Contributors
- @DivyaSreeMunagavalasa made their first contribution in #294
- @Gaurav-git06 made their first contribution in #318
- @sushanthakumar made their first contribution in #316
Full Changelog: v5.0.0...v5.5.0
Contributors
sushanthakumar, pranavrd, and 7 other contributors
Assets 3
Catalogue Server v5.0.0
What's new?
- Updated the ID structure to Universally Unique Identifiers (UUIDs) for improved security.
- Added support for authorization of users with Keycloak Tokens.
- Added support for filtering datasets based on instance, domain, tags, and providers, providing more precise data retrieval in the dataset API.
Enhancement
- Updates and bug fixes on Validation
Testing
- Added PMD and Checkstyle to the server for improved code quality analysis.
Catalogue Server v4.5.0
Features
- Introduced NLP and Geo-coding support for search queries
Enhancement
- Updated dataset rating APIs
- Improved and enhanced auditing service workflow for better QOS
Catalogue Server v4.0.0
New Features
- User Rating APIs for verified resource access: Introduced a Ratings API for “eligible” consumers to rate a data set
- Consumers will be able to Create, Update, Read and Delete ratings
- Metering and Auditing Service
- Integration with immutable database (ImmuDB) for storing audit logs
Test Reports
Catalogue Server v3.5.0
New Features
- Implemented an alpha version of natural language queries supporting free form human interpretable sentences to search for datasets
- Implemented geocoding/reverse-geocoding support (using Pelias) to further enhance natural language queries
Updates, bugs, and performance fixes
- Enhanced Validation
Test Reports
- Unit tests available here
- Coverage available here
- Performance tests available here
- Security tests available here
- Integration tests available here
What's Changed
- JWT Auth + Audit Integrations by @pranavrd in #114
- Adding temporary build-push script, docs to image by @abhi4578 in #115
- FIX: CORS Request header field instance not allowed by @abhi4578 in #116
- Adding contact info, update version to 3.0.0 by @abhi4578 in #117
- ImmuDB Client disconnection problem. by @kailash in #119
- Add jwtIgnoreExpiry option in config by @abhi4578 in #120
- getting auth public key from url by @pranavrd in #121
- Bump log4j-core from 2.14.1 to 2.15.0 by @dependabot in #122
- Bump log4j-core from 2.15.0 to 2.16.0 by @dependabot in #123
- Bump log4j-core from 2.16.0 to 2.17.0 by @dependabot in #125
- Integration with Jenkins CI pipeline by @karun-singh in #124
- Bump log4j-core from 2.17.0 to 2.17.1 by @dependabot in #128
- Remove sensitive logs in catalogue by @abhi4578 in #129
- Bump postgresql from 42.2.22 to 42.2.25 by @dependabot in #130
- Jenkins CI improvements by @karun-singh in #131
- Bump postgresql from 42.2.25 to 42.3.3 by @dependabot in #132
- Adding default apiserver ports by @abhi4578 in #135
- Make Non-root docker image for cat server by @hackcoderr in #133
- Jenkins CI update: Added cleanup of unit test reports after stage completion by @karun-singh in #134
New Contributors
- @kailash made their first contribution in #119
- @dependabot made their first contribution in #122
- @hackcoderr made their first contribution in #133
Full Changelog: 3.0.0...v3.5.0
Contributors
kailash, dependabot, and 4 other contributors
Assets 2
3.0.0
New features
- Enhanced Relationship APIs
- Auditing Service
- Integrated with immutable database (ImmuDB)
- Integration with JWT based tokens provided by IUDX Auth Server
Updates, bugs, and performance fixes
- Library, Security Updates, and migration from v3.9.1 to 4.0.3
- Fully complied with IS 18003 (Part 2):2021 Doc No: LITD 28 (17249) | Unified Data Exchange Part 2: API specifications
Test Reports
Improvements and New Modules
Improvements
- More input validations
- Fixes on request and responses
- Docker based testing for CI/CD
Features
- Optional Geocoding and NLP Search module
Alpha release
Catalogue Alpha Release.
Some of the highlights of the alpha release are -
- Search and discovery of data resources hosted on IUDX platform
- Support for text, geo-spatial, relationship and attributes searches
- Upload, delete and modify operations on catalogue objects (meta-information corresponding to resources)
- Uses JSON-LD to store catalogue meta-information objects with data attributes linked to published vocabularies and data models
- Scalable, service mesh architecture based implementation using open source components: Vert.X API framework, Elasticsearch for database
Some of the milestones for the next release are -
- Richer Relationship Queries
- More coverage reports with CI/CD pipeline
Attached -
- Newman Integration Test Report - integration-test-report.html
- Surefire Unit Test Report - unit-test-report.html