Skip to content

Commit 45128de

Browse files
committed
added description to external ids in swagger docs
1 parent 1e652eb commit 45128de

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/DatabaseCatalogAPI.yaml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,12 @@ components:
432432
format: date-time
433433
external_ids:
434434
$ref: "#/components/schemas/ExternalIds"
435+
description: |
436+
JBDA: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.
437+
TDG: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.
438+
NTD: Automatically imported from https://www.transit.dot.gov/ntd/data-product/2023-annual-database-general-transit-feed-specification-gtfs-weblinks. Pattern is ntd-<ntd_id>.
439+
TransitFeeds: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.
440+
Transit.land: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.
435441
provider:
436442
description: A commonly used name for the transit provider included in the feed.
437443
type: string
@@ -780,6 +786,12 @@ components:
780786
example: true
781787
external_ids:
782788
$ref: "#/components/schemas/ExternalIds"
789+
description: |
790+
JBDA: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.
791+
TDG: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.
792+
NTD: Automatically imported from https://www.transit.dot.gov/ntd/data-product/2023-annual-database-general-transit-feed-specification-gtfs-weblinks. Pattern is ntd-<ntd_id>.
793+
TransitFeeds: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.
794+
Transit.land: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.
783795
provider:
784796
description: A commonly used name for the transit provider included in the feed.
785797
type: string
@@ -954,14 +966,27 @@ components:
954966

955967
ExternalIds:
956968
type: array
969+
description: |
970+
The ID that can be use to find the feed data in an external or legacy database.
971+
JBDA: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.
972+
TDG: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.
973+
NTD: Automatically imported from https://www.transit.dot.gov/ntd/data-product/2023-annual-database-general-transit-feed-specification-gtfs-weblinks. Pattern is ntd-<ntd_id>.
974+
TransitFeeds: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.
975+
Transit.land: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.
957976
items:
958977
$ref: "#/components/schemas/ExternalId"
959978

960979
ExternalId:
961980
type: object
962981
properties:
963982
external_id:
964-
description: The ID that can be use to find the feed data in an external or legacy database.
983+
description: |
984+
The ID that can be use to find the feed data in an external or legacy database.
985+
JBDA: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.
986+
TDG: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.
987+
NTD: Automatically imported from https://www.transit.dot.gov/ntd/data-product/2023-annual-database-general-transit-feed-specification-gtfs-weblinks. Pattern is ntd-<ntd_id>.
988+
TransitFeeds: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.
989+
Transit.land: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.
965990
type: string
966991
example: 1210
967992
source:

0 commit comments

Comments
 (0)