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

Document extracted feed metadata #1913

Open
AntoineAugusti opened this issue Oct 28, 2024 · 3 comments
Open

Document extracted feed metadata #1913

AntoineAugusti opened this issue Oct 28, 2024 · 3 comments
Labels
documentation Anything related to our documentation status: Needs triage Applied to all new issues

Comments

@AntoineAugusti
Copy link

Describe the problem

Would it be possible to document the extracted feed metadata such as counts/start and end dates?

There is comprehensive documentation for rules but not yet for metadata.

Thanks 🙏

Suggest a fix or an alternative

No response

@AntoineAugusti AntoineAugusti added documentation Anything related to our documentation status: Needs triage Applied to all new issues labels Oct 28, 2024
Copy link

welcome bot commented Oct 28, 2024

Thanks for opening your first issue in this project! If you haven't already, you can join our slack and join the #gtfs-validators channel to meet our awesome community. Come say hi 👋!

Welcome to the community and thank you for your engagement in open source! 🎉

@emmambd
Copy link
Contributor

emmambd commented Oct 28, 2024

Thanks for the suggestion @AntoineAugusti! I assume what you're looking for here is a breakdown of all the metadata we extract in the summary report, documented somewhere in https://gtfs-validator.mobilitydata.org/rules.html.

@emmambd emmambd added this to the 7.0 Validator Release milestone Oct 28, 2024
@AntoineAugusti
Copy link
Author

Yep exactly @emmambd, mainly what's present in this file.

public static final String FEED_INFO_PUBLISHER_NAME = "Publisher Name";
public static final String FEED_INFO_PUBLISHER_URL = "Publisher URL";
public static final String FEED_INFO_FEED_CONTACT_EMAIL = "Feed Email";
public static final String FEED_INFO_FEED_LANGUAGE = "Feed Language";
public static final String FEED_INFO_FEED_START_DATE = "Feed Start Date";
public static final String FEED_INFO_FEED_END_DATE = "Feed End Date";
public static final String FEED_INFO_SERVICE_WINDOW = "Service Window";
public static final String FEED_INFO_SERVICE_WINDOW_START = "Service Window Start";
public static final String FEED_INFO_SERVICE_WINDOW_END = "Service Window End";
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
/*
* Use these strings as keys in the counts map. Also used to specify the info that will appear in
* the json report. Adding elements to feedInfo will not automatically be included in the json
* report and should be explicitly handled in the json report code.
*/
public static final String COUNTS_SHAPES = "Shapes";
public static final String COUNTS_STOPS = "Stops";
public static final String COUNTS_ROUTES = "Routes";
public static final String COUNTS_TRIPS = "Trips";
public static final String COUNTS_AGENCIES = "Agencies";
public static final String COUNTS_BLOCKS = "Blocks";

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to our documentation status: Needs triage Applied to all new issues
Projects
None yet
Development

No branches or pull requests

2 participants