{"openapi":"3.1.0","info":{"title":"Field Health Imagery API","version":"0.1.0"},"paths":{"/v1/auth/sas-token":{"get":{"tags":["Enrollments"],"summary":"Get Sas Token","description":"This method was introduced to guarantee that the method _get_sas_token is always called\nwith a normalized customer_id. Otherwise, the cache would not work properly if the customer_id\nis passed in different cases (e.g., \"Customer1\" vs \"customer1\").","operationId":"get_sas_token_v1_auth_sas_token_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"},"trace_id":{"title":"Trace Id","type":"string"},"details":{"anyOf":[{},{"type":"null"}],"default":null,"title":"Details"}},"required":["code","message","trace_id"],"title":"ErrorResponse","type":"object"}}}}}}},"/v1/enrollments":{"post":{"tags":["Enrollments"],"summary":"Submit Enrollment","operationId":"submit_enrollment_v1_enrollments_post","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_submit_enrollment_v1_enrollments_post"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"},"trace_id":{"title":"Trace Id","type":"string"},"details":{"anyOf":[{},{"type":"null"}],"default":null,"title":"Details"}},"required":["code","message","trace_id"],"title":"ErrorResponse","type":"object"}}}}}},"get":{"tags":["Enrollments"],"summary":"List Enrollments","operationId":"list_enrollments_v1_enrollments_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/EnrollmentStatus"},{"type":"null"}],"title":"Status"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Opaque cursor; pass back the `next_cursor` from the previous response","title":"Cursor"},"description":"Opaque cursor; pass back the `next_cursor` from the previous response"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Page size","default":50,"title":"Limit"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"},"trace_id":{"title":"Trace Id","type":"string"},"details":{"anyOf":[{},{"type":"null"}],"default":null,"title":"Details"}},"required":["code","message","trace_id"],"title":"ErrorResponse","type":"object"}}}}}}},"/v1/enrollments/{enrollment_id}":{"get":{"tags":["Enrollments"],"summary":"Get Enrollment Status","operationId":"get_enrollment_status_v1_enrollments__enrollment_id__get","parameters":[{"name":"enrollment_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"title":"Enrollment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"},"trace_id":{"title":"Trace Id","type":"string"},"details":{"anyOf":[{},{"type":"null"}],"default":null,"title":"Details"}},"required":["code","message","trace_id"],"title":"ErrorResponse","type":"object"}}}}}}}},"components":{"schemas":{"Body_submit_enrollment_v1_enrollments_post":{"properties":{"request":{"type":"string","contentMediaType":"application/octet-stream","title":"Request","description":"JSON metadata file (application/json)"},"geojson":{"type":"string","contentMediaType":"application/octet-stream","title":"Geojson","description":"GeoJSON file (application/geo+json)"}},"type":"object","required":["request","geojson"],"title":"Body_submit_enrollment_v1_enrollments_post"},"EnrollmentListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EnrollmentResponse"},"type":"array","title":"Items"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},"type":"object","required":["items"],"title":"EnrollmentListResponse"},"EnrollmentResponse":{"properties":{"enrollment_id":{"type":"string","title":"Enrollment Id","description":"Enrollment ID"},"message":{"type":"string","title":"Message","description":"Enrollment ID"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Enrollment description"},"request_metadata":{"additionalProperties":true,"type":"object","title":"Request Metadata","description":"Request metadata"},"status":{"$ref":"#/components/schemas/EnrollmentStatus","description":"Enrollment status","default":"received"},"total_fields":{"type":"integer","title":"Total Fields","description":"Total fields.","default":0},"processed_fields":{"type":"integer","title":"Processed Fields","description":"Processed fields.","default":0},"failed_fields":{"type":"integer","title":"Failed Fields","description":"Failed fields.","default":0},"created_date_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Date Time","description":"Created datetime."},"completed_date_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed Date Time","description":"Completed datetime."},"errors":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Errors","description":"Error samples encountered"}},"additionalProperties":false,"type":"object","required":["request_metadata"],"title":"EnrollmentResponse"},"EnrollmentStatus":{"type":"string","enum":["received","in_progress","completed","failed"],"title":"EnrollmentStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"StorageInfo":{"properties":{"account_name":{"type":"string","title":"Account Name","description":"The account name"},"file_system":{"type":"string","title":"File System","description":"The file system (container) name"},"sas_token":{"type":"string","title":"Sas Token","description":"The SAS token"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"The storage path"}},"additionalProperties":false,"type":"object","required":["account_name","file_system","sas_token"],"title":"StorageInfo"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"servers":[{"url":"/fhi"}]}