-
Notifications
You must be signed in to change notification settings - Fork 41
OpenAPI code convention
In the specification, we use these 'coding conventions' in descriptions:
-
MODULE - for the module names, like PURCHASE: capitals, spaces, underlined
-
conceptName - referring to concepts that are described in the specification: capitals, spaces
-
'propertyName' - referring to fields/attributes/properties in a concept: bold, camel case
-
ENUMERATION_VALUE - referring to values from specific properties: uppercase, underscores
-
URLs- to specify a URL, referring to endpoints in the specification: between ticks -
PROCESS_IDENTIFIER_NAME - see Process Identifiers: italics, uppercase, underscores
-
[conditions] - free format conditions for a specific line: between brackets
The actual specification uses the same convention.
Introduction
- Roadmap
- Semantic versioning
- Use cases
- Changes per version
- Contribution
- Participants
Workflow
- Operator information
- Planning phase
- Booking phase
- Trip execution phase - start
- Trip execution phase - on route
- Trip execution phase - end
- Support
- Payment
Points of attention
- Modalities
- Specifying locations
- GDPR
Eco system
- Relations
Introduction
Scope of the TOMP-API
Versioning and releases
Process Flows
- Authentication
- Operator Information
- Privacy and Registration
- Planning Module
- Booking Module
- Trip Execution Module
- Payment Module
- Support Module
Meta-Information
Reference implementations
To-dos and risks
Technical Specifications
A1 List of terms and definitions
A2 Passenger characteristics dictionary
A3 APIs available on the transportation ecosystem
A4 Overview of the User stories
A5 Authors, Architects, collaborators and stakeholders involved
A6 Adoption and Implementation of the TOMP-API