Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conflict in documentation regarding Trip - trip_type #43

Open
fractalf opened this issue Nov 3, 2023 · 3 comments
Open

Conflict in documentation regarding Trip - trip_type #43

fractalf opened this issue Nov 3, 2023 · 3 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@schnuerle
Copy link
Member

Looks like the Stoplight docs are in error. Should be one trip type. A PR can be created here https://github.com/openmobilityfoundation/mds-openapi

@schnuerle schnuerle transferred this issue from openmobilityfoundation/mobility-data-specification Nov 8, 2023
@schnuerle schnuerle added bug Something isn't working documentation Improvements or additions to documentation labels Nov 8, 2023
@schnuerle
Copy link
Member

I'm not sure exactly how to change this trip_type array to an enumerated value based on mode in OpenAPI.

Maybe @mplsmitch @thekaveman could help advise.

Also might need to edit in passenger services, car share, delivery robots, and micromobility pages.

I have a fix-trip-type branch started for this work here.

@thekaveman
Copy link
Collaborator

The schema does allow only a single trip_type (via the minItems: 1 and maxItems: 1 qualifiers), however it seems like an error since this type should be a string and not an array.

I think the changes would be:

trip.trip_type:

trip_type:
  type: string

Then for each of the mode-specific trip definitions, raising the enum property out of the items key, e.g. for passenger-services.trip:

trip_type:
  enum:
    - private
    - shared
    - reservation
    - empty

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants