diff --git a/v2/swagger.yaml b/v2/swagger.yaml index 05b9044..b494b12 100644 --- a/v2/swagger.yaml +++ b/v2/swagger.yaml @@ -2391,7 +2391,7 @@ components: description: > Entity ID: * `20` - User - * `118` - User postcard + * `118` - Postcard * `140` - Comment * `360` - Idea * `152` - Voting nominee @@ -2404,7 +2404,14 @@ components: - 152 example: 20 type_id: - description: USER_AVATAR - Change user profile photo
USER_CABINET - Change city, cabinet
USER_POSTCARD - Postcard
COMMENT - Comment
IDEA - Idea
VOTING_NOMINEE - Voting nominee photos + description: > + Moderation types: + * `USER_AVATAR` - Change user profile photo. Fields - photo_file_id, settings. + * `USER_CABINET` - Change city, cabinet. Fields - city, cabinet. + * `USER_POSTCARD` - Send postcard. Fields - text, user_id, postcard_id. + * `COMMENT` - Add comment. Fields - message, content_json. + * `IDEA` - Idea suggestion. Fields - idea_purpose_id, department_id, title, description, files. + * `VOTING_NOMINEE` - Image participating in the voting. Fields - file_id, nomination_id, title, description. type: string enum: - USER_AVATAR @@ -2452,9 +2459,24 @@ components: description: User cabinet field. type: string example: 1a + - properties: + text: + description: Postcard text. + type: string + example: Example text. + user_id: + description: User model ID. + type: string + format: uuid + example: 8768c19d-dae7-43f0-8b51-a86705f33a1b + postcard_id: + description: Postcard model ID. + type: string + format: uuid + example: e101d3be-ca63-49e0-9c94-a32fefc20c92 - properties: message: - description: Field "message" in Comment model. Comment text. + description: Field "message" in Comment model. type: string example: Comment text. content_json: @@ -2569,21 +2591,21 @@ components: type: string example: Photo description example. created_at: - description: Text + description: Moderation creation date. type: string format: date updated_at: - description: Text + description: Moderation update date. type: string format: date statusName: - description: Text + description: Status name. type: string typeName: - description: Text + description: Type name. type: string formatChanges: - description: (In OpenAPI 2, "oneOf" didn't exist) One of moderation types. Model fields that can be changed. Data formatted for use in view files. + description: Model fields that can be changed. Data formatted for use in view files. type: object oneOf: - properties: @@ -2607,7 +2629,8 @@ components: value: description: Field value. type: string - example: https://demo.hrbox.io/file/open/4b7477f9-5000-49f1-9ce1-02cb95c0cac6.jpg + format: uuid + example: 4b7477f9-5000-49f1-9ce1-02cb95c0cac6 url: type: string default: null @@ -2700,9 +2723,80 @@ components: example: 1a url: type: string + - properties: + text: + description: Postcard text. + type: object + properties: + type: + description: Field value type. + type: string + enum: + - string + - img + - files + - html + example: string + label: + description: Field label. + type: string + example: Postcard text + value: + description: Field value. + type: string + default: null + example: Example text. + url: + type: string + user_id: + description: User name. + type: object + properties: + type: + description: Field value type. + type: string + enum: + - string + - img + - files + - html + example: string + label: + description: Field label. + type: string + example: User + value: + description: Field value. + type: string + example: FirstName LastName + url: + type: string + postcard_id: + description: Postcard image. + type: object + properties: + type: + description: Field value type. + type: string + enum: + - string + - img + - files + - html + example: img + label: + description: Field label. + type: string + example: Postcard + value: + description: Field value. + type: string + example: https://demo.hrbox.io/file/open/d6f5be76-58fa-4b61-a248-74e10b2b5ed0.jpg + url: + type: string - properties: subject: - description: Text + description: Comment subject. type: object properties: type: @@ -2726,7 +2820,7 @@ components: type: string example: https://demo.hrbox.io/read/3379b1ac54/news-title message: - description: Text + description: Comment message. type: object properties: type: @@ -2749,7 +2843,7 @@ components: url: type: string content_json: - description: Text + description: Comment attached files. type: object properties: type: @@ -3047,33 +3141,33 @@ components: url: type: string referenceAttributes: - description: Text + description: Reference model attributes. type: object requestedUser: - description: Text + description: Requested user. type: object properties: id: - description: Text + description: Requested user ID. type: string format: uuid iconUrl: - description: Text + description: Requested user ID. type: string name: - description: Text + description: Requested user name. type: string moderatedUser: - description: Text + description: Moderated user. type: object properties: id: - description: Text + description: Moderated user ID. type: string format: uuid iconUrl: - description: Text + description: Moderated user ID. type: string name: - description: Text + description: Moderated user name. type: string \ No newline at end of file