Git Product home page Git Product logo

openeocraft's Introduction

OpenEOcraft

OpenEOcraft offers a robust R framework designed for the development and deployment of openEO API applications. This package simplifies the process of creating RESTful openEO web services with its user-friendly and flexible interface. Built on Plumber, OpenEOcraft prioritizes ease of use, scalability, and adaptability.

OpenEOcraft Architecture

Easy Deployment with Docker

If you want to change the source code then this approach is recommended. You first need to clone the repository via this command:

git clone https://github.com/Open-Earth-Monitor/openeocraft.git

then you can change to that directory

cd openeosits

Run it :

docker-compose up

Run in detached mode :

docker-compose up -d

Shutting it down:

docker-compose down

Force restart and rebuild:

docker-compose up --build --force-recreate --no-deps -d

If there are new changes on the images or Dockerfiles:

docker-compose build --no-cache && docker-compose up

openeocraft's People

Contributors

rolfsimoes avatar pondib avatar

Stargazers

Felipe Carvalho avatar

Watchers

Tomislav Hengl avatar  avatar  avatar

Forkers

rolfsimoes pondib

openeocraft's Issues

L1 Minimum - Pre-defined Processes

Pre-defined Processes

Links to #7

Functionality Description

  • GET /processes:

    • Valid response with at least processes and links as arrays
    • Works without authentication
    • Works with authentication
    • All processes are returned if no limit parameter is provided
  • GET /processes > processes:

    • Missing properties in the process objects are not set to null if not valid according to the OpenAPI schema

L1 Minimum - File Formats

File Formats

Links to #7

Functionality Description

  • GET /file_formats:

    • Valid response with input and output properties
    • Works without authentication
    • Works with authentication
  • GET /file_formats > output:

    • At least one output file format available
  • GET /file_formats:

    • File format names get accepted case Insensitive
    • Each format has at least gis_data_types and parameters

L1 Minimum - Collections

Collections

Links to #7

Functionality Description

  • GET /collections:

    • Valid response with at least collections and links as arrays
    • Works without authentication
    • Works with authentication
    • Supports a valid STAC version (0.9.0 or later, preferably 1.0.0)
    • All collections are returned if no limit parameter is provided
    • All collections are valid according to the STAC specification 0.9 or later (stac_version, id, description, license, extent, and links are required)
    • Missing properties in the collection objects are not set to null if not valid according to the OpenAPI schema
  • GET /collections/{id}:

    • Is supported
    • Response is valid according to the STAC specification 0.9 or later (additionally, cube:dimensions and summaries are required)
    • Works without authentication
    • Works with authentication
    • All collections provide their actual data cube dimensions

L1 Minimum - API fundamentals

API fundamentals

Links to #7

Functionality Description

  1. All > CORS:

    • OPTIONS method with all headers
    • Access-Control-Allow-Origin for GET, POST, PUT, PATCH, DELETE
    • Access-Control-Expose-Headers for GET, POST, PUT, PATCH, DELETE
  2. All > HTTPS:

    • HTTPS supported
  3. All > UTF-8:

    • Charset is UTF-8 for all requests and responses
  4. All > Error Handling:

    • Returns HTTP status codes between 400 and 599 for errors
    • Returns a JSON object with at least code and message properties
  5. All > Process Graphs:

    • Callback support

L1 Minimum - Data Processing

Data Processing

Links to #7

Functionality Description

  • status:

    • Job follows described status changes (see description of status property in GET /jobs/{id})
  • At least one of batch jobs, secondary web services or synchronous processing is implemented

L1 Minimum - Well-known Discovery

Well-known Discovery

Links to #7

Functionality Description

  • GET /.well-known/openeo:
    • Valid response with at least url and api_version per instance (without authentication)

L1 Minimum - Capabilities

Capabilities

Links to #7

Functionality Description

  • GET /:

    • Valid response with at least api/backend/stac_version, id, title, description, endpoints and links (w/o auth)
  • GET / > endpoints:

    • All implemented endpoints listed with methods
  • GET / > endpoints:

    • No endpoints listed that are not implemented or faulty
  • GET / > api_version:

    • Implements openEO API version 1.2.0 (or 1.1.0)
  • GET / > stac_version:

    • Implements STAC version 1.0.0 (or 0.9.0)

L1 Minimum - Authentication

Authentication

Links to #7

Functionality Description

  • #31

  • All that require a Bearer token > Error Handling:

    • Returns HTTP status codes 401 if no authentication details are provided
    • Returns HTTP status codes 403 if invalid credentials or credentials with insufficient permissions are provided
  • GET /credentials/*:

    • At least one authentication method is supported (HTTP Basic or OIDC)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.