{"openapi":"3.0.2","info":{"title":"Nwave HTTP ingestion","version":"1.0.0"},"paths":{"/v1/ingest":{"post":{"tags":["LoRaWAN Message Ingestion"],"summary":"Ingest Message","operationId":"ingest_message_v1_ingest_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionMessageV1"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/healthcheck":{"get":{"tags":["Service Healthcheck"],"summary":"Healthcheck","operationId":"healthcheck_v1_healthcheck_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResponse"}}}}}}}},"components":{"schemas":{"BaseResponse":{"title":"BaseResponse","required":["reason"],"type":"object","properties":{"message":{"title":"Message","type":"string"},"reason":{"$ref":"#/components/schemas/ReasonEnum"},"data":{"title":"Data"}},"description":"HTTP base response model"},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"IngestionMessageV1":{"title":"IngestionMessageV1","required":["dev_eui","received_at","uplink_message"],"type":"object","properties":{"dev_eui":{"title":"Dev Eui","type":"string"},"received_at":{"title":"Received At","type":"string","format":"date-time"},"uplink_message":{"$ref":"#/components/schemas/UplinkMessage"}}},"Location":{"title":"Location","type":"object","properties":{"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"}}},"ReasonEnum":{"title":"ReasonEnum","enum":["ok","created","invalid_field","no_data","not_found","not_implemented","restricted","server_error"],"type":"string","description":"Enum for response's reason"},"RxMetadata":{"title":"RxMetadata","type":"object","properties":{"gateway_ids":{"title":"Gateway Ids","type":"string"},"rssi":{"title":"Rssi","type":"integer"},"snr":{"title":"Snr","type":"integer","default":-99},"location":{"$ref":"#/components/schemas/Location"}}},"SuccessfulResponse":{"title":"SuccessfulResponse","required":["data"],"type":"object","properties":{"message":{"title":"Message","type":"string"},"reason":{"allOf":[{"$ref":"#/components/schemas/ReasonEnum"}],"default":"ok"},"data":{"$ref":"#/components/schemas/SuccessfulResponseData"}},"description":"HTTP successful response model"},"SuccessfulResponseData":{"title":"SuccessfulResponseData","required":["device_id","trace_id"],"type":"object","properties":{"device_id":{"title":"Device Id","type":"string"},"trace_id":{"title":"Trace Id","type":"string","format":"uuid"}},"description":"Successful response data model"},"UplinkMessage":{"title":"UplinkMessage","required":["f_cnt","f_port","f_payload"],"type":"object","properties":{"f_cnt":{"title":"F Cnt","type":"integer"},"f_port":{"title":"F Port","type":"integer"},"f_payload":{"title":"F Payload","type":"string"},"trace_id":{"title":"Trace Id","type":"string","format":"uuid"},"bandwidth":{"title":"Bandwidth","type":"integer"},"spreading_factor":{"title":"Spreading Factor","type":"integer"},"coding_rate":{"title":"Coding Rate","type":"string"},"frequency":{"title":"Frequency","type":"string"},"confirmed":{"title":"Confirmed","type":"boolean"},"rx_metadata":{"title":"Rx Metadata","type":"array","items":{"$ref":"#/components/schemas/RxMetadata"},"default":[{"snr":-99}]}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-Auth-Token"}}}} |