diff --git a/README.md b/README.md index 353aa8e..db073d1 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,32 @@ Transport Operator Mobility-as-a-service Provider (TOMP) API development Github -==== +=== The TOMP working group aims to develop and sustain an internationally governed interoperable open standard for technical communication between Transport Operators and MaaS Providers, by means of definition, improvement, alignment and dissemination. I need help, where can I find it? / How do I start implementing TOMP? --- + If you need help with your TOMP-integration as a Transport Operator or a MaaS-Provider, use the following channels: + 1. First look at the [Wiki](https://github.com/TOMP-WG/TOMP-API/wiki), a lot of flows are described there. The wiki relates to the latest API-version. 2. If you have any questions regarding TOMP or how to implement it, please find us in Slack. There are a lot of developers there that can help you. Slack is a chat tool and very easy to use. Where can I find the API-documentation? --- + OpenAPI 3.0 documentation is available at [Swaggerhub](https://app.swaggerhub.com/apis-docs/TOMP-API-WG/transport-operator_maas_provider_api/). The Blueprint for an Transport Operator to Mobility-as-a-service Provider API is available at the [documentation page](https://github.com/TOMP-WG/TOMP-API/tree/master/documents). How can I join the TOMP working group? ---- -Join our [Slack space](https://join.slack.com/t/tomp-wg/shared_invite/zt-2bmkbwacm-qxJV1tzON6dp3KH261fwrQ) or contact Ayse (aysehilal.ocal@ndw.nu) to be added to our mailing list and to receive invites for the working group meetings. +Join our [Slack space](https://join.slack.com/t/tomp-wg/shared_invite/zt-e3fftun7-qCs8FyXZPPy9pt_opyFw0QPlease) or contact Ayse (aysehilal.ocal@ndw.nu) to be added to our mailing list and to receive invites for the working group meetings. The working group meetings take place every month with the goal to develop and specify a generic TOMP-API for use by Transport Operators and Mobility-as-a-service Providers. All reports can be found at the [documentation page](https://github.com/TOMP-WG/TOMP-API/tree/master/documents/working%20group%20reports). +Code of conduct +--- - +[Our code of conduct](https://github.com/TOMP-WG/TOMP-API/blob/master/code_of_conduct.md) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) diff --git a/TOMP-API.yaml b/TOMP-API.yaml index 7418548..35def23 100644 --- a/TOMP-API.yaml +++ b/TOMP-API.yaml @@ -4,7 +4,7 @@ info: description: An API between MaaS providers and transport operators for booking trips and corresponding assets.

The documentation (examples, process flows and sequence diagrams) can be found at github. - version: "1.5.0" + version: "1.6.0" license: name: Apache 2.0 url: "http://www.apache.org/licenses/LICENSE-2.0.html" @@ -2985,16 +2985,8 @@ components: meta: type: object additionalProperties: true - - geojsonLine: - description: An array of WGS84 coordinate pairs - type: array - example: [[6.169639, 52.253279], [6.05623, 52.63473]] - items: - $ref: "#/components/schemas/geojsonPoint" - - geojsonPoint: - description: Geojson Coordinate + + basePoint: type: array minItems: 2 maxItems: 2 @@ -3002,43 +2994,87 @@ components: type: number format: float minimum: 0.0 - example: [4.53432, 55.324523] + example: [ 4.53432, 55.324523 ] + + geojsonPoint: + type: object + description: Geojson Coordinate + allOf: + - $ref: "#/components/schemas/geojsonGeometry" + - type: object + properties: + coordinates: + $ref: "#/components/schemas/basePoint" + + geojsonLine: + type: object + description: An array of WGS84 coordinate pairs + allOf: + - $ref: "#/components/schemas/geojsonGeometry" + - type: object + properties: + coordinates: + type: array + example: [ [ 6.169639, 52.253279 ], [ 6.05623, 52.63473 ] ] + items: + $ref: "#/components/schemas/basePoint" geojsonPolygon: + type: object description: geojson representation of a polygon. First and last point must be equal. See also https://geojson.org/geojson-spec.html#polygon and example https://geojson.org/geojson-spec.html#id4. The order should be lon, lat [[[lon1, lat1], [lon2,lat2], [lon3,lat3], [lon1,lat1]]], the first point should match the last point. - type: array - items: - $ref: "#/components/schemas/geojsonLine" - example: [[[1.0, 1.0], [0.0, 1.0], [0.0, 0.0], [1.0,0.0], [1.0, 1.0]]] + allOf: + - $ref: "#/components/schemas/geojsonGeometry" + - type: object + properties: + coordinates: + type: array + example: [ [ [ 1.0, 1.0 ], [ 0.0, 1.0 ], [ 0.0, 0.0 ], [ 1.0,0.0 ], [ 1.0, 1.0 ] ] ] + items: + type: array + example: [ [ 6.169639, 52.253279 ], [ 6.05623, 52.63473 ] ] + items: + $ref: "#/components/schemas/basePoint" geojsonMultiPolygon: + type: object description: geojson representation of a multi polygon. See also https://geojson.org/geojson-spec.html#multipolygon - type: array - items: - $ref: "#/components/schemas/geojsonPolygon" - example: [[[[1.0, 1.0], [0.0, 1.0], [0.0, 0.0], [1.0,0.0], [1.0, 1.0]]]] + allOf: + - $ref: "#/components/schemas/geojsonGeometry" + - type: object + properties: + coordinates: + type: array + example: [ [ [ [ 1.0, 1.0 ], [ 0.0, 1.0 ], [ 0.0, 0.0 ], [ 1.0,0.0 ], [ 1.0, 1.0 ] ] ] ] + items: + type: array + example: [ [ [ 1.0, 1.0 ], [ 0.0, 1.0 ], [ 0.0, 0.0 ], [ 1.0,0.0 ], [ 1.0, 1.0 ] ] ] + items: + type: array + example: [ [ 6.169639, 52.253279 ], [ 6.05623, 52.63473 ] ] + items: + $ref: "#/components/schemas/basePoint" geojsonGeometry: + type: object + discriminator: + propertyName: type + mapping: + Point: "#/components/schemas/geojsonPoint" + LineString: "#/components/schemas/geojsonLine" + Polygon: "#/components/schemas/geojsonPolygon" + MultiPolygon: "#/components/schemas/geojsonMultiPolygon" + description: geoJSON geometry required: - - type - description: - geoJSON geometry + - type properties: type: type: string - enum: - - Point - - LineString - - Polygon - - MultiPolygon - coordinates: - oneOf: - - $ref: "#/components/schemas/geojsonPoint" - - $ref: "#/components/schemas/geojsonLine" - - $ref: "#/components/schemas/geojsonPolygon" - - $ref: "#/components/schemas/geojsonMultiPolygon" - discriminator: - propertyName: type + enum: [ + "Point", + "LineString", + "Polygon", + "MultiPolygon" + ] information: description: Information provided to end users diff --git a/code_of_conduct.md b/code_of_conduct.md new file mode 100644 index 0000000..33b5d2b --- /dev/null +++ b/code_of_conduct.md @@ -0,0 +1,99 @@ +Transport Operator Mobility-as-a-service Provider (TOMP) API development Github +=== + +The TOMP working group aims to develop and sustain an internationally governed interoperable open standard for technical communication between Transport Operators and MaaS Providers, by means of definition, improvement, alignment and dissemination. + +I need help, where can I find it? / How do I start implementing TOMP? +--- + +If you need help with your TOMP-integration as a Transport Operator or a MaaS-Provider, use the following channels: + + 1. First look at the [Wiki](https://github.com/TOMP-WG/TOMP-API/wiki), a lot of flows are described there. The wiki relates to the latest API-version. + 2. If you have any questions regarding TOMP or how to implement it, please find us in Slack. There are a lot of developers there that can help you. Slack is a chat tool and very easy to use. Use this link to join our [Slack space](https://join.slack.com/t/tomp-wg/shared_invite/zt-e3fftun7-qCs8FyXZPPy9pt_opyFw0Q). + +Where can I find the API-documentation? +--- + +OpenAPI 3.0 documentation is available at [Swaggerhub](https://app.swaggerhub.com/apis-docs/TOMP-API-WG/transport-operator_maas_provider_api/). + +The Blueprint for an Transport Operator to Mobility-as-a-service Provider API is available at the [documentation page](https://github.com/TOMP-WG/TOMP-API/tree/master/documents). + +How can I join the TOMP working group? +--- + +Join our [Slack space](https://join.slack.com/t/tomp-wg/shared_invite/zt-e3fftun7-qCs8FyXZPPy9pt_opyFw0QPlease) or contact Ayse (aysehilal.ocal@ndw.nu) to be added to our mailing list and to receive invites for the working group meetings. + +The working group meetings take place every month with the goal to develop and specify a generic TOMP-API for use by Transport Operators and Mobility-as-a-service Providers. All reports can be found at the [documentation page](https://github.com/TOMP-WG/TOMP-API/tree/master/documents/working%20group%20reports). + +Code of conduct +--- + +[Our code of conduct](https://github.com/TOMP-WG/TOMP-API/blob/master/code_of_conduct.md) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) + + + +======= +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +### Vision + +Effortless mobility for everyone + +### Mission + +The TOMP working group aims to develop and sustain an internationally governed interoperable open standard for technical communication between Transport Operators and MaaS Providers, by means of definition, improvement, alignment and dissemination. + +## Our behavior + +We welcome everyone who wants to get involved in developing the TOMP-API, the open standard for technical communication between Transport Operators and MaaS Service Providers, aka resellers. But we want you to respect other community members and their viewpoints, always look for the best solution for the traveler. + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language. +* Being respectful of differing viewpoints and experiences. +* Gracefully accepting constructive criticism. +* Focusing on what is best for the community. +* Showing empathy towards other community members. + +So, we don't allow: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting, although we're volunteers. + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, orreject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at aysehilal.ocal@ndw.nu. All +complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org