{"openapi":"3.0.2","info":{"title":"AAP Web Service","version":"1.0","description":"This is the AAP Web Service API for interacting with a AAP Server.","contact":{"name":"Naval Research Laboratory - Marine Meteorology Division","url":"https://www.nrlmry.navy.mil","email":"chad.hutchins@nrlmry.navy.mil"}},"components":{"schemas":{"nrlsam":{"type":"object","properties":{"reuse_existing_results":{"type":"boolean","example":true},"rmax_terrain_m":{"type":"number","example":20000},"dr_terrain_m":{"type":"number","example":100},"num_radials":{"type":"number","example":16},"nprocs_mpi":{"type":"number","example":32},"z_ppwl":{"type":"number","example":10},"r_ppwl":{"type":"number","example":3},"nrealizations":{"type":"number","example":1},"nwpt_interp":{"type":"number","example":64},"runpe":{"type":"boolean","example":true}}},"ambientnoise":{"type":"object","properties":{"title":{"type":"string"},"variables":{"type":"array","items":{"type":"string"}},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/AmbientNoiseProfileEntity"}}},"example":{"title":"Mil Standard 1474D and ARMY Ambients","variables":["Frequency, Hz\"","SPL, dB"],"profiles":[{"zone":"DARPA Low","profile":{"frequencies":[10,12.5,16,20,25,31.5,40,50,63,80,100,125,160,200,250,315,400,500,630,800,1000,1250,1600,2000,2500,3150,4000,5000,6300,8000,10000],"spl":[40,40,40,40,40,40,37.7,35.3,34.7,34.4,31.4,29.6,26.7,24,21.8,19.5,17.9,16,14.3,11.9,10.6,9.2,7.7,6.6,5.7,4.6,4.5,4.3,4,2.8,2.5]}},{"zone":"DARPA Moderate","profile":{"frequencies":[10,12.5,16,20,25,31.5,40,50,63,80,100,125,160,200,250,315,400,500,630,800,1000,1250,1600,2000,2500,3150,4000,5000,6300,8000,10000],"spl":[55.1,54.9,53.4,52.6,50.7,49.6,50.6,48.3,47.2,46.4,43.9,40.7,36.7,32.4,28.9,26.6,24.3,22.5,21,19.4,17.9,17.4,17.7,17.5,17,16.8,16.3,16.1,15.9,15.6,15.5]}},{"zone":"ARMY Low","profile":{"frequencies":[10,12.5,16,20,25,31.5,40,50,63,80,100,125,160,200,250,315,400,500,630,800,1000,1250,1600,2000,2500,3150,4000,5000,6300,8000,10000],"spl":[40,40,40,40,40,40,40,40,40,40,40,40,37,33,30,27,23,20,20,20,20,20,20,20,18,16,15,13,11,10,10]}},{"zone":"ARMY Moderate","profile":{"frequencies":[10,12.5,16,20,25,31.5,40,50,63,80,100,125,160,200,250,315,400,500,630,800,1000,1250,1600,2000,2500,3150,4000,5000,6300,8000,10000],"spl":[60,60,60,60,60,60,60,60,60,60,60,60,56,51,48,43,40,36,36,36,36,36,36,36,34,32.5,31,29,28,26,24]}},{"zone":"ARMY High","profile":{"frequencies":[10,12.5,16,20,25,31.5,40,50,63,80,100,125,160,200,250,315,400,500,630,800,1000,1250,1600,2000,2500,3150,4000,5000,6300,8000,10000],"spl":[75,75,75,75,75,75,75,75,75,75,75,75,72,68,65,62,58,55,55,55,55,55,55,55,53,51,50,48,46,45,45]}}]}},"pe":{"type":"object","properties":{"title":{"type":"string","example":"title"},"pe_id":{"type":"string","example":"pe_id"},"profile_type":{"type":"string","example":"atm"},"profile_filename":{"type":"string","example":"p_filename"},"sl_filename":{"type":"string","example":"sl_filename"},"frequency_hz":{"type":"number","example":63},"save_complexpressure":{"type":"number","example":0},"geometry":{"type":"string","example":"pointsource"},"radial_deg":{"type":"number","example":0},"c0":{"type":"number","example":340},"np_pade":{"type":"number","example":4},"ns_pade":{"type":"number","example":1},"np_exp":{"type":"number","example":2},"zmax_agl_m":{"type":"number","example":1500},"zs_agl_m":{"type":"number","example":200},"zr_agl_m":{"type":"number","example":0},"dz_m":{"type":"number","example":0.2},"dr_m":{"type":"number","example":2},"dr_save_m":{"type":"number","example":10},"dz_save_m":{"type":"number","example":2},"max_slope":{"type":"number","example":0.6},"tau":{"type":"number","example":2},"niter":{"type":"number","example":20},"niter_print":{"type":"number","example":1},"use_epade":{"type":"number","example":1},"rpade_rotation_deg":{"type":"number","example":90}}},"getNewRunID":{"type":"object","properties":{"id":{"type":"string","example":"63baf9e0185adec5655f998cb330c5e3a9a1481433a88938b99ef72f2b2b0d98"}}},"AmbientNoiseProfileEntity":{"type":"object","properties":{"zone":{"type":"string"},"profile":{"type":"object","properties":{"frequencies":{"type":"array","items":{"type":"number"}},"spl":{"type":"array","items":{"type":"number"}}}}},"example":[{"zone":"ARMY Low","profile":{"frequencies":[10,12.5,16,20,25,31.5,40,50,63,80,100,125,160,200,250,315,400,500,630,800,1000,1250,1600,2000,2500,3150,4000,5000,6300,8000,10000],"spl":[40,40,40,40,40,40,40,40,40,40,40,40,37,33,30,27,23,20,20,20,20,20,20,20,18,16,15,13,11,10,10]}}]},"waypoint":{"type":"object","properties":{"location":{"type":"string","example":"[102.0, 0.0]"},"altitude":{"type":"number","example":500},"turnAngle":{"type":"number","example":100},"turnRadius":{"type":"number","example":0},"speed":{"type":"number","example":40},"aoa":{"type":"number","example":0},"roll":{"type":"number","example":0},"nacelle":{"type":"number","example":90.0}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"63baf9e0185adec5655f998cb330c5e3a9a1481433a88938b99ef72f2b2b0d98"},"title":{"type":"string","example":"Sample AAP title"},"classification":{"type":"object","properties":{"level":{"type":"string","enum":["UNCLASSIFIED","CONFIDENTUAL","SECRET","TOP SECRET"],"example":"UNCLASSIFIED"},"sci":{"type":"boolean","example":false},"caveats":{"type":"string","example":"NOFORN"},"barColor":{"type":"string","example":"green"},"textColor":{"type":"string","example":"white"}}}}},"AAP":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/metadata"},"configuration":{"type":"object","properties":{"PE":{"$ref":"#/components/schemas/pe"},"SAM":{"$ref":"#/components/schemas/nrlsam"},"AmbientNoise":{"$ref":"#/components/schemas/AmbientNoiseProfileEntity"}}},"weather":{"$ref":"#/components/schemas/weather"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1},"waypoints":{"type":"array","items":{"$ref":"#/components/schemas/waypoint"}}}}}}},"weather":{"type":"object","properties":{"user":{"type":"string","example":"hutchins"},"project":{"type":"string","example":"Yuma"},"dtg":{"type":"integer","example":2022010100},"nest":{"type":"integer","example":3}}}}},"paths":{"/status":{"get":{"tags":["Web Service Information"],"summary":"Status of AAP Web Service","description":"General Status","parameters":[],"operationId":"status","responses":{"200":{"description":"OK"}}}},"/aap":{"get":{"tags":["AAP Config Services"],"summary":"AAP Configuration Overview","description":"Returns the current settings for the system","parameters":[],"operationId":"aap","responses":{"200":{"description":"NRLSAM, AmbientNoise, and PE settings","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/nrlsam"},{"$ref":"#/components/schemas/ambientnoise"},{"$ref":"#/components/schemas/pe"}]}}}}}}}},"/aap/config/availableAmbients":{"get":{"tags":["AAP Config Services"],"summary":"Get Default NRLSAM Configuration","description":"Returns all available ambient noise profiles","parameters":[],"operationId":"getAvailableAmbients","responses":{"200":{"description":"An Array of Ambient Noise JSON Objects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ambientnoise"}}}}}}},"/aap/config/default/nrlsam":{"get":{"tags":["AAP Config Services"],"summary":"Get Default NRLSAM Configuration","description":"Pre-Installed NRLSAM Configuration","parameters":[],"operationId":"getDefaultNRLSAM","responses":{"200":{"description":"NRLSAM JSON Object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nrlsam"}}}}}}},"/aap/config/default/ambientnoise":{"get":{"tags":["AAP Config Services"],"summary":"Get Default Ambient Noise","description":"Returns the system default ambient noise profile entitiy","parameters":[],"operationId":"getDefaultAmbientNoise","responses":{"200":{"description":"Ambient Noise JSON Object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmbientNoiseProfileEntity"}}}}}}},"/aap/config/default/pe":{"get":{"tags":["AAP Config Services"],"summary":"Get Default PE Configuration","description":"Returns the system default PE configuration","parameters":[],"operationId":"getDefaultPE","responses":{"200":{"description":"PE JSON Object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pe"}}}}}}},"/aap/run/id":{"get":{"tags":["AAP Run Services"],"summary":"Get a New Run ID","parameters":[],"operationId":"getNewRunID","responses":{"200":{"description":"Returns a SHA Run ID to Use for Configurating a Run","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getNewRunID"}}}}}}},"/aap/run/{id}":{"get":{"tags":["AAP Run Services"],"summary":"Get AAP Data for ID","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"operationId":"getAAPData","responses":{"200":{"description":"Returns a AAP Object for a Given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AAP"}}}}}},"post":{"tags":["AAP Run Services"],"summary":"Submit New AAP Run","operationId":"submitNewAAPRun","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Optional description in *Markdown*","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AAP"}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"string","example":"Message about why the request was bad."}}}},"500":{"description":"Error on Server","content":{"text/plain":{"schema":{"type":"string","example":"Server Error Message."}}}}}}}}}