@bfra.me/api-core 0.1.0

package/test-utils/datasets/refresh-dataset

@@ -0,0 +1,336 @@
+#! /usr/bin/env node
+/**
+ * This script regenerates the list of real world API definitions from APIs.guru that the test
+ * suite uses for parsing and validating integration tests.
+ *
+ * @link https://github.com/APIs-guru/openapi-directory
+ */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-param-reassign */
+const fs = require('fs');
+
+fetch('https://api.apis.guru/v2/list.json')
+  .then(response => {
+    if (!response.ok) {
+      throw new Error('Unable to download real-world APIs from apis.guru');
+    }
+
+    return response.json();
+  })
+  .then(apis => {
+    Object.entries(apis).forEach(([service]) => {
+      // Every Amazon OAS is **huge** (100k+ lines) and really bog the smoketest down. They should
+      // probably be manually tested instead.
+      if (service.startsWith('amazonaws.com:')) {
+        delete apis[service];
+      }
+
+      // Some Google APIs have an invalid `source` property at the root.
+      if (service.startsWith('googleapis.com:')) {
+        delete apis[service];
+      }
+    });
+
+    // These APIs are either **huge** or take **forever** to process. Investigate why at some point.
+    delete apis['azure.com:servicefabric'];
+    delete apis['azure.com:web-WebApps'];
+    delete apis['beezup.com'];
+    delete apis['loket.nl'];
+    delete apis['mist.com'];
+    delete apis['zoom.us'];
+    delete apis['zuora.com'];
+
+    // These APIs have no `paths` so an SDK we generate is always going to be empty.
+    delete apis['firstinspires.org'];
+    delete apis['ipinfodb.com'];
+    delete apis['iva-api.com'];
+    delete apis['zenoti.com'];
+
+    // These APIs have validation issues.
+    delete apis['adyen.com:BalancePlatformConfigurationNotification-v1'];
+    delete apis['adyen.com:BalancePlatformPaymentNotification-v1'];
+    delete apis['adyen.com:BalancePlatformReportNotification-v1'];
+    delete apis['adyen.com:BalancePlatformTransferNotification-v3'];
+    delete apis['adyen.com:CheckoutService'];
+    delete apis['adyen.com:ManagementNotificationService-v1'];
+    delete apis['adyen.com:MarketPayNotificationService'];
+    delete apis['adyen.com:PaymentService'];
+    delete apis['adyen.com:PayoutService'];
+    delete apis['adyen.com:RecurringService'];
+    delete apis['amadeus.com:amadeus-hotel-ratings'];
+    delete apis['autotask.net'];
+    delete apis['avaza.com'];
+    delete apis['azure.com:azsadmin-Operations'];
+    delete apis['azure.com:azsadmin-RegionHealth'];
+    delete apis['azure.com:deviceprovisioningservices-iotdps'];
+    delete apis['azure.com:labservices-ML'];
+    delete apis['azure.com:migrateprojects-migrate'];
+    delete apis['azure.com:network-interfaceEndpoint'];
+    delete apis['azure.com:network-loadBalancer'];
+    delete apis['azure.com:network-networkInterface'];
+    delete apis['azure.com:network-networkProfile'];
+    delete apis['azure.com:network-networkSecurityGroup'];
+    delete apis['azure.com:network-privateEndpoint'];
+    delete apis['azure.com:network-publicIpAddress'];
+    delete apis['azure.com:network-routeTable'];
+    delete apis['azure.com:network-serviceEndpointPolicy'];
+    delete apis['azure.com:network-virtualNetwork'];
+    delete apis['azure.com:network-virtualNetworkTap'];
+    delete apis['azure.com:provisioningservices-iotdps'];
+    delete apis['azure.com:web-service'];
+    delete apis['billbee.io'];
+    delete apis['blazemeter.com'];
+    delete apis['calorieninjas.com'];
+    delete apis['clarify.io'];
+    delete apis['clicksend.com'];
+    delete apis['cloudmersive.com:ocr'];
+    delete apis['contribly.com'];
+    delete apis['enode.io'];
+    delete apis['evetech.net'];
+    delete apis['frankiefinancial.io'];
+    delete apis['geneea.com'];
+    delete apis['github.com'];
+    delete apis['github.com:api.github.com'];
+    delete apis['github.com:ghes-2.18'];
+    delete apis['github.com:ghes-2.19'];
+    delete apis['github.com:ghes-2.20'];
+    delete apis['github.com:ghes-2.21'];
+    delete apis['github.com:ghes-2.22'];
+    delete apis['github.com:ghes-3.0'];
+    delete apis['github.com:ghes-3.1'];
+    delete apis['hetras-certification.net:booking'];
+    delete apis['hetras-certification.net:hotel'];
+    delete apis['icons8.com'];
+    delete apis['motaword.com'];
+    delete apis['naviplancentral.com:plan'];
+    delete apis['openapi-generator.tech'];
+    delete apis['opensuse.org:obs'];
+    delete apis['opto22.com:groov'];
+    delete apis['osisoft.com'];
+    delete apis['parliament.uk:statutoryinstruments'];
+    delete apis['parliament.uk:treaties'];
+    delete apis['personio.de:personnel'];
+    delete apis['postmarkapp.com:server'];
+    delete apis['rebilly.com'];
+    delete apis['semantria.com'];
+    delete apis['simplyrets.com'];
+    delete apis['spotify.com'];
+    delete apis['staging-ecotaco.com'];
+    delete apis['testfire.net:altoroj'];
+    delete apis['tl-api.azurewebsites.net'];
+    delete apis['turbinelabs.io'];
+    delete apis['twilio.com:twilio_numbers_v1'];
+    delete apis['va.gov:confirmation'];
+    delete apis['versioneye.com'];
+    delete apis['vestorly.com'];
+    delete apis['viator.com'];
+    delete apis['wedpax.com'];
+    delete apis['whapi.com:accounts'];
+    delete apis['xero.com:xero_accounting'];
+    delete apis['zalando.com'];
+
+    // These APIs have circular refs, which the library doesn't yet support.
+    // https://github.com/readmeio/api/issues/549
+    delete apis['amazonaws.com:ce'];
+    delete apis['api.video'];
+    delete apis['api2cart.com'];
+    delete apis['apideck.com:accounting'];
+    delete apis['apideck.com:connector'];
+    delete apis['appcenter.ms'];
+    delete apis['atlassian.com:jira'];
+    delete apis['azure.com:alertsmanagement-AlertsManagement'];
+    delete apis['azure.com:applicationinsights-eaSubscriptionMigration_API'];
+    delete apis['azure.com:applicationinsights-swagger'];
+    delete apis['azure.com:appplatform'];
+    delete apis['azure.com:azsadmin-Deployment'];
+    delete apis['azure.com:azsadmin-FileContainer'];
+    delete apis['azure.com:azsadmin-Location'];
+    delete apis['azure.com:azsadmin-UpdateRuns'];
+    delete apis['azure.com:azure-kusto'];
+    delete apis['azure.com:azureactivedirectory'];
+    delete apis['azure.com:batch-BatchManagement'];
+    delete apis['azure.com:batchai-BatchAI'];
+    delete apis['azure.com:billing'];
+    delete apis['azure.com:cognitiveservices-FormRecognizer'];
+    delete apis['azure.com:cognitiveservices-LUIS-Authoring'];
+    delete apis['azure.com:cognitiveservices-Personalizer'];
+    delete apis['azure.com:cognitiveservices-QnAMaker'];
+    delete apis['azure.com:cognitiveservices-QnAMakerRuntime'];
+    delete apis['azure.com:cognitiveservices-TextAnalytics'];
+    delete apis['azure.com:consumption'];
+    delete apis['azure.com:containerinstance-containerInstance'];
+    delete apis['azure.com:containerservice-managedClusters'];
+    delete apis['azure.com:containerservice-openShiftManagedClusters'];
+    delete apis['azure.com:containerservices-managedClusters'];
+    delete apis['azure.com:containerservices-openShiftManagedClusters'];
+    delete apis['azure.com:cost-management-costmanagement'];
+    delete apis['azure.com:customproviders'];
+    delete apis['azure.com:databox'];
+    delete apis['azure.com:databoxedge'];
+    delete apis['azure.com:datafactory'];
+    delete apis['azure.com:datalake-analytics-job'];
+    delete apis['azure.com:datashare-DataShare'];
+    delete apis['azure.com:deploymentmanager'];
+    delete apis['azure.com:devops'];
+    delete apis['azure.com:devtestlabs-DTL'];
+    delete apis['azure.com:digitaltwins'];
+    delete apis['azure.com:dns'];
+    delete apis['azure.com:domainservices'];
+    delete apis['azure.com:edgegateway'];
+    delete apis['azure.com:engagementfabric-EngagementFabric'];
+    delete apis['azure.com:hardwaresecuritymodules-dedicatedhsm'];
+    delete apis['azure.com:hybridcompute-HybridCompute'];
+    delete apis['azure.com:iotcentral'];
+    delete apis['azure.com:keyvault'];
+    delete apis['azure.com:logic'];
+    delete apis['azure.com:machinelearning-webservices'];
+    delete apis['azure.com:machinelearningservices-artifact'];
+    delete apis['azure.com:machinelearningservices-datastore'];
+    delete apis['azure.com:machinelearningservices-execution'];
+    delete apis['azure.com:machinelearningservices-runHistory'];
+    delete apis['azure.com:managementgroups-management'];
+    delete apis['azure.com:mariadb'];
+    delete apis['azure.com:mariadb-DataEncryptionKeys'];
+    delete apis['azure.com:mariadb-PrivateEndpointConnections'];
+    delete apis['azure.com:mariadb-PrivateLinkResources'];
+    delete apis['azure.com:mediaservices-AccountFilters'];
+    delete apis['azure.com:mediaservices-Accounts'];
+    delete apis['azure.com:mediaservices-Assets'];
+    delete apis['azure.com:mediaservices-AssetsAndAssetFilters'];
+    delete apis['azure.com:mediaservices-ContentKeyPolicies'];
+    delete apis['azure.com:mediaservices-Encoding'];
+    delete apis['azure.com:mediaservices-MediaGraphs'];
+    delete apis['azure.com:mediaservices-StreamingPoliciesAndStreamingLocators'];
+    delete apis['azure.com:mediaservices-streamingservice'];
+    delete apis['azure.com:migrate'];
+    delete apis['azure.com:msi-ManagedIdentity'];
+    delete apis['azure.com:mysql'];
+    delete apis['azure.com:mysql-DataEncryptionKeys'];
+    delete apis['azure.com:mysql-PrivateEndpointConnections'];
+    delete apis['azure.com:mysql-PrivateLinkResources'];
+    delete apis['azure.com:network'];
+    delete apis['azure.com:network-applicationGateway'];
+    delete apis['azure.com:network-ddosCustomPolicy'];
+    delete apis['azure.com:operationalinsights-swagger'];
+    delete apis['azure.com:policyinsights-policyMetadata'];
+    delete apis['azure.com:policyinsights-remediations'];
+    delete apis['azure.com:portal'];
+    delete apis['azure.com:postgresql'];
+    delete apis['azure.com:postgresql-DataEncryptionKeys'];
+    delete apis['azure.com:postgresql-PrivateEndpointConnections'];
+    delete apis['azure.com:postgresql-PrivateLinkResources'];
+    delete apis['azure.com:privatedns'];
+    delete apis['azure.com:recoveryservicessiterecovery-service'];
+    delete apis['azure.com:resources'];
+    delete apis['azure.com:resources-deploymentScripts'];
+    delete apis['azure.com:resources-management'];
+    delete apis['azure.com:search'];
+    delete apis['azure.com:search-searchservice'];
+    delete apis['azure.com:signalr'];
+    delete apis['azure.com:storage-file'];
+    delete apis['azure.com:storagecache'];
+    delete apis['azure.com:timeseriesinsights'];
+    delete apis['azure.com:trafficmanager'];
+    delete apis['azure.com:trafficmanager-trafficmanageranalytics'];
+    delete apis['azure.com:vmwarecloudsimple'];
+    delete apis['azure.com:web-Provider'];
+    delete apis['azure.com:windowsesu'];
+    delete apis['azure.com:workloadmonitor-Microsoft.WorkloadMonitor'];
+    delete apis['bbc.co.uk'];
+    delete apis['bbci.co.uk'];
+    delete apis['bigoven.com'];
+    delete apis['bigredcloud.com'];
+    delete apis['bitbucket.org'];
+    delete apis['britbox.co.uk'];
+    delete apis['bungie.net'];
+    delete apis['bunq.com'];
+    delete apis['callfire.com'];
+    delete apis['canada-holidays.ca'];
+    delete apis['clickmeter.com'];
+    delete apis['codat.io:accounting'];
+    delete apis['codat.io:assess'];
+    delete apis['codat.io:bank-feeds'];
+    delete apis['configcat.com'];
+    delete apis['corrently.io'];
+    delete apis['cpy.re:peertube'];
+    delete apis['credas.co.uk:pi'];
+    delete apis['cybertaxonomy.eu'];
+    delete apis['daniweb.com'];
+    delete apis['dataflowkit.com'];
+    delete apis['dev.to'];
+    delete apis['docusign.net'];
+    delete apis['dracoon.team'];
+    delete apis['ebay.com:commerce-taxonomy'];
+    delete apis['envoice.in'];
+    delete apis['getsandbox.com'];
+    delete apis['gitea.io'];
+    delete apis['id4i.de'];
+    delete apis['influxdata.com'];
+    delete apis['jellyfin.local'];
+    delete apis['jumpseller.com'];
+    delete apis['just-eat.co.uk'];
+    delete apis['keycloak.local'];
+    delete apis['kubernetes.io'];
+    delete apis['learnifier.com'];
+    delete apis['lgtm.com'];
+    delete apis['magento.com'];
+    delete apis['mercedes-benz.com:configurator'];
+    delete apis['meshery.local'];
+    delete apis['microsoft.com:cognitiveservices-AutoSuggest'];
+    delete apis['microsoft.com:cognitiveservices-ComputerVision'];
+    delete apis['microsoft.com:cognitiveservices-CustomImageSearch'];
+    delete apis['microsoft.com:cognitiveservices-CustomSearch'];
+    delete apis['microsoft.com:cognitiveservices-EntitySearch'];
+    delete apis['microsoft.com:cognitiveservices-ImageSearch'];
+    delete apis['microsoft.com:cognitiveservices-LocalSearch'];
+    delete apis['microsoft.com:cognitiveservices-NewsSearch'];
+    delete apis['microsoft.com:cognitiveservices-VideoSearch'];
+    delete apis['microsoft.com:cognitiveservices-VisualSearch'];
+    delete apis['microsoft.com:cognitiveservices-WebSearch'];
+    delete apis['microsoft.com:graph'];
+    delete apis['ndhm.gov.in:ndhm-healthid'];
+    delete apis['noosh.com'];
+    delete apis['opendatasoft.com'];
+    delete apis['opentrials.local'];
+    delete apis['ote-godaddy.com:domains'];
+    delete apis['oxforddictionaries.com'];
+    delete apis['parliament.uk:erskine-may'];
+    delete apis['parliament.uk:oralquestions'];
+    delete apis['patientview.org'];
+    delete apis['pocketsmith.com'];
+    delete apis['presalytics.io:ooxml'];
+    delete apis['quarantine.country'];
+    delete apis['redirection.io'];
+    delete apis['seldon.local:core'];
+    delete apis['seldon.local:engine'];
+    delete apis['seldon.local:wrapper'];
+    delete apis['slicebox.local'];
+    delete apis['smart-me.com'];
+    delete apis['sportsdata.io:nba-v3-scores'];
+    delete apis['sportsdata.io:nba-v3-stats'];
+    delete apis['sportsdata.io:nhl-v3-scores'];
+    delete apis['sportsdata.io:nhl-v3-stats'];
+    delete apis['squareup.com'];
+    delete apis['stripe.com'];
+    delete apis['telegram.org'];
+    delete apis['tfl.gov.uk'];
+    delete apis['truora.com'];
+    delete apis['tsapi.net'];
+    delete apis['uspto.gov:bdss'];
+
+    return apis;
+  })
+  .then(apis => {
+    return Object.entries(apis).map(([name, api]) => {
+      const latestVersion = api.versions[api.preferred];
+
+      return {
+        name,
+        version: api.preferred,
+        url: latestVersion.swaggerUrl,
+      };
+    });
+  })
+  .then(apis => {
+    fs.writeFileSync(`${__dirname}/real-world-apis.json`, JSON.stringify(apis, null, 2));
+  });