Skip to content

Commit 38804a6

Browse files
qcdyxqcdyx
authored
added description to external ids in swagger docs (#1525)
* added description to external ids in swagger docs
1 parent 8a89d38 commit 38804a6

File tree

2 files changed

+75
-2
lines changed

2 files changed

+75
-2
lines changed

‎docs/DatabaseCatalogAPI.yaml‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,15 @@ components:
432432
format: date-time
433433
external_ids:
434434
$ref: "#/components/schemas/ExternalIds"
435+
description: |
436+
The ID that can be use to find the feed data in an external or legacy database.
437+
<ul>
438+
<li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
439+
<li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
440+
<li><b>NTD</b>: 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>.</li>
441+
<li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
442+
<li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
443+
</ul>
435444
provider:
436445
description: A commonly used name for the transit provider included in the feed.
437446
type: string
@@ -780,6 +789,15 @@ components:
780789
example: true
781790
external_ids:
782791
$ref: "#/components/schemas/ExternalIds"
792+
description: |
793+
The ID that can be use to find the feed data in an external or legacy database.
794+
<ul>
795+
<li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
796+
<li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
797+
<li><b>NTD</b>: 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>.</li>
798+
<li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
799+
<li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
800+
</ul>
783801
provider:
784802
description: A commonly used name for the transit provider included in the feed.
785803
type: string
@@ -954,14 +972,31 @@ components:
954972

955973
ExternalIds:
956974
type: array
975+
description: |
976+
The ID that can be use to find the feed data in an external or legacy database.
977+
<ul>
978+
<li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
979+
<li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
980+
<li><b>NTD</b>: 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>.</li>
981+
<li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
982+
<li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
983+
</ul>
957984
items:
958985
$ref: "#/components/schemas/ExternalId"
959986

960987
ExternalId:
961988
type: object
962989
properties:
963990
external_id:
964-
description: The ID that can be use to find the feed data in an external or legacy database.
991+
description: |
992+
The ID that can be used to find the feed data in an external or legacy database.
993+
<ul>
994+
<li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
995+
<li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
996+
<li><b>NTD</b>: 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>.</li>
997+
<li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
998+
<li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
999+
</ul>
9651000
type: string
9661001
example: 1210
9671002
source:

‎web-app/src/app/services/feeds/types.ts‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,16 @@ export interface components {
153153
* @example "2023-07-10T22:06:00.000Z"
154154
*/
155155
created_at?: string;
156+
/**
157+
* @description The ID that can be use to find the feed data in an external or legacy database.
158+
* <ul>
159+
* <li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
160+
* <li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
161+
* <li><b>NTD</b>: 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>.</li>
162+
* <li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
163+
* <li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
164+
* </ul>
165+
*/
156166
external_ids?: components['schemas']['ExternalIds'];
157167
/**
158168
* @description A commonly used name for the transit provider included in the feed.
@@ -408,6 +418,16 @@ export interface components {
408418
* @example true
409419
*/
410420
official?: boolean;
421+
/**
422+
* @description The ID that can be use to find the feed data in an external or legacy database.
423+
* <ul>
424+
* <li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
425+
* <li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
426+
* <li><b>NTD</b>: 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>.</li>
427+
* <li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
428+
* <li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
429+
* </ul>
430+
*/
411431
external_ids?: components['schemas']['ExternalIds'];
412432
/**
413433
* @description A commonly used name for the transit provider included in the feed.
@@ -516,10 +536,28 @@ export interface components {
516536
unique_info_count?: number;
517537
};
518538
};
539+
/**
540+
* @description The ID that can be use to find the feed data in an external or legacy database.
541+
* <ul>
542+
* <li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
543+
* <li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
544+
* <li><b>NTD</b>: 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>.</li>
545+
* <li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
546+
* <li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
547+
* </ul>
548+
*/
519549
ExternalIds: Array<components['schemas']['ExternalId']>;
520550
ExternalId: {
521551
/**
522-
* @description The ID that can be use to find the feed data in an external or legacy database.
552+
* @description The ID that can be used to find the feed data in an external or legacy database.
553+
* <ul>
554+
* <li><b>JBDA</b>: Automatically imported from http://docs.gtfs-data.jp/api.v2.html. Pattern is jbda-<organisation_id>-<feed_id>.</li>
555+
* <li><b>TDG</b>: Automatically imported from https://doc.transport.data.gouv.fr/outils/outils-disponibles-sur-le-pan/api. Pattern is tdg-<resource_id>.</li>
556+
* <li><b>NTD</b>: 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>.</li>
557+
* <li><b>TransitFeeds</b>: Automatically imported from old TransitFeeds website. Pattern is tfs-<feed_id>.</li>
558+
* <li><b>Transit.land</b>: Imported from https://www.transit.land/documentation/rest-api/feeds. Pattern is tld-<feed_id>.</li>
559+
* </ul>
560+
*
523561
* @example 1210
524562
*/
525563
external_id?: string;

0 commit comments

Comments
 (0)