uds.2023.10.17.openapi.json

{"openapi":"3.1.0","info":{"title":"Unity UDS API","description":"API to interact with UDS services","version":"0.1.0"},"paths":{"/sbx-uds-dapa/admin/auth/":{"delete":{"tags":["Admin Records CRUD","Admins-Only"],"summary":"Delete Auth Mapping","description":"Deleting one authorization mapping","operationId":"delete_auth_mapping_sbx_uds_dapa_admin_auth__delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthDeleteModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Admin Records CRUD","Admins-Only"],"summary":"Add Auth Mapping","description":"Adding a new Authorization mapping","operationId":"add_auth_mapping_sbx_uds_dapa_admin_auth__put","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Admin Records CRUD","Admins-Only"],"summary":"Update Auth Mapping","description":"Updating existing authorization mapping","operationId":"update_auth_mapping_sbx_uds_dapa_admin_auth__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Admin Records CRUD","Admins-Only"],"summary":"List Auth Mappings","description":"Listing all exsiting Authorization Mapping.","operationId":"list_auth_mappings_sbx_uds_dapa_admin_auth__get","parameters":[{"name":"tenant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant"}},{"name":"venue","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Venue"}},{"name":"group_names","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Names"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/admin/system/es_setup/":{"put":{"tags":["System Admin Records CRUD"],"summary":"Es Setup","operationId":"es_setup_sbx_uds_dapa_admin_system_es_setup__put","parameters":[{"name":"tenant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant"}},{"name":"venue","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Venue"}},{"name":"group_names","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Names"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/collections/":{"put":{"tags":["Collection CRUD API"],"summary":"Ingest Cnm Dapa","description":"Ingestion of Granules for a given collection via CNM\n\nThis is a facade endpoint which will trigger another endpoint which takes some time to execute ingestion","operationId":"ingest_cnm_dapa_sbx_uds_dapa_collections__put","parameters":[{"name":"response_class","in":"query","required":false,"schema":{"title":"Response Class"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnmRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Collection CRUD API"],"summary":"Create New Collection","description":"Creating a new Cumulus Collection\n\nThis is a facade endpoint which will trigger another endpoint which takes some time to hit Cumulus collection creation endpoint.","operationId":"create_new_collection_sbx_uds_dapa_collections__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CumulusCollectionModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Collection CRUD API"],"summary":"Query Collections","operationId":"query_collections_sbx_uds_dapa_collections__get","parameters":[{"name":"collection_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Collection Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":10,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/collections/actual/":{"put":{"tags":["Collection CRUD API"],"summary":"Ingest Cnm Dapa Actual","description":"Real ingestion of Granules for a given collection via CNM\n\nThis will take some time to repeatedly create SNS messages for CNM","operationId":"ingest_cnm_dapa_actual_sbx_uds_dapa_collections_actual__put","parameters":[{"name":"response_class","in":"query","required":false,"schema":{"title":"Response Class"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnmRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/collections/{collection_id}/":{"get":{"tags":["Collection CRUD API"],"summary":"Query Collections","operationId":"query_collections_sbx_uds_dapa_collections__collection_id___get","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Collection Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":10,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/collections/{collection_id}/variables/":{"get":{"tags":["Granules CRUD API"],"summary":"Get Granules Dapa","operationId":"get_granules_dapa_sbx_uds_dapa_collections__collection_id__variables__get","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","title":"Collection Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/collections/{collection_id}/items/":{"get":{"tags":["Granules CRUD API"],"summary":"Get Granules Dapa","operationId":"get_granules_dapa_sbx_uds_dapa_collections__collection_id__items__get","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","title":"Collection Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":10,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"title":"Offset"}},{"name":"datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Datetime"}},{"name":"filter_input","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Input"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/admin/custom_metadata/{tenant}/":{"put":{"tags":["Custom Metadata Index CRUD"],"summary":"Es Granules Index Setup","operationId":"es_granules_index_setup_sbx_uds_dapa_admin_custom_metadata__tenant___put","parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string","title":"Tenant"}},{"name":"venue","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Venue"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","default":{},"title":"Request Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Custom Metadata Index CRUD"],"summary":"Es Granules Index Setup","operationId":"es_granules_index_setup_sbx_uds_dapa_admin_custom_metadata__tenant___get","parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string","title":"Tenant"}},{"name":"venue","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Venue"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Custom Metadata Index CRUD"],"summary":"Es Granules Index Delete Setup","operationId":"es_granules_index_delete_setup_sbx_uds_dapa_admin_custom_metadata__tenant___delete","parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string","title":"Tenant"}},{"name":"venue","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Venue"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sbx-uds-dapa/admin/custom_metadata/{tenant}/destroy/":{"delete":{"tags":["Custom Metadata Index CRUD"],"summary":"Es Granules Index Setup","operationId":"es_granules_index_setup_sbx_uds_dapa_admin_custom_metadata__tenant__destroy__delete","parameters":[{"name":"tenant","in":"path","required":true,"schema":{"type":"string","title":"Tenant"}},{"name":"venue","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Venue"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"summary":"Root","operationId":"root__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sbx-uds-dapa/openapi/":{"get":{"summary":"Get Open Api","operationId":"get_open_api_sbx_uds_dapa_openapi__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AuthAddModel":{"properties":{"tenant":{"type":"string","title":"Tenant"},"venue":{"type":"string","title":"Venue"},"group_name":{"type":"string","title":"Group Name"},"resources":{"items":{"type":"string"},"type":"array","title":"Resources"},"actions":{"items":{"type":"string"},"type":"array","title":"Actions"}},"type":"object","required":["tenant","venue","group_name","resources","actions"],"title":"AuthAddModel"},"AuthDeleteModel":{"properties":{"tenant":{"type":"string","title":"Tenant"},"venue":{"type":"string","title":"Venue"},"group_name":{"type":"string","title":"Group Name"}},"type":"object","required":["tenant","venue","group_name"],"title":"AuthDeleteModel"},"CnmRequestBody":{"properties":{"provider_id":{"type":"string","title":"Provider Id"},"features":{"items":{"$ref":"#/components/schemas/SingleFeatureRequestBody"},"type":"array","title":"Features"}},"type":"object","required":["provider_id","features"],"title":"CnmRequestBody"},"CumulusCollectionModel":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","default":"Collection"},"stac_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stac Version","default":"1.0.0"},"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","default":"TODO"},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License","default":"proprietary"},"summaries":{"$ref":"#/components/schemas/SummariesModel"},"links":{"items":{"$ref":"#/components/schemas/CumulusLinkModel"},"type":"array","title":"Links"},"providers":{"items":{"type":"object"},"type":"array","title":"Providers"},"extent":{"$ref":"#/components/schemas/ExtentModel"}},"type":"object","required":["id","title","summaries","links","providers","extent"],"title":"CumulusCollectionModel","description":"    {\"type\": \"Collection\", \"id\": \"URN:NASA:UNITY:MAIN_PROJECT:DEV:CUMULUS_DAPA_UNIT_TEST___1697248243\", \"stac_version\": \"1.0.0\",\n    \"description\": \"TODO\",\n    \"links\": [\n{\"rel\": \"root\", \"href\": \"./collection.json?bucket=internal&regex=%5EP%5B0-9%5D%7B3%7D%5B0-9%5D%7B4%7D%5BA-Z%5D%7B13%7DT%5B0-9%5D%7B12%7D01.PDS%24\", \"type\": \"application/json\", \"title\": \"P1570515ATMSSCIENCEAXT11344000000001.PDS\"},\n{\"rel\": \"item\", \"href\": \"./collection.json?bucket=internal&regex=%5EP%5B0-9%5D%7B3%7D%5B0-9%5D%7B4%7D%5BA-Z%5D%7B13%7DT%5B0-9%5D%7B12%7D00.PDS.cmr.xml%24\", \"type\": \"metadata\", \"title\": \"P1570515ATMSSCIENCEAXT11344000000000.PDS.cmr.xml\"},\n{\"rel\": \"item\", \"href\": \"./collection.json?bucket=internal&regex=%5EP%5B0-9%5D%7B3%7D%5B0-9%5D%7B4%7D%5BA-Z%5D%7B13%7DT%5B0-9%5D%7B12%7D01%5C.PDS%5C.xml%24\", \"type\": \"metadata\", \"title\": \"P1570515ATMSSCIENCEAXT11344000000001.PDS.xml\"},\n{\"rel\": \"item\", \"href\": \"./collection.json?bucket=internal&regex=%5EP%5B0-9%5D%7B3%7D%5B0-9%5D%7B4%7D%5BA-Z%5D%7B13%7DT%5B0-9%5D%7B12%7D00%5C.PDS%24\", \"type\": \"data\", \"title\": \"P1570515ATMSSCIENCEAXT11344000000000.PDS\"}],\n\"title\": \"P1570515ATMSSCIENCEAXT11344000000001.PDS\",\n\"extent\": {\"spatial\": {\"bbox\": [[0, 0, 0, 0]]},\n\"temporal\": {\"interval\": [[\"2023-10-13T18:51:02.397693Z\", \"2023-10-13T18:51:02.397698Z\"]]}},\n\"license\": \"proprietary\",\n\"providers\": [{\"name\": \"unity\"}],\n\"summaries\": {\"granuleId\": [\"^P[0-9]{3}[0-9]{4}[A-Z]{13}T[0-9]{12}0$\"], \"granuleIdExtraction\": [\"(P[0-9]{3}[0-9]{4}[A-Z]{13}T[0-9]{12}0).+\"],\n\"process\": [\"modis\"]}}\n    "},"CumulusLinkModel":{"properties":{"rel":{"type":"string","title":"Rel"},"href":{"type":"string","title":"Href"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","default":""},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","default":""}},"type":"object","required":["rel","href"],"title":"CumulusLinkModel"},"ExtentModel":{"properties":{"temporal":{"type":"object","title":"Temporal"},"spatial":{"type":"object","title":"Spatial"}},"type":"object","required":["temporal","spatial"],"title":"ExtentModel"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SingleFeatureRequestBody":{"properties":{"id":{"type":"string","title":"Id"},"collection":{"type":"string","title":"Collection"},"assets":{"type":"object","title":"Assets"}},"type":"object","required":["id","collection","assets"],"title":"SingleFeatureRequestBody"},"SummariesModel":{"properties":{"granuleId":{"items":{"type":"string"},"type":"array","title":"Granuleid"},"granuleIdExtraction":{"items":{"type":"string"},"type":"array","title":"Granuleidextraction"},"process":{"items":{"type":"string"},"type":"array","title":"Process"}},"type":"object","required":["granuleId","granuleIdExtraction","process"],"title":"SummariesModel"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}