Routing SWG

This GitHub repository contains OGC's proposed standards for routing.

The editor's drafts of the specifications can be found at

OGC API standards define modular API building blocks to spatially enable Web APIs in a consistent way. OpenAPI is used to define the reusable API building blocks with responses in JSON and HTML.

The OGC API family of standards is organized by resource type. OGC API Routes specifies API building blocks for interacting with routes.

The work on the API started in the OGC Open Routing Pilot.

Overview

In addition to the resources provided through inheritance from OGC API - Common, the following resources are also provided by OGC API - Routes:

POST /routes

Compute a new route.

GET /routes

Fetch routes.

GET /routes/{routeId}

Fetch a route.

DELETE /routes/{routeId}

Delete a route.

GET /routes/{routeId}/definition

Fetch the definition of a route.

Communication

Most of the work on the specification takes place in GitHub issues, so browse there to get a good idea of what is happening, as well as past decisions.

Additional information

This repository contains draft content for both:

Building

To generate the HTML versions of the standards from this repository yourself, ensure that you have Ruby and Asciidoctor set up and installed. Then run:

asciidoctor api/standard/21-000.adoc
asciidoctor rem/standard/21-001.adoc

The resulting HTML files will be built in the same directory as the AsciiDoc file, e.g. as api/standard/21-000.html.

Contributing

The contributor understands that any contributions, if accepted by the OGC Membership, shall be incorporated into OGC standards documents and that all copyright and intellectual property shall be vested to the OGC.

The OGC Routing Standards Working Group (SWG) is the group at OGC responsible for the stewardship of the standard, but is working to do as much work in public as possible.

For more information, see CONTRIBUTING.md.

Pull Requests from contributors are welcomed. However, please note that by sending a Pull Request or Commit to this GitHub repository, you are agreeing to the terms in the Observer Agreement https://portal.ogc.org/files/?artifact_id=96216