{"openapi":"3.0.3","security":[{"clientCredentials":[]}],"info":{"title":"Developer Portal Backend APIs","version":"v1","description":"Backend APIs used by DTN's Developer Portal Web App","contact":{"name":"Aether Innovation SE","email":"aether.innovationse-manila@dtn.com"}},"servers":[{"url":"http://localhost:3000"}],"paths":{"/v1/apis":{"summary":"Manage APIs","get":{"tags":["APIs"],"summary":"Get all APIs on the system","description":"Returns the APIs on the system, arranged by name in ascending order. If groupByCat was true, it will return the results grouped by category, but still arranged by name in ascending order.","parameters":[{"$ref":"#/components/parameters/x-request-id"},{"name":"groupByCat","description":"When this param is truthy, the results will be grouped by api category.","schema":{"type":"boolean"},"in":"query","required":false,"example":[true]}],"responses":{"200":{"description":"Successful response - returns a list of apis","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/ApiList"},{"$ref":"#/components/schemas/ApiListGroupedByCat"}]}}}}}},"400":{"$ref":"#/components/responses/http-status-400"}}}},"/v1/apis/{slug}":{"summary":"Manage an API","description":"APIs used to manage","get":{"tags":["APIs"],"summary":"Get an API","parameters":[{"$ref":"#/components/parameters/x-request-id"},{"name":"slug","description":"The api identifier","schema":{"type":"string"},"in":"path","required":true,"example":["dtn-weather-conditions-api"]}],"responses":{"200":{"description":"Successful response - returns a list of apis","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api"}}}},"404":{"$ref":"#/components/responses/http-status-404"}}}},"/v1/apis/{slug}/spec/{version}":{"summary":"An endpoint to serve a JSON file of API spec","get":{"tags":["APIs"],"summary":"Get API spec","parameters":[{"$ref":"#/components/parameters/x-request-id"},{"name":"slug","description":"API slug","schema":{"type":"string"},"in":"query","required":true,"example":["dtn-weather-conditions-api"]},{"name":"version","description":"API version","schema":{"type":"string"},"in":"query","required":true,"example":["1.0.0"]}],"responses":{"200":{"description":"Successful response - returns the content of JSON file API spec","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"type":"object","example":{"openapi":"1.0.0","info":{"title":"OpenAPI example","version":"1.0.0"},"webhooks":{"newPet":{"post":{"requestBody":{"decription":"Information about a new pet in the system","content":{"application/json":{"schema":{"title":"Schema for an API specs version","type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}}}}}}}}},"400":{"$ref":"#/components/responses/http-status-400"}}}},"/v1/apis/{slug}/changelog/{version}":{"summary":"An endpoint to serve a markdown file of API changelog","get":{"tags":["APIs"],"summary":"Get API changelog","parameters":[{"$ref":"#/components/parameters/x-request-id"},{"name":"slug","description":"API slug","schema":{"type":"string"},"in":"query","required":true,"example":["dtn-weather-conditions-api"]},{"name":"version","description":"API version","schema":{"type":"string"},"in":"query","required":true,"example":["1.0.0"]}],"responses":{"200":{"description":"Successful response - returns the content of changelog markdown file","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"text/plain":{"schema":{"type":"string"},"example":"#Changelog \n\n###V1 API v1.0.1 minor major\n\n##1.0.1 - 2015-08-01\n\n####What's Changed\n\n- Add support for array query parameters\n- Added `/v1/api/get-users` endpoint\n- Add ability to set multiple query parameters at once\n- Fix creating urls from invalid strings\n- Provide a component stack as a second argument to onRecoverableError\n- Pass information about server errors to the client.\n- Allow to provide a reason when aborting the HTML stream.\n- Eliminate extraneous text separators in the HTML where possible.\n- Disallow complex children inside <title> elements to match the browser constraints.\n- Fix buffering in some worker environments by explicitly setting highWaterMark to 0.\n- Add support for useId() inside Server Components.\n\n####Fixed\n- Fix creating urls from invalid strings\n- 502 errors when changing the route\n- Map auto scroll navigation\n- Fix hydrating into document causing a blank page on mismatch.\n- Fix false positive hydration errors with Suspense.\n- Fix ignored setState in Safari when adding an iframe.\n"}}},"400":{"$ref":"#/components/responses/http-status-400"}}}},"/v1/apis/{slug}/versions/{id}":{"patch":{"tags":["APIs"],"summary":"Patch an API specs version","security":[{"clientCredentials":[]}],"parameters":[{"$ref":"#/components/parameters/x-request-id"},{"name":"slug","schema":{"type":"string"},"in":"path","required":true,"example":["dtn-weather-conditions-api"]},{"name":"id","description":"The api specs version id","schema":{"type":"number"},"in":"path","required":true,"example":[1]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"spec_link":{"type":"string","example":"https://localhost/docs/"},"changelog_link":{"type":"string","example":"https://localhost/docs/changelogs/"},"version":{"type":"string","example":"1.0.1"},"is_published_specs":{"type":"boolean","example":false},"is_published_changelog":{"type":"boolean","example":false}},"minProperties":1}}}},"responses":{"200":{"description":"Successful response - returns the updated api specs version","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersion"}}}},"400":{"$ref":"#/components/responses/http-status-400"},"401":{"$ref":"#/components/responses/http-status-401"},"404":{"$ref":"#/components/responses/http-status-404"}}}},"/health-check":{"summary":"Health Check","description":"The health check endpoint provides information about the health of a web service. If each of the components required by the service are healthy, then the service is considered healthy and will return a 200 OK response. If any of the components needed by the service are unhealthy, then a 503 Service Unavailable response will be provided.","get":{"tags":["Health"],"summary":"Health Check","responses":{"200":{"$ref":"#/components/responses/HealthCheckReport"},"503":{"$ref":"#/components/responses/ErrorResponse"}},"operationId":"healthCheck","description":""}},"/liveness":{"summary":"Kubernetes will use this endpoint to monitor service's health.","description":"Kubernetes will use this endpoint to monitor service's health. In case it fails for a while, K8s will automatically try to restart the Pod. This endpoint should only monitor the main service process and should not return an error for temporary shortages. Dependencies will be monitored using `readiness` endpoint. For more information: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request","get":{"tags":["Health"],"summary":"Kubernetes will use this endpoint to monitor service's health.","responses":{"200":{"$ref":"#/components/responses/HealthCheckReport"},"503":{"$ref":"#/components/responses/ErrorResponse"}},"operationId":"liveness"}},"/readiness":{"summary":"Kubernetes will use this endpoint to monitor service's readiness.","description":"Kubernetes will use this endpoint to monitor if the service is responsive. In case it fails, K8s will stop routing the traffic until the service is responsive again. This endpoint should monitor all the underlying dependencies (databases, other API calls etc.) For more information: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes","get":{"tags":["Health"],"summary":"Kubernetes will use this endpoint to monitor service's readiness.","responses":{"200":{"$ref":"#/components/responses/HealthCheckReport"},"503":{"$ref":"#/components/responses/ErrorResponse"}},"operationId":"readiness"}}},"components":{"parameters":{"x-request-id":{"name":"X-Request-ID","in":"header","required":false,"description":"A UUID compliant with RFC 4122 that uniquely identifies the request.","schema":{"type":"string","example":"f8941c97-9998-4bbf-b8e9-cbc6e85c8818"}}},"headers":{"x-request-id":{"description":"The value of the `X-Request-ID` Request header, or an internally generated UUID when one is not provided, used for tracing.","schema":{"type":"string","example":"f8941c97-9998-4bbf-b8e9-cbc6e85c8818"}}},"securitySchemes":{"clientCredentials":{"type":"oauth2","x-receive-token-in":"request-body","flows":{"clientCredentials":{"tokenUrl":"https://api.auth.dtn.com/v1/tokens/authorize"}},"description":"# Using DAIS for M2M/API Auth\nYou have been given a Client ID and a Client Secret, which are used to request a DTN Access Token. DTN Access Tokens are required when making calls to each and every DTN API endpoint. The following information provides additional details on these tokens and how they are generated.\n## What is an Access Token and how is it different from an API Key?\nAn API Key is a random string of characters that an API uses to authorize whether or not a calling client has approved access to an endpoint. These keys are a non-standard approach to API authorization and are generally issued on a per-API basis.\n\nAn Access Token is also a string of characters but is a base-64 encoded JavaScript Object Notation Web Token, or JWT. JWTs are a widely accepted standard that use OAuth concepts and approaches. \n\nBoth API Keys and Access Tokens are used in an Authorization Request Header as a Bearer, meaning there is no difference in where you put this string of characters when you make calls to DTN APIs.\n## How to generate an Access Token?\nWhen requested, an Access Token is generated for your specific Client (ID/Secret) and for a specific API. The DTN Auth and Identity Service (DAIS) generates new Access Tokens for your client. The DAIS endpoint is `POST https://api.auth.dtn.com/v1/tokens/authorize`.\n\nThis endpoint takes two Header parameters:\n  * `Content-Type: application/json`\n  * `Accept: application/json`\n\nThis endpoint takes four parameters in the Request Body:\n  * `grant_type`: this should always be client_credentials for generating machine-to-machine tokens.\n  * `client_id`: this is the Client ID or Application ID using the token and is given to you by DTN's Identity Team. This ID will never change for your client/application.\n  * `client_secret`: this is the Client Secret that is associated with the Application ID and is given to you by DTN's Identity Team. This key is subject to rotation for security purposes but always with the client's knowledge.\n  * `audience`: this is the API for which this Access Token will be used. For the DTN Developer Portal API, you need to use the following audience: https://dev-portal.prd.coreservices.zones.com\n\nYou can use this CURL command template as a reference for obtaining an access token:\n  ```\n  curl --location --request POST 'https://api.auth.dtn.com/v1/tokens/authorize' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"grant_type\": \"client_credentials\",\n\"client_id\": \"insert your client id here\",\n\"client_secret\": \"insert your client secret here\",\n\"audience\": \"insert your audience here\"\n}' \n  ```\n\n*This document, for demonstration purposes, supplies a client_id and client_secret in all code examples. This client/application is for a fictitious API and cannot be used in practice to gain unauthorized access to any other DTN API.*\nUpon generating a new Access Token, you should receive an HTTP Response from DAIS similar to this:\n  ```\n  {\n    \"data\": {\n          \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw\",\n          \"scope\": \"read:demo create:demo update:demo\",\n          \"expires_in\": 90,\n          \"token_type\": \"Bearer\"\n      },\n      \"meta\": {\n          \"date_time\": \"2022-06-24T19:09:42.963Z\",\n          \"name\": \"v1.tokens.authorize\",\n          \"uuid\": \"ee6f9feb-dcf8-4421-a6fd-efd6beabdaa9\",\n          \"start_timestamp\": 1656097782509,\n          \"end_timestamp\": 1656097782963,\n          \"execution_time\": 454\n      }\n  }\n  ```\nLooking at this Response, you will see:\n  * `access_token`: contains the JWT Access Token string you will use as your Bearer token.\n  * `scope`: contains the scopes that this Access Token gives you permissions to access.\n  * `expires_in`: contains the length of time before this Access Token will expire, in seconds.\n  * `token_type`: verifies that this Access Token should be used as a Bearer token.\n\n## How to use an Access Token after one is generated?\nOnce a new Access Token is obtained, it is used in each call to a DTN API endpoint as a Bearer token in an Authorization Request Header. For example:\n  ```\n  Header: 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw'\n  ```\n\n## Deconstructing the Access Token\nA DTN Access Token carries information within its JWT Body that is available on every API call. By deconstructing the JWT token, our Access Tokens will resemble:\n  ```\n  {\n    \"https://auth.dtn.com/customerId\": \"1234567890Demo\",\n    \"https://auth.dtn.com/productCode\": \"DemoApiP\",\n    \"https://auth.dtn.com/requesterIp\": \"18.213.174.27\",\n    \"https://auth.dtn.com/rps\": \"100\",\n    \"https://auth.dtn.com/tier\": \"Basic\",\n    \"https://auth.dtn.com/quota\": \"999999\",\n    \"iss\": \"https://id.auth.dtn.com/\",\n    \"sub\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM@clients\",\n    \"aud\": \"https://demo-api.auth.dtn.com/\",\n    \"iat\": 1656099068,\n    \"exp\": 1656099158,\n    \"azp\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM\",\n    \"scope\": \"read:demo create:demo update:demo\",\n    \"gty\": \"client-credentials\",\n    \"permissions\": [\n      \"read:demo\",\n      \"create:demo\",\n      \"update:demo\"\n    ]\n  }\n  ```\n### Description of Claims\n\n  | Claim                              | Type                                        | Description                                                                                                                                                                                                                |\n  | -----------------------------------| --------------------------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n  | `https://auth.dtn.com/customerId`  | String                                      | Custom DTN claim containing the Customer ID found in the DTN Order Management/Salesforce system associated with this token.                                                                                                |\n  | `https://auth.dtn.com/productCode` | String                                      | Custom DTN claim containing the Identity product code associated with this token.                                                                                                                                          |\n  | `https://auth.dtn.com/requesterIp` | String                                      | Custom DTN claim containing the IP address of the requesting client.                                                                                                                                                       |\n  | `https://auth.dtn.com/rps`         | String                                      | Custom DTN claim containing the maximum rate per second this customer is authorized to utilize.                                                                                                                            |\n  | `https://auth.dtn.com/tier`        | String                                      | Custom DTN claim containing the data tier the customer purchased for the requested access.                                                                                                                                 |\n  | `https://auth.dtn.com/quota`       | String                                      | Custom DTN claim containing the maximum yearly quota the customer purchased for calling DTN endpoints for the specific product.                                                                                            |\n  | `iss`                              | String (URI)                                | The Security Token Service (STS) that issues and returns the token. If this value is not from `https://id.auth.dtn.com/`, the token should not be considered trusted.                                                      |\n  | `sub`                              | String (URI)                                | The principle about which the token asserts information (the User ID or Client ID within the Identity Provider). A User ID will start with a prefix of `auth0\\|`, while the Client ID will end with the suffix `@clients`. |\n  | `aud`                              | String \\| Array (Strings) (URI \\| [URI, …]) | Identifies the intended recipient(s) of the token – its audience. The token should be rejected if the audience does not contain values expected by the calling application.                                                |\n  | `iat`                              | Number (Timestamp)                          | “Issued At” indicates when the authentication for this token occurred.                                                                                                                                                     |\n  | `exp`                              | Number (Timestamp)                          | The “expiration time” on or after which the JWT must not be accepted for processing.                                                                                                                                       |\n  | `azp`                              | String                                      | The application/client ID of the client using the token. The application can cat as itself or on behalf of a user.                                                                                                         |\n  | `gty`                              | String (Space-delimited)                    | The grant type that was used to request the token – not an RFC 7519 registered claim (Auth0-specific).                                                                                                                     |\n  | `permissions`                      | Array (Strings)                             | The grant type that was used to request the token – not an RFC 7519 registered claim (Auth0-specific).                                                                                                                     |\n\n  "}},"schemas":{"Error":{"title":"Root Type for Error","description":"Error","required":["code","description","status"],"type":"object","properties":{"status":{"enum":["error"],"type":"string"},"code":{"enum":["invalid-id","internal-error","invalid-token","missing-scope"],"type":"string"},"description":{"type":"string"}},"example":{"status":"error","code":"invalid-token","description":"The token has expired."}},"HealthCheck":{"title":"HealthCheckResponse","description":"Health Check Response","required":["status"],"type":"object","properties":{"status":{"type":"string"},"version":{"type":"string"},"info":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"env":{"type":"string"}},"example":{"status":"up","version":"unknown","info":"Service is healthy","timestamp":"2021-04-19T22:10:53Z","env":"unknown"}},"http-status-400":{"type":"object","properties":{"type":{"type":"string","description":"The type of error that was encountered","example":"bad-request"},"title":{"type":"string","description":"The title of the error","example":"Invalid Request"},"status":{"type":"integer","description":"The HTTP Response Status Code.","example":400},"detail":{"type":"string","description":"The message describing the reason for this 400.","example":"Validation failed."},"instance":{"type":"string","description":"An identifier for the request","example":"urn:dtn:dev-portal-api:/api/catalog/:requestId:e5384521-506c-4af6-bd6d-c5f3691f1bde"},"errors":{"type":"array","description":"A list of errors further describing the reason for the 400.","items":{"type":"object","properties":{"message":{"type":"string","description":"Error description","example":"Invalid value"},"parameter":{"type":"string","description":"The field name where this error was observed","example":"groupByCat"},"value":{"type":"string","description":"The value of the field that's causing the error","example":"yes"}}}}}},"http-status-error-without-errors-field":{"type":"object","properties":{"type":{"type":"string","description":"The type of error that was encountered","example":"not-found"},"title":{"type":"string","description":"The title of the error","example":"Not Found"},"status":{"type":"integer","description":"The HTTP Response Status Code.","example":400},"detail":{"type":"string","description":"The message describing the reason for this error.","example":"Resource was not found."},"instance":{"type":"string","description":"An identifier for the request","example":"urn:dtn:dev-portal-api:/api/catalog/:requestId:e5384521-506c-4af6-bd6d-c5f3691f1bde"}}},"Api":{"title":"Schema for an API","type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"summary":{"type":"string"},"overview":{"type":"string"},"slug":{"type":"string"},"api_link":{"type":"string"},"link":{"type":"string"},"category":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"api_specs_versions":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersion"}}},"example":{"id":1,"name":"DTN Weather Conditions API","summary":"Worldwide gridded forecast, current condition, and historical analysis data","overview":"The DTN Weather Conditions API is an all-encompassing solution to integrating advanced weather data and analytics into your operating systems. DTN utilizes the latest in cloud technology to ensure that its global suite of forecast models meet your specific needs. Models and forecast data are continuously validated, calibrated, and tuned to the latest observations. The Weather Conditions API provides results based on the user input or omission of start and end time parameters. For example, current conditions data will be provided if start and end time specifications are omitted.","slug":"dtn-weather-conditions-api","api_link":"https://weather.api.dtn.com/v1/docs/conditions","link":"https://weather.api.dtn.com/v1/docs/conditions/openapi.yaml","category":"Weather","status":"active","createdAt":"2022-09-09T13:00:08.888Z","updatedAt":"2022-09-09T13:00:08.888Z","api_specs_versions":{"$ref":"#/components/schemas/ApiVersion/example"}}},"ApiList":{"title":"APIs","type":"array","items":{"$ref":"#/components/schemas/Api"}},"ApiWoCategory":{"title":"Schema for an API sans category","type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"summary":{"type":"string"},"overview":{"type":"string"},"slug":{"type":"string"},"api_link":{"type":"string"},"link":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"api_specs_versions":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersion"}}},"example":{"id":1,"name":"DTN Weather Conditions API","summary":"Worldwide gridded forecast, current condition, and historical analysis data","overview":"The DTN Weather Conditions API is an all-encompassing solution to integrating advanced weather data and analytics into your operating systems. DTN utilizes the latest in cloud technology to ensure that its global suite of forecast models meet your specific needs. Models and forecast data are continuously validated, calibrated, and tuned to the latest observations. The Weather Conditions API provides results based on the user input or omission of start and end time parameters. For example, current conditions data will be provided if start and end time specifications are omitted.","slug":"dtn-weather-conditions-api","api_link":"https://weather.api.dtn.com/v1/docs/conditions","link":"https://weather.api.dtn.com/v1/docs/conditions/openapi.yaml","status":"active","createdAt":"2022-09-09T13:00:08.888Z","updatedAt":"2022-09-09T13:00:08.888Z","api_specs_versions":{"$ref":"#/components/schemas/ApiVersion/example"}}},"ApiListGroupedByCat":{"title":"APIs grouped by category","type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"apis":{"type":"array","items":{"$ref":"#/components/schemas/ApiWoCategory"}}}}},"ApiVersion":{"title":"Schema for an API specs version","type":"object","properties":{"id":{"type":"number"},"spec_link":{"type":"string"},"changelog_link":{"type":"string"},"version":{"type":"string"},"api_id":{"type":"number"},"is_published_specs":{"type":"boolean"},"is_published_changelog":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"example":{"id":1,"spec_link":"https://localhost/docs/","changelog_link":"https://localhost/docs/changelogs/","version":"1.0.1","is_published_specs":true,"is_published_changelog":true,"createdAt":"2022-09-09T13:00:08.888Z","updatedAt":"2022-09-09T13:00:08.888Z"}}},"responses":{"http-status-400":{"description":"Bad Request -- Something in the `Request` body was not syntactically valid or was missing completely.","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/http-status-400"}}}},"http-status-401":{"description":"Unauthorized -- Token was missing or invalid.","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/http-status-error-without-errors-field"},"examples":{"TokenNotFound":{"value":{"type":"unauthorized","title":"Error while authenticating the user","status":401,"detail":"Authorization token not found.","instance":"urn:/v1/apis/dtn-weather-conditions-api/versions/1:requestId:e5384521-506c-4af6-bd6d-c5f3691f1bde"}},"TokenInvalid":{"value":{"type":"unauthorized","title":"Error while authenticating the user","status":401,"detail":"Authorization token was invalid or malformed.","instance":"urn:/v1/apis/dtn-weather-conditions-api/versions/1:requestId:e5384521-506c-4af6-bd6d-c5f3691f1bde"}},"TokenVerificationFailed":{"value":{"type":"unauthorized","title":"Error while authenticating the user","status":401,"detail":"Token verification failed.","instance":"urn:/v1/apis/dtn-weather-conditions-api/versions/1:requestId:e5384521-506c-4af6-bd6d-c5f3691f1bde"}}}}}},"http-status-404":{"description":"Not Found -- The resource was not found.","headers":{"X-Request-ID":{"$ref":"#/components/headers/x-request-id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/http-status-error-without-errors-field"},"examples":{"ResourceNotFoundError":{"value":{"type":"not-found","title":"Not Found","status":404,"detail":"Resource was not found.","instance":"urn:dtn:dev-portal-api:/resource/name:requestId:e5384521-506c-4af6-bd6d-c5f3691f1bde"}}}}}},"ErrorResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Error":{"value":{"status":"error","code":"invalid-token","description":"bad token"}}}}},"description":"info about error"},"HealthCheckReport":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthCheck"},"examples":{"Success":{"value":{"status":"up","version":"v2","info":"Service is healthy.","timestamp":"2018-02-10T09:30Z","env":"unknown"}}}}},"description":"Health Check report"}}},"tags":[{"name":"APIs","description":"Endpoints for the api/catalog resources"},{"name":"Health","description":"Utility endpoints used by K8s"}]}