Skip to content
This repository was archived by the owner on Feb 9, 2022. It is now read-only.

DigitaleDeltaOrg/dd-eco-api-specs

Repository files navigation

Digital Delta Eco specification

This specification describes the Digital Delta Eco API (DD-ECO-API). It is meant for both implementers and consumers of the Digital Delta Eco specifications.

About the Digital Delta Eco specification

This specification defines a standardised method for retrieving (and providing) ecological measurements. Please see the wiki for a full description.

Getting Started

The RAML specifications are now obsolete and are replaced by their OAS 3.x equivalents.

A minimal version of the DD-ECO-API in OAS 3.x format can be viewed here.

An expanded version, as implemented by AquaDesk, can be viewed here.

The HTML specifications can also be used and may be easier to read.

For testing, some PostMan scripts are supplied. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

The easiest way to get the specification is to download the generated HTML files. To be able to use the RAML files, please consult the tools section. Knowledge of the RAML language is then recommended.

Installing

The supplied code for the .NET Filter Syntax Parser is written in C# with .NET Framework 4.6+. A good environment for editing and compiling that solution, is Visual Studio 2017 Community Edition.

The unit tests are written in NUnit.

Authors

  • Geri Wolters - Initial work - EcoSys
  • Stef Hummel - Initial work - Deltares

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

About

Digital Delta ECO API specifications in RAML

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published