POST api/schedule_task - missing required fields

cerobpm commented 6 months ago

Al crear una nueva schedule_task, se requieren los siguientes campos, pero no están incluidos en el schema:

Request:

curl -X POST "http://localhost:5001/api/schedule_task" -H "accept: application/json" -H "Authorization: Basic YWRtaW5AaW5hLmNvbS5hcjpwYXNzd29yZA==" -H "Content-Type: application/json" -d "{\"$schema\":\"../schemas/schedule_task.json\",\"border_conditions\":[{\"river\":\"Bravo\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31556},{\"river\":\"Mini\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31558},{\"river\":\"BarcaGrande\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31562},{\"river\":\"Sauce\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31561},{\"river\":\"Parana\",\"reach\":\"ParanaAA\",\"river_stat\":\"224000\",\"interval\":\"1-DAY\",\"type\":\"Stage Hydrograph\",\"series_id\":35205},{\"river\":\"LaBarquita\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31568},{\"river\":\"CanaldelEste\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31564},{\"river\":\"Lujan\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31557},{\"river\":\"SanAntonio\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31560},{\"river\":\"Lujan\",\"reach\":\"1\",\"river_stat\":\"30.664\",\"interval\":\"1-DAY\",\"type\":\"Flow Hydrograph\",\"series_id\":31530},{\"river\":\"Palmas\",\"reach\":\"Desembocadura\",\"river_stat\":\"6246.783\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31565},{\"river\":\"Gutierrez\",\"reach\":\"Desembocadura\",\"river_stat\":\"1960.748\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31567},{\"river\":\"Guazu\",\"reach\":\"Desembocadura\",\"river_stat\":\"8000\",\"interval\":\"1-HOUR\",\"type\":\"Stage Hydrograph\",\"series_id\":31566},{\"river\":\"Ibicuy\",\"reach\":\"Ibicuy\",\"river_stat\":\"67.930*\",\"interval\":\"1-DAY\",\"type\":\"Lateral Inflow Hydrograph\",\"series_id\":31570}],\"description\":\"Corrida operativa hidrodelta\",\"enabled\":false,\"frequency\":5,\"geometry\":\"DeltaParana_2016.g23\",\"initial_flows\":[],\"name\":\"Hidrodelta operativo\",\"plan_series_list\":[{\"river\":\"Guazu\",\"reach\":\"4\",\"river_stat\":\"4\",\"stage_series_id\":2830,\"flow_series_id\":-1},{\"river\":\"Guazu\",\"reach\":\"Desembocadura\",\"river_stat\":\"8000\",\"stage_series_id\":1710,\"flow_series_id\":-1},{\"river\":\"Guazu\",\"reach\":\"3\",\"river_stat\":\"1\",\"stage_series_id\":1712,\"flow_series_id\":-1},{\"river\":\"Gutierrez\",\"reach\":\"Desembocadura\",\"river_stat\":\"19967.07\",\"stage_series_id\":44,\"flow_series_id\":-1},{\"river\":\"Ibicuy\",\"reach\":\"Ibicuy\",\"river_stat\":\"7.16\",\"stage_series_id\":45,\"flow_series_id\":-1},{\"river\":\"Lujan\",\"reach\":\"1\",\"river_stat\":\"24.421\",\"stage_series_id\":42,\"flow_series_id\":-1},{\"river\":\"Lujan\",\"reach\":\"1\",\"river_stat\":\"18.0191\",\"stage_series_id\":50,\"flow_series_id\":-1},{\"river\":\"Lujan\",\"reach\":\"2\",\"river_stat\":\"5.828\",\"stage_series_id\":49,\"flow_series_id\":-1},{\"river\":\"Mini\",\"reach\":\"Desembocadura\",\"river_stat\":\"11.9\",\"stage_series_id\":51,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"2\",\"river_stat\":\"101864.4\",\"stage_series_id\":1714,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"3\",\"river_stat\":\"94654.47\",\"stage_series_id\":151,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"3\",\"river_stat\":\"68418.45\",\"stage_series_id\":5907,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"4\",\"river_stat\":\"57113.41\",\"stage_series_id\":41,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"4\",\"river_stat\":\"49019.05\",\"stage_series_id\":1711,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"5\",\"river_stat\":\"45033.09\",\"stage_series_id\":6163,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"8\",\"river_stat\":\"21307.62\",\"stage_series_id\":9999,\"flow_series_id\":-1},{\"river\":\"Palmas\",\"reach\":\"Desembocadura\",\"river_stat\":\"6246.783\",\"stage_series_id\":1702,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"ParanaAA\",\"river_stat\":\"224000\",\"stage_series_id\":5901,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"ParanaAA\",\"river_stat\":\"18.96\",\"stage_series_id\":1725,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"2b\",\"river_stat\":\"237194.8\",\"stage_series_id\":1770,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"2b\",\"river_stat\":\"223194.8\",\"stage_series_id\":1723,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"2b\",\"river_stat\":\"188533.7\",\"stage_series_id\":1722,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"2b\",\"river_stat\":\"143588.9\",\"stage_series_id\":5905,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"3\",\"river_stat\":\"126030.6\",\"stage_series_id\":36,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"3\",\"river_stat\":\"94846.95\",\"stage_series_id\":37,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"3\",\"river_stat\":\"44071.76\",\"stage_series_id\":38,\"flow_series_id\":-1},{\"river\":\"Parana\",\"reach\":\"4\",\"river_stat\":\"498.7283\",\"stage_series_id\":1717,\"flow_series_id\":-1},{\"river\":\"RioBaradero\",\"reach\":\"RioBaradero\",\"river_stat\":\"29.092*\",\"stage_series_id\":39,\"flow_series_id\":-1},{\"river\":\"Victoria\",\"reach\":\"Victoria\",\"river_stat\":\"82.92\",\"stage_series_id\":5894,\"flow_series_id\":-1},{\"river\":\"CarabelasGrande\",\"reach\":\"1\",\"river_stat\":\"33.3\",\"stage_series_id\":5876,\"flow_series_id\":-1},{\"river\":\"Gutierrez\",\"reach\":\"Desembocadura\",\"river_stat\":\"1960.748\",\"stage_series_id\":1836,\"flow_series_id\":-1},{\"river\":\"Bravo\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1832,\"flow_series_id\":-1},{\"river\":\"Sauce\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1842,\"flow_series_id\":-1},{\"river\":\"BarcaGrande\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1831,\"flow_series_id\":-1},{\"river\":\"LaBarquita\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1837,\"flow_series_id\":-1},{\"river\":\"Mini\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1839,\"flow_series_id\":-1},{\"river\":\"CanaldelEste\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1833,\"flow_series_id\":-1},{\"river\":\"SanAntonio\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1841,\"flow_series_id\":-1},{\"river\":\"Lujan\",\"reach\":\"Desembocadura\",\"river_stat\":\"0\",\"stage_series_id\":1838,\"flow_series_id\":-1}],\"start_condition_type\":\"restart_file\",\"start_datetime\":\"2021-12-21T00:00:00.000Z\"}"

Response (400, BAD REQUEST)

{
  "error": "Missing required fields",
  "missing": [
    "calibration_id",
    "calibration_id_for_simulations",
    "geometry_id",
    "observation_days",
    "forecast_days",
    "project_file",
    "plan_file"
  ]
}

schema:

ScheduleTaskSchema:
  type: object
  properties:
    id:
      type: integer
      example: 1
    name:
      type: string
      example: "Daily Water Level Check"
    description:
      type: string
      example: "Checks water levels of specified rivers daily."
    frequency:
      type: integer
      example: 24
    created_at:
      example: "2024-02-11T16:43:32"
      type: string
      format: date-time
    start_datetime:
      example: "2024-02-12T08:00:00"
      type: string
      format: date-time
    enabled:
      type: boolean
      example: true
    geometry:
      type: string
      example: "POINT(30 10)"
    user:
      type: string
      example: "admin@example.com"
    initial_flow_list:
      type: array
      items:
        $ref: '#/components/schemas/InitialFlowSchema'
    border_conditions:
      type: array
      items:
        $ref: '#/components/schemas/BorderConditionSchema'
    plan_series_list:
      type: array
      items:
        $ref: '#/components/schemas/PlanSeriesSchema'

@azulzaietz @manulon @federicoburman

cerobpm commented 6 months ago

Por otro lado veo que en la respuesta a GET api/schedule_task/{id} tampoco están esos campos. Sería importante que una configuración descargada sirva para recrearla.

federicoburman commented 6 months ago

Esos campos que dicen que son required no deberian serlo? Lo eliminamos

jbianchi81 commented 6 months ago

Sí, son requeridos. Habría que agregarlos al schema

federicoburman commented 6 months ago

Arreglado, ya esta completo el schema de swagger y tira excepcion si cuando se crea la schedule task se la crea con enabled true

cerobpm commented 5 months ago

Estaría bueno que al tirar la excepción dé un mensaje al frontend más explicativo, tipo "error al crear corrida programada: no se puede create con enabled:true"

cerobpm commented 5 months ago

Todavía falta agregar "project_file" y "plan_file" a la respuesta de GET /schedule_task/{id}

azulzaietz commented 4 months ago

Hola Juan, una pregunta, en este caso qué te gustaría que se muestre en la salida? Si está presente?

En minio, se guardan todos los archivos subidos con los mismos nombres: "plan_template" y "prj_template". Se diferencian porque cada uno está dentro de la carpeta con el número de ID correspondiente. Entonces, si a la salida agregamos los nombres de los archivos, para todos los casos van a ser los mismos. No se guarda el nombre original del archivo en minio.

La implementación estaba así y nosotros no la modificamos. Vos querías obtener el nombre original del archivo subido para cada caso?

cerobpm commented 4 months ago

Mi idea es que la salida de GET /schedule_task/{id}, sin modificar, se pueda usar para POST /schedule_task (para poder backupear y recrear una corrida programada). Si los nombres de los archivos son fijos, entonces simplemente sería agregar

"project_file": "prj_template.txt",
"plan_file": "plan_template.txt",

a la salida del GET

azulzaietz commented 4 months ago

Entiendo. Pero tengo una pregunta para terminar de entender mejor. Actualmente está la funcionalidad de duplicar una corrida programada. Cuál sería la diferencia?

cerobpm commented 4 months ago

Poder backupearlas para recrearlas en otra instancia de la aplicación