feat: add license information to operations API #1506

davidgamez · 2025-12-02T20:35:38Z

Summary:
Part of #1432

As a follow-up to #1482, this PR adds support for license information in the operations API. Main changes:

new endpoint /v1/operations/licenses: returns all licenses without rules
new endpoint /v1/operations/licenses/{license_id}: return the information for a specific license, including the rules array
updated PUT/POST endpoints /v1/operations/feeds/gtfs_rt and /v1/operations/feeds/gtfs supporting license_id, license_is_spdx and license_notes fields.

From our AI friend

This pull request introduces a new Licenses API to the Mobility Database Operations service, adds models and endpoints for querying license information, and extends feed-related models and endpoints to better support license metadata. The changes cover API documentation, backend implementation, and model updates to enable listing, searching, and retrieving license details, including license rules and SPDX status.

Licenses API Implementation

Added a new LicensesApiImpl class that provides endpoints for listing licenses (get_licenses) and retrieving a specific license with its rules (get_license). This supports pagination, search, and SPDX filtering.
Registered new API files and models for licenses in the OpenAPI generator and backend (licenses_api.py, license_base.py, etc.). [1] [2]

API Documentation and OpenAPI Spec Updates

Added /v1/operations/licenses and /v1/operations/licenses/{id} endpoints to the OpenAPI spec, including request parameters for pagination, search, and SPDX filtering, and response schemas for license details and rules. [1] [2]
Defined new schemas for LicenseBase, LicenseRule, LicenseWithRules, and updated feed schemas to include license-related fields (license_id, license_notes, license_is_spdx). [1] [2]

Feed Model and ORM Updates

Extended feed ORM conversion and update logic to support license_id, license_notes, and license_is_spdx fields, including proper lookup and error handling for missing licenses. [1] [2] [3] [4]

Error Handling and Logging Improvements

Improved error handling in feed creation by logging failures when triggering dataset downloads, ensuring better traceability.

Expected behavior:

License is returned in the get method and it's included in the create and update methods

Testing tips:

Local testing

Update your local DB
Start the operations API
Hit the endpoint with the following request

curl --request GET \
  --url 'http://localhost:8080/v1/operations/licenses?search_query=mit'

Expect a response with the list of licenses containing "mit" text

Please make sure these boxes are checked before submitting your pull request - thanks!

Run the unit tests with ./scripts/api-tests.sh to make sure you didn't break anything
Add or update any needed documentation to the repo
Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
Linked all relevant issues
Include screenshot(s) showing how this pull request works and fixes the issue(s)

Copilot

Pull request overview

This PR adds comprehensive license management capabilities to the operations API, enabling users to query license information and associate licenses with feeds. The changes introduce a new /v1/operations/licenses endpoint family and extend feed creation/update operations to support license metadata.

Key Changes:

New Licenses API with endpoints for listing and retrieving license details including rules
Extended GTFS and GTFS-RT feed models to support license_id, license_notes, and license_is_spdx fields
Database performance optimizations via PostgreSQL trigram indexes for license search queries

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
liquibase/changes/feat_1432_*.{xml,sql}	Database migration files adding pg_trgm extension and concurrent indexes for license search optimization
liquibase/changelog.xml	Registers new license index migrations
functions-python/operations_api/src/feeds_operations/impl/licenses_api_impl.py	Core implementation of Licenses API with get_license and get_licenses endpoints
functions-python/operations_api/tests/feeds_operations/impl/test_licenses_api_impl.py	Comprehensive test suite for license API operations
functions-python/operations_api/src/main.py	Registers new LicenseApiRouter
functions-python/operations_api/src/feeds_operations/impl/models/update_request_gtfs*_feed_impl.py	Extends feed models to include license fields in ORM conversions
functions-python/operations_api/src/feeds_operations/impl/feeds_operations_impl.py	Adds error handling for dataset download failures
functions-python/operations_api/.openapi-generator/FILES	Tracks newly generated license-related API files
docs/OperationsAPI.yaml	Adds OpenAPI specifications for license endpoints and schemas
api/src/shared/db_models/feed_impl.py	Updates feed ORM conversion to lookup and validate license_id references
functions-python/operations_api/tests/conftest.py	Adds test fixtures for licenses and rules
functions-python/operations_api/tests/feeds_operations/impl/test_feeds_operations_impl_gtfs.py	Updates GTFS test to include license fields

liquibase/changes/feat_1432_1.sql

liquibase/changes/feat_1432_2.sql

liquibase/changes/feat_1432_3.sql

liquibase/changelog.xml

docs/OperationsAPI.yaml

Co-authored-by: Copilot <[email protected]>

docs/OperationsAPI.yaml

jcpitre · 2025-12-09T02:58:51Z

functions-python/operations_api/src/feeds_operations/impl/feeds_operations_impl.py

-        )
+        try:
+            trigger_dataset_download(
+                created_feed,


Pycharm complains that created_feed could be None, and trigger_dataset_download does not support receiving a None.
We should guard against this.

I added a guard; unfortunately, PyCharm still triggers the warning even though the condition guarantees that None is not present at runtime.

jcpitre · 2025-12-09T03:09:19Z

functions-python/operations_api/tests/feeds_operations/impl/test_licenses_api_impl.py

+    result = await api.get_licenses(limit=10, offset=0, search_query=fragment)
+
+    assert isinstance(result, list)
+    assert any(item.id == existing.id for item in result)


A bit of a nitpick, but strictly speaking this is not testing that any license that should not be there is effectively not there (false positive)

Added Thanks!

jcpitre

LGTM!

* add sentry to web-app * Sentry trace rate parsing safety Co-authored-by: Copilot <[email protected]> * co pilot pr comments * deployment settings * update variable script to allow optional variables * error grouping and error detail * gbfs validator: error grouping and detail * errorDetailDialog refactor * ui of error dialog * tooltip adjustment * mobile support styling * accessibility fixes * styling touchup * updated test data * lint * co-pilot pr comments * improved UI to help find error details * focus fix * strict null checks for auth header builder * allow empty username and password * styling adjustment --------- Co-authored-by: Copilot <[email protected]>

…#1501) * changed feed references logic

github-actions · 2025-12-09T15:51:09Z

*Lighthouse ran on https://mobility-feeds-dev--pr-1506-zfkz4at5.web.app/ * (Desktop)
⚡️ HTML Report Lighthouse report for the changes in this PR:

Performance	Accessibility	Best Practices	SEO
🟠 83	🟢 100	🟢 100	🟢 100

*Lighthouse ran on https://mobility-feeds-dev--pr-1506-zfkz4at5.web.app/feeds * (Desktop)
⚡️ HTML Report Lighthouse report for the changes in this PR:

Performance	Accessibility	Best Practices	SEO
🟠 80	🟢 91	🟢 100	🟢 100

*Lighthouse ran on https://mobility-feeds-dev--pr-1506-zfkz4at5.web.app/feeds/gtfs/mdb-2126 * (Desktop)
⚡️ HTML Report Lighthouse report for the changes in this PR:

Performance	Accessibility	Best Practices	SEO
🟠 80	🔴 0	🟢 93	🟢 100

*Lighthouse ran on https://mobility-feeds-dev--pr-1506-zfkz4at5.web.app/feeds/gtfs_rt/mdb-2585 * (Desktop)
⚡️ HTML Report Lighthouse report for the changes in this PR:

Performance	Accessibility	Best Practices	SEO
🟢 91	🟠 87	🟢 100	🟢 100

*Lighthouse ran on https://mobility-feeds-dev--pr-1506-zfkz4at5.web.app/gbfs/gbfs-flamingo_porirua * (Desktop)
⚡️ HTML Report Lighthouse report for the changes in this PR:

Performance	Accessibility	Best Practices	SEO
🟢 100	🟢 100	🟢 100	🟢 100

github-actions · 2025-12-09T15:51:19Z

Preview Firebase Hosting URL: https://mobility-feeds-dev--pr-1506-zfkz4at5.web.app

davidgamez added 3 commits December 2, 2025 15:24

Add license information to op API

63c9b75

add missing license router

a4dd26e

add sql indexes

ac0fbdc

davidgamez marked this pull request as ready for review December 2, 2025 21:57

davidgamez requested a review from Copilot December 2, 2025 21:57

Copilot AI reviewed Dec 2, 2025

View reviewed changes

davidgamez and others added 7 commits December 2, 2025 16:59

Update liquibase/changes/feat_1432_1.sql

66f18f6

Co-authored-by: Copilot <[email protected]>

Update liquibase/changes/feat_1432_2.sql

3c29541

Co-authored-by: Copilot <[email protected]>

Update liquibase/changes/feat_1432_3.sql

a73cf63

Co-authored-by: Copilot <[email protected]>

Update liquibase/changelog.xml

011cf88

Co-authored-by: Copilot <[email protected]>

Update docs/OperationsAPI.yaml

0ee9cda

Co-authored-by: Copilot <[email protected]>

Update docs/OperationsAPI.yaml

c46e041

Co-authored-by: Copilot <[email protected]>

Update docs/OperationsAPI.yaml

b6276ff

Co-authored-by: Copilot <[email protected]>

jcpitre assigned davidgamez Dec 5, 2025

Merge branch 'main' into feat/op_api_license

a479a99

jcpitre reviewed Dec 8, 2025

View reviewed changes

docs/OperationsAPI.yaml Show resolved Hide resolved

jcpitre reviewed Dec 8, 2025

View reviewed changes

docs/OperationsAPI.yaml Show resolved Hide resolved

jcpitre reviewed Dec 9, 2025

View reviewed changes

jcpitre approved these changes Dec 9, 2025

View reviewed changes

Alessandro100 and others added 4 commits December 9, 2025 10:39

fix: 534 related schedule and realtime feeds dont update when changed (…

407720b

…#1501) * changed feed references logic

Add false positive tests

b670f43

Merge branch 'main' into feat/op_api_license

24378a4

davidgamez merged commit 5381453 into main Dec 9, 2025
2 of 3 checks passed

davidgamez deleted the feat/op_api_license branch December 9, 2025 15:53

feat: add license information to operations API #1506

feat: add license information to operations API #1506

Uh oh!

Conversation

davidgamez commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

From our AI friend

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jcpitre Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davidgamez Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

jcpitre Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

davidgamez Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

jcpitre left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 9, 2025

Uh oh!

github-actions bot commented Dec 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

davidgamez commented Dec 2, 2025 •

edited

Loading

jcpitre Dec 9, 2025 •

edited

Loading