Skip to content

Commit ff6228c

Browse files
committedMay 24, 2023
Перенесли условия заполнения полей резюме в OpenAPI
1 parent b7a1ad6 commit ff6228c

File tree

1 file changed

+2
-147
lines changed

1 file changed

+2
-147
lines changed
 

‎docs/resumes.md

+2-147
Original file line numberDiff line numberDiff line change
@@ -612,157 +612,12 @@ remaining | number | Количество доступных для созда
612612
<a name="conditions"></a>
613613
## Условия заполнения полей резюме
614614

615-
`GET /resumes/{resume_id}/conditions` — возвращает список требований для полей
616-
резюме.
617-
618-
Условия к резюме доступны только его автору, в противном случае вернётся код
619-
ответа `403 Forbidden`.
620-
621-
Если резюме недоступно — код ответа `404 Not Found`.
622-
623-
Если условия получены успешно — код ответа `200 OK`.
624-
625-
Пример:
626-
627-
```javascript
628-
{
629-
"last_name": {
630-
"required": true,
631-
"max_length": 100,
632-
"min_length": 1
633-
},
634-
"title": {
635-
"max_length": 100,
636-
"min_length": 2,
637-
"required": true,
638-
"not_in": [
639-
"Бухгалтер"
640-
]
641-
},
642-
"citizenship": {
643-
"required": true,
644-
"min_count": 1,
645-
"max_count": 3
646-
},
647-
"resume_locale": {
648-
"required": true
649-
},
650-
"education": {
651-
"required": true,
652-
"fields": {
653-
"level": {
654-
"required": true
655-
},
656-
"elementary": {
657-
"required": false,
658-
"min_count": 0,
659-
"max_count": 64,
660-
"fields": {
661-
"name": {
662-
"required": true,
663-
"min_length": 1,
664-
"max_length": 512
665-
},
666-
"year": {
667-
"required": true,
668-
"min_value": 1950,
669-
"max_value": 2023
670-
}
671-
}
672-
},
673-
"primary": {
674-
"required": true,
675-
"min_count": 1,
676-
"max_count": 64,
677-
"fields": {
678-
"result": {
679-
"required": false,
680-
"min_length": 1,
681-
"max_length": 128
682-
},
683-
"organization": {
684-
"required": true,
685-
"min_length": 1,
686-
"max_length": 128
687-
},
688-
"name": {
689-
"required": true,
690-
"min_length": 1,
691-
"max_length": 512
692-
},
693-
"year": {
694-
"required": true,
695-
"min_value": 1950,
696-
"max_value": 2023
697-
}
698-
},
699-
//...
700-
}
701-
}
702-
},
703-
"salary": {
704-
"required": false,
705-
"fields": {
706-
"currency": {
707-
"required": true,
708-
"min_length": 3,
709-
"max_length": 3
710-
},
711-
"amount": {
712-
"required": true,
713-
"min_value": 0,
714-
"max_value": null
715-
}
716-
}
717-
},
718-
"birth_date": {
719-
"required": false,
720-
"min_date": "1900-01-01",
721-
"max_date": "1999-10-21"
722-
},
723-
//...
724-
}
725-
```
726-
727-
Каждое конечное поле описано объектом правил. Если поле в резюме состоит из
728-
объекта с несколькими полями, эти поля описаны в `fields`.
729-
730-
Для всех полей и их частей указано, являются ли они необходимыми (`required`).
731-
Может быть так, что поле, представленное объектом с полями, само по себе не
732-
является необходимым, но если заполнено хотя бы одно поле объекта, необходимо
733-
заполнить и другие его поля. Пример — желаемая зарплата (`salary`) может быть не
734-
указана, либо указана, но обязательно с валютой.
735-
736-
<a name="condition-rules"></a>
737-
Правила
738-
-------
739-
740-
Имя | Тип | Описание
741-
--- | --- | ---
742-
required | логический | Поле резюме или поле объекта является необходимым. Для строковых значений поле не должно быть `null` или "".
743-
min_length | целое или `null` | Минимальная длина для текстовых полей. Рассчитывается для текста без символов `\r\n`. `null` – если количество не ограничено.
744-
max_length | целое или `null` | Максимальная длина для текстовых полей. Рассчитывается для текста без символов `\r\n`. `null` – если количество не ограничено.
745-
not_in | массив | Список недопустимых значений
746-
min_count | целое или `null` | Минимальное количество объектов, для полей, где необходимо передавать список. `null` – если нижняя граница не определена.
747-
max_count | целое или `null` | Максимально количество объектов, для полей, где необходимо передавать список. `null` – если верхняя граница не определена.
748-
min_value | целое или `null` | Нижняя граница диапазона числовых значений, включительно. `null` – если нижняя граница не определена.
749-
max_value | целое или `null` | Верхняя граница диапазона числовых значений, включительно. `null` – если верхняя граница не определена.
750-
min_date | строка с датой или `null` | Нижняя граница диапазона значений дат, включительно. `null` – если нижняя граница даты не определена.
751-
max_date | строка с датой или `null` | Верхняя граница диапазона значений дат, включительно. `null` – если верхняя граница даты не определена.
752-
regexp | строка или `null` | Регулярное выражение, которому должно соответствовать строковое поле. `null` – если ограничения отсутствуют.
753-
615+
> !! Данный метод доступен в [OpenAPI](https://api.hh.ru/openapi/redoc#tag/Rezyume.-Usloviya-zapolneniya-polej/operation/get-resume-conditions)
754616
755617
<a name="init-conditions"></a>
756618
## Условия заполнения полей нового резюме
757619

758-
`GET /resume_conditions` — возвращает список требований для полей нового резюме аналогичный [требованиям заполнения существующего резюме](#conditions).
759-
760-
### Ответ
761-
`200 OK` - условия заполнения полей получены успешно
762-
763-
### Ошибки
764-
`403 Forbidden` - авторизованный пользователь не соискатель
765-
620+
> !! Данный метод доступен в [OpenAPI](https://api.hh.ru/openapi/redoc#tag/Rezyume.-Usloviya-zapolneniya-polej/operation/get-new-resume-conditions)
766621
767622
<a name='conditions-contacts'></a>
768623
## Условия заполнения контактов в резюме

0 commit comments

Comments
 (0)
Please sign in to comment.