RuterNo / adt-doc

Documentation intended for PTOs who need to connect to Ruters digitale plattform

API Documentation - Avtale om digitale tjenester (ADT)

This project contains documentation, Json schema files, example messages and AsyncApi definitions.
Explore the docs »

Compare Releases · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Browse Releases
   • Compare Releases
3. Roadmap
4. Contributing
5. Contact
6. License

About The Project

This project contains documentation of the API interfaces between Public Transport Operators (PTO) and the Public Transport Authority (PTA) of the Oslo and Viken region.

The documentation describes the purpose of our over-the-air messages, as well as how the messages are to be constructed. You will find example messages, json-schemas and tips on how to setup your test environments.

Content found in this repository:

• Documentation of the different MQTT messages
• Json-Schemas
• Example messages
• AsyncAPI definition file
• Information on how to setup a vehicle
• Documentation on different REST APIs
• OpenAPI definitions

(back to top)

Built With

This documentation has been created using:

• 
• 
• 

(back to top)

Getting Started

To get access to Ruters test-environments, please reach out to us:

• Contact us

We recommend familiarizing your self with the MQTT standard, and recommends the use of MQTT v5.

Step 1 - Build AsyncAPI generated html doc

Prerequisites

• Node.js

Installing the AsyncApi Generator

npm install -g @asyncapi/generator@1.9.18

Building the asyncApi documentation

To build the documentation, run the following command:

ag asyncapi/asyncapi.yml @asyncapi/html-template -o docs/asyncapi --force-write

More information

AsyncApi HTML generator

Build documentation site locally

Install

pip install mkdocs-material

Run

mkdocs serve 

Browse Releases

To see the latest current ADT release, please visit:

• ADT Documentation

To find historical releases, please visit:

• All releases

Compare Releases

To compare the changes between two releases, please visit:

• Compare releases

(back to top)

Roadmap

• Create ADT 1.3 doc
• Create ADT 2.2 doc
• Create ADT 2.3 doc
• Create ADT 2.4 doc
• Create ADT 2.5 doc
• Create ADT 2.6 doc
• Create ADT 3.0 doc

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please open an issue or create a pull request to the corresponding branch. (E.g. ADT 3.x)

Contact

RDP-Support - [e-mail]

Project Link: https://github.com/RuterNo/adt-doc/

(back to top)

License

Distributed under the Apache License. See LICENSE.md for more information.

(back to top)