Versions Compared

Old Version 4

changes.mady.by.user Filip Kuzmin

Saved on

compared with

New Version Current

changes.mady.by.user Filip Kuzmin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Призначення

Ендпоінт надає довідкову інформацію щодо того, з якої дати (і, за наявності, до якої дати)Організатор може встановити auctionPeriod.startDate для процедури з конкретним sellingMethod.

...

Необхідно реалізувати підтримку query-параметрів у GET /api/procedures/{sellingMethod}/auctionPeriod

Мета зміни

Розширити ендпоінт GET /api/procedures/{sellingMethod}/auctionPeriod, щоб він міг обчислювати min/max дати з урахуванням параметрів конкретного кейсу, переданих у query-string (наприклад: isPerishable, value.amount), а не лише базової validation.min/max.

...

conditions[] наразі не параметризовані і не залежать від введених даних користувача (бо немає механізму передати ці дані у запит)

Нова поведінка (to-be)

...

Ендпоінт має приймати query параметри, які будуть використані при визначенні релевантного condition.case та/або правил validation

...

Якщо sellingMethod не має conditions[] для auctionPeriod.startDate — query параметри не впливають (результат як зараз)

Правила вибору умов

...

Загальна логіка

  1. Система завантажує конфіг для {sellingMethod}

  2. Якщо в startDate є масив conditions[], система має:

    • пройтись по conditions[] у вказаному у відповіді порядку

    • знайти першу умову, у якої caseповністю  матчиться із параметрами якимось параметром запиту

    • застосувати її правила розрахунку дат

  3. Якщо жоден case не матчиться — використовується дефолтна логіка з startDate.validation (як зараз)

Робота з case

case — це набір умов над параметрами, переданими у query

Підтримувані типи перевірок:

  1. boolean equality
    isPerishable: true → очікує ?isPerishable=true

  2. numeric comparisons для чисел
    Наприклад:

    • value.amount > 250000000

    • value.amount >= 250000000

    • value.amount < 250000000

    • value.amount <= 250000000

Розширення формату конфігу

Boolean case (існує і зараз)

Code Block
languagejs
"conditions": [
	{
		"auto_set": true,
		"case": {
			"isPerishable": true
		},
		"diff": "2 business days",
		"direction": "forward",
		"from": "now",
		"time": "11:00 - 13:00"
	}
]

Numeric case для value.amount

Якщо матчиться кілька conditions - застосовується перший у масиві (тобто порядок у конфігу = пріоритет).

Це важливо, бо може бути комбінація:

GET /api/procedures/basicSell-english/auctionPeriod?value.amount=300000000.00&isPerishable=true


то в такому випадку застосується правило, яке перше в списку в specs.
Наприклад, конфіг такий:

Code Block
languagejs
"active_tendering": {
    "periods": {
      "procedure": {
        "auctionPeriod": {
          "startDate": {
            "conditions": [
              {
                "auto_set": true,
                "case": {
                  "isPerishable": true
                },
                "diff": "2 business days",
Code Block
languagejs
"conditions": [
	{
		"case": {
			"value.amount": {
				"gt": 250000000.00  //використовуємо оператори gt/gte/lt/lte
			}
		},
		"validation": {
			"min": {
				"diff": "30 days",
				"direction": "forward",
				                "error": "raise",
                "from": "now",
				                "time": "11:00 - 13:00"
              },
              {
                "case": {
                  "value.amount": { "gt": 250000000 }
                },
                "validation": {
                  "min": {
                    "diff": "30 days",
                    "direction": "forward",
                    "error": "raise",
                    "from": "now",
                    "time": "11:00",
                    "is_business_day": true
                  },
                  "max": {
                    "diff": "60 days",
                    "direction": "forward",
                    "error": "raise",
                    "from": "now",
                    "time": "13:00",
                    "is_business_day": true
                  }
                }
              }
            ],
            "time": "11:00 - 13:00",
            "validation": {
              "is_business_day": true,
              "min": {
                "diff": "8 days",
                "direction": "forward",
                "error": "raise",
                "from": "now",
                "time": "11:00"
              }
            }
          }
        }
      }
    }
  }

У прикладі

  • isPerishable=true метчиться з condition №1

  • value.amount=300000000.00 також метчиться з condition №2 (бо 300000000 > 250000000)

  • але оскільки умови перевіряються послідовно, застосовується перший condition, який матчиться.

Отже результат має бути розрахований за condition №1 (isPerishable), а не за “високою ціною”:

  • minDate = now + 2 business days, час = початок інтервалу 11:00

  • maxDate у цьому прикладі не повертається, бо condition №1 не задає validation.max, а визначає лише правило для найранішої дати (як у поточних спеках basicSell).

Робота з case

case — це набір умов над параметрами, переданими у query

Підтримувані типи перевірок:

  1. boolean equality
    isPerishable: true → очікує ?isPerishable=true

  2. numeric comparisons для чисел
    Наприклад:

    • value.amount > 250000000

    • value.amount >= 250000000

    • value.amount < 250000000

    • value.amount <= 250000000

Розширення формату конфігу

Boolean case (існує і зараз)

Code Block
languagejs
"conditions": [
	{
		"auto_set": true,
		"case": {
			"isPerishable": true
		},
		"diff": "2 business days",
		"direction": "forward",
		"from": "now",
		"time": "11:00 - 13:00"
	}
]

Numeric case для value.amount

Code Block
languagejs
"conditions": [
	{
		"case": {
			"value.amount": {
				"gt": 250000000.00  //використовуємо оператори gt/gte/lt/lte
			}
		},
		"validation": {
			"min": {
				"diff": "30 days",
				"direction": "forward",
				"from": "now",
				"time": "11:00"
			},
			"max": {
				"diff": "60 days",
				"direction": "forward",
				"from": "now",
				"time": "13:00"
			}
		}
	}
"
			},
			"max": {
				"diff": "60 days",
				"direction": "forward",
				"from": "now",
				"time": "13:00"
			}
		}
	}
]


conditions[] мають мати можливість:

...

  • перевизначати validation.min/max локально для цього кейсу

Тобто дозволити реалізмція має дозволти робити один із варіантів:

  • Варіант А: condition має власні поля diff/from/... і повертає тільки minDate (або min+max, якщо є).

  • Варіант Б: condition містить вкладений validation і повністю замінює дефолтний startDate.validation для обчислення min/max.

...

Code Block
titleПриклад спеки:
"auctionPeriod": {
  "startDate": {
    "conditions": [
      {
        "case": { "value.amount": { "gt": 250000000 } },
        "validation": {
          "min": { "diff": "30 days", "direction": "forward", "from": "now", "time": "11:00" },
          "max": { "diff": "60 days", "direction": "forward", "from": "now", "time": "13:00" }
        }
      },
      {
        "case": { "value.amount": { "lte": 250000000 } },
        "validation": {
          "min": { "diff": "20 days", "direction": "forward", "from": "now", "time": "11:00" },
          "max": { "diff": "35 days", "direction": "forward", "from": "now", "time": "13:00" }
        }
      }
    ],
    "time": "11:00 - 13:00",
    "validation": {
		"is_business_day": true,
		"min": {
			"diff": "20 days",
			"direction": "forward",
			"error": "raise",
			"from": "now",
			"time": "11:00"
		}
	}
  }
}

Формат query параметрів

Boolean

  • isPerishable=true|false (case-insensitive)

  • якщо параметр переданий не як boolean → 400

Числовий value.amount

  • value.amount — decimal

  • якщо не число → 400

Правила пріоритетів

  1. Якщо знайдено condition, який матчиться, і він містить власний validation — використати його

  2. Якщо condition матчиться і він задає пряме правило diff/from/time — розрахувати min/max на його основі

  3. Якщо condition не матчиться — використати дефолтний startDate.validation (поточна поведінка)

Якщо матчиться кілька conditions:

}
  }
}

Формат query параметрів

Boolean

  • isPerishable=true|false (case-insensitive)

  • якщо параметр переданий не як boolean → 400 помилка

Числовий value.amount

  • value.amount — decimal

  • якщо не число → 400 помилкавикористати перший у списку (тобто порядок у конфігу = пріоритет)

Відповідь ендпоінта (без змін)

...

Code Block
{
	"startDate": {
		"minDate": "...",
		"maxDate": "..."
	}
}

Помилки / валідації

Некоректні значення в query

...

параметрі - 400 Bad Request

Приклад причин:

  • isPerishable = abc

  • value.amount = not_a_number

Невідомий sellingMethod

  • як зараз - 422 Unprocessable Content

Непідтримуваний параметр

Lenient: невідомі параметри ігноруються (щоб не ламати майданчики)

...

  • якщо в конфігу є condition value.amount gt 250000000, тоді:

    • minDate = now + 30 days

    • maxDate = now + 60 days (або як задано)

  • якщо amount менший — інший condition або дефолтні правила


Інформаційні повідомлення

Ендпоінт повертає min max дату першого аукціону та tenderPeriod.duration для другого і наступних аукціонів в ланцюжку

https://procedure.prozorro.sale/api/jobber/announcements/jas/hints/announcement