{"openapi":"3.1.0","info":{"version":"v1","title":"Lumen Oil API","description":"Oil demand and supply REST API."},"servers":[{"url":"/"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"WorkOS API key"}},"schemas":{},"parameters":{}},"paths":{"/api/rest/v1/demand/query":{"post":{"operationId":"queryDemand","summary":"Query oil demand data","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","minimum":0,"default":0},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":1000,"default":1000},"filter":{"type":"object","properties":{"countryName":{"type":"array","items":{"type":"string","minLength":1},"default":[]},"regionCode":{"type":"array","items":{"type":"string","minLength":1},"default":[]},"month":{"anyOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},{"type":"object","properties":{"gt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"gte":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"lt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"lte":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}},"additionalProperties":false},{"type":"null"}],"default":null}}},"orderBy":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["countryName","regionCode","productName","month","value"]},"asc":{"type":"boolean","default":true}},"required":["field"]}}}}}}},"responses":{"200":{"description":"Demand data page","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"countryName":{"type":"string","minLength":1},"regionCode":{"type":"string","minLength":1},"productName":{"type":"string","minLength":1},"month":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"demand":{"type":["number","null"]}},"required":["countryName","regionCode","productName","month","demand"]}},"total":{"type":"integer","minimum":0},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"integer","minimum":0}},"required":["rows","total","limit","offset"]}}}},"400":{"description":"Validation error"},"401":{"description":"Missing API key"},"403":{"description":"Invalid API key"}}}},"/api/rest/v1/supply/query":{"post":{"operationId":"querySupply","summary":"Query oil supply data","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","minimum":0,"default":0},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":1000,"default":1000},"filter":{"type":"object","properties":{"countryName":{"type":"array","items":{"type":"string","minLength":1},"default":[]},"regionCode":{"type":"array","items":{"type":"string","minLength":1},"default":[]},"month":{"anyOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},{"type":"object","properties":{"gt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"gte":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"lt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"lte":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}},"additionalProperties":false},{"type":"null"}],"default":null}}},"orderBy":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["countryName","regionCode","productName","month","value"]},"asc":{"type":"boolean","default":true}},"required":["field"]}}}}}}},"responses":{"200":{"description":"Supply data page","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"countryName":{"type":"string","minLength":1},"regionCode":{"type":"string","minLength":1},"productName":{"type":"string","minLength":1},"month":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"supply":{"type":["number","null"]}},"required":["countryName","regionCode","productName","month","supply"]}},"total":{"type":"integer","minimum":0},"limit":{"type":"integer","exclusiveMinimum":0},"offset":{"type":"integer","minimum":0}},"required":["rows","total","limit","offset"]}}}},"400":{"description":"Validation error"},"401":{"description":"Missing API key"},"403":{"description":"Invalid API key"}}}}},"webhooks":{}}