openapi: 3.0.3 info: title: LFX V2 - Survey Service description: Proxy service for ITX survey system version: "1.0" servers: - url: http://localhost:8080 paths: /surveys: post: tags: - survey summary: schedule_survey survey description: Create a scheduled survey for ITX project committee (proxies to ITX POST /surveys/schedule) operationId: survey#schedule_survey requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleSurveyRequestBody' example: committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 committee_voting_enabled: true creator_id: Quam esse saepe eum non omnis amet. creator_name: Consequatur quod numquam et provident dolorem voluptatem. creator_username: Numquam eum suscipit labore odio rerum. email_body: Repellendus sunt omnis voluptate minima possimus. email_body_text: Occaecati sunt odit quia quia fugiat est. email_subject: Quis vero voluptatem et temporibus. is_project_survey: true send_immediately: true stage_filter: Dolorem quia et in. survey_cutoff_date: Omnis sint reprehenderit. survey_monkey_id: Omnis est at omnis. survey_reminder_rate_days: 3291766316701683331 survey_send_date: Et nulla quia. survey_title: Dolorum cumque. responses: "201": description: Created response. content: application/json: schema: $ref: '#/components/schemas/SurveyScheduleResult' example: committee_category: Perferendis facilis minima. committee_voting_enabled: false committees: - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.6266969501277094 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 256525687450027157 total_responses: 8506409821911103766 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.6266969501277094 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 256525687450027157 total_responses: 8506409821911103766 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.6266969501277094 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 256525687450027157 total_responses: 8506409821911103766 created_at: "1997-02-08T02:16:04Z" creator_id: Aliquam quia. creator_name: Sed consequatur magnam sit cumque. creator_username: Quibusdam perferendis perferendis expedita molestiae asperiores autem. email_body: Ex facere adipisci voluptatibus sapiente quidem. email_body_text: Odio quam voluptatibus quod. email_subject: Deleniti alias dolor ut voluptatem. is_nps_survey: false is_project_survey: false last_modified_at: "1990-04-28T05:27:55Z" last_modified_by: Non eos occaecati eveniet ut est. latest_automated_reminder_sent_at: "1986-11-23T12:12:35Z" next_automated_reminder_at: "1990-01-15T20:28:07Z" nps_value: 0.8489560388638391 num_automated_reminders_sent: 2546153251221068036 num_automated_reminders_to_send: 1987383043001567865 num_detractors: 6722206839176231374 num_passives: 7797190939681643122 num_promoters: 8175617102193956655 response_status: scheduled send_immediately: false stage_filter: Mollitia necessitatibus incidunt. survey_cutoff_date: "2008-07-25T14:18:55Z" survey_monkey_id: Quas eveniet eaque dicta. survey_reminder_rate_days: 2793305353261564275 survey_send_date: "1983-04-29T16:58:00Z" survey_status: scheduled survey_title: Iure explicabo explicabo ut dolorem. survey_url: Et atque quaerat. total_bounced_emails: 5809701518566913218 total_recipients: 8249359941071894662 total_responses: 6838673830197443373 uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84 "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Reiciendis voluptas magni itaque. message: Ab magnam officia et. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Sit qui aut cupiditate illum eum. message: Voluptas quis qui quo. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Rem labore quisquam perspiciatis. message: Blanditiis sed unde incidunt. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Reiciendis quis dignissimos. message: Nostrum et. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Rerum ut quis incidunt. message: Eum explicabo error. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/{survey_uid}: delete: tags: - survey summary: delete_survey survey description: Delete survey (proxies to ITX DELETE /v2/surveys/{survey_uid}). Only allowed when status is 'disabled' operationId: survey#delete_survey parameters: - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Sed laborum similique. message: Sunt voluptatem deserunt fugiat dicta. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Et laudantium. message: Facilis impedit ea placeat maxime. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Fuga corrupti nesciunt. message: Id assumenda aliquid tenetur iste maxime. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Ut nisi cupiditate quam. message: Similique quibusdam voluptates quis. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Consequuntur eum. message: Rerum voluptatem. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Consectetur at est nemo. message: Excepturi enim molestias reiciendis ut. security: - jwt_header_Authorization: - manage:projects - manage:surveys get: tags: - survey summary: get_survey survey description: Get survey details (proxies to ITX GET /v2/surveys/{survey_uid}) operationId: survey#get_survey parameters: - name: project_uid in: query description: Optional LFX Project UID (V2) to filter survey data allowEmptyValue: true schema: type: string description: Optional LFX Project UID (V2) to filter survey data example: qa1e8536-a985-4cf5-b981-a170927a1d11 example: qa1e8536-a985-4cf5-b981-a170927a1d11 - name: project_uids in: query description: Optional comma-delimited list of LFX Project UIDs (V2). Should not be combined with project_uid allowEmptyValue: true schema: type: string description: Optional comma-delimited list of LFX Project UIDs (V2). Should not be combined with project_uid example: qa1e8536-a985-4cf5-b981-a170927a1d11,qa1e8536-a985-4cf5-b981-a170927a1d12 example: qa1e8536-a985-4cf5-b981-a170927a1d11,qa1e8536-a985-4cf5-b981-a170927a1d12 - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/SurveyScheduleResult' example: committee_category: Sed ut. committee_voting_enabled: false committees: - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.6266969501277094 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 256525687450027157 total_responses: 8506409821911103766 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.6266969501277094 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 256525687450027157 total_responses: 8506409821911103766 created_at: "1990-05-26T18:10:13Z" creator_id: Facilis est. creator_name: Laborum fuga dolores inventore sit est sed. creator_username: In autem provident blanditiis ab officiis ipsum. email_body: Quis mollitia ut minus. email_body_text: Sed ipsum nobis in aut similique. email_subject: Vitae unde. is_nps_survey: false is_project_survey: false last_modified_at: "1994-01-14T00:41:21Z" last_modified_by: Culpa consequatur aut. latest_automated_reminder_sent_at: "1979-03-13T23:58:59Z" next_automated_reminder_at: "1983-11-22T04:37:25Z" nps_value: 0.6379567056920531 num_automated_reminders_sent: 5955312177100105707 num_automated_reminders_to_send: 1501073311041553136 num_detractors: 2100042836277055694 num_passives: 4696138859968207767 num_promoters: 8946836443250022414 response_status: scheduled send_immediately: false stage_filter: Ab mollitia possimus et eum vero omnis. survey_cutoff_date: "1991-03-10T03:13:24Z" survey_monkey_id: Perspiciatis iste aut sit fugit. survey_reminder_rate_days: 8773992317131132630 survey_send_date: "1992-05-28T13:28:36Z" survey_status: scheduled survey_title: Quis distinctio quae. survey_url: Aliquam in aut laborum quod esse qui. total_bounced_emails: 7455921900934456301 total_recipients: 5590032177824588820 total_responses: 2896297817607758689 uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84 "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Consequuntur inventore vel vel. message: Inventore quis voluptas dolore qui. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Saepe sed temporibus et est. message: Maiores dolorem aut odit dolorem repudiandae est. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Hic dolorem atque alias possimus eum qui. message: Molestiae quaerat voluptas. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Et dolorem reprehenderit. message: Ut suscipit assumenda. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Inventore a fuga ut aut nostrum. message: Cumque architecto laboriosam minus. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Voluptatem nihil. message: Quisquam quas veniam sequi ea quia. security: - jwt_header_Authorization: - manage:projects - manage:surveys put: tags: - survey summary: update_survey survey description: Update survey (proxies to ITX PUT /v2/surveys/{survey_uid}). Only allowed when status is 'disabled' operationId: survey#update_survey parameters: - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSurveyRequestBody' example: committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 committee_voting_enabled: true creator_id: Qui distinctio dolorum quia non quaerat nostrum. email_body: Veniam consequuntur sed praesentium. email_body_text: Similique et sapiente sunt sit. email_subject: Quo omnis maiores impedit. survey_cutoff_date: Consequatur rem et voluptatem et. survey_reminder_rate_days: 464515454408226755 survey_send_date: Sed in perspiciatis odit nesciunt. survey_title: Ut dicta eum ut vero animi. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/SurveyScheduleResult' example: committee_category: Veritatis nisi quasi totam nostrum. committee_voting_enabled: true committees: - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.6266969501277094 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 256525687450027157 total_responses: 8506409821911103766 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.6266969501277094 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 256525687450027157 total_responses: 8506409821911103766 created_at: "2012-11-29T16:25:11Z" creator_id: Eos autem aut cum nesciunt. creator_name: Dolores corporis debitis harum earum autem et. creator_username: Modi excepturi et quas. email_body: Vero impedit doloribus saepe. email_body_text: Perspiciatis saepe culpa in dolores quam. email_subject: Error quisquam qui veritatis temporibus sit illum. is_nps_survey: false is_project_survey: true last_modified_at: "2000-06-29T14:09:13Z" last_modified_by: Possimus iure sint et sunt amet aut. latest_automated_reminder_sent_at: "1999-02-24T22:35:21Z" next_automated_reminder_at: "2007-11-22T23:43:56Z" nps_value: 0.23141298976984814 num_automated_reminders_sent: 8337289837672265763 num_automated_reminders_to_send: 8107375938073788662 num_detractors: 8419714383430859074 num_passives: 3773156406319571058 num_promoters: 7275587620146515160 response_status: scheduled send_immediately: false stage_filter: Sit id modi corporis. survey_cutoff_date: "1981-11-20T11:20:01Z" survey_monkey_id: Sed eligendi quo qui sint doloremque. survey_reminder_rate_days: 3045289415844103173 survey_send_date: "1976-11-13T06:51:25Z" survey_status: scheduled survey_title: Quo tempore porro. survey_url: Reprehenderit qui. total_bounced_emails: 920116411734754744 total_recipients: 7053772202910532748 total_responses: 3641612096555752497 uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84 "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Voluptas sit ea. message: Est earum voluptatem eos corporis. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Sit veniam. message: Facere perferendis. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Et eveniet reprehenderit. message: Inventore rerum quisquam in dolorem. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Repudiandae distinctio consequuntur nam maiores omnis perspiciatis. message: Et et illum et. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Laboriosam excepturi perferendis maiores ullam est. message: Qui alias beatae libero totam. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Est aut. message: Placeat error dolore molestiae. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/{survey_uid}/bulk_resend: post: tags: - survey summary: bulk_resend_survey survey description: Bulk resend survey emails to select recipients (proxies to ITX POST /v2/surveys/{survey_uid}/bulk_resend) operationId: survey#bulk_resend_survey parameters: - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkResendSurveyRequestBody' example: recipient_ids: - cba14f40-1636-11ec-9621-0242ac130002 - cba14f40-1636-11ec-9621-0242ac130003 responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Quo porro et quam molestias excepturi. message: Fuga voluptatem aperiam ut delectus veritatis. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Quasi molestias fugiat laudantium. message: Et voluptatem est. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Quia necessitatibus maxime aperiam voluptatum et. message: Delectus totam et quaerat. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Laudantium rerum inventore sed quis. message: Mollitia explicabo inventore est dolorum omnis et. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Velit velit a officiis voluptas porro. message: Quas in illum qui at hic necessitatibus. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Non ut. message: Aut delectus. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/{survey_uid}/preview_send: get: tags: - survey summary: preview_send_survey survey description: Preview which recipients, committees, and projects would be affected by a resend (proxies to ITX GET /v2/surveys/{survey_uid}/preview_send) operationId: survey#preview_send_survey parameters: - name: committee_uid in: query description: Optional committee UID to filter preview allowEmptyValue: true schema: type: string description: Optional committee UID to filter preview example: qa1e8536-a985-4cf5-b981-a170927a1d11 example: qa1e8536-a985-4cf5-b981-a170927a1d11 - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/PreviewSendResult' example: affected_committees: - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 affected_projects: - id: 003170000123XHTAA2 logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut. name: Express JS slug: express-gateway status: Active - id: 003170000123XHTAA2 logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut. name: Express JS slug: express-gateway status: Active - id: 003170000123XHTAA2 logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut. name: Express JS slug: express-gateway status: Active - id: 003170000123XHTAA2 logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut. name: Express JS slug: express-gateway status: Active affected_recipients: - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Quod illum. message: Aliquam harum. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Dolores maxime accusantium perferendis itaque omnis provident. message: Officiis hic quis. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Enim omnis ad. message: Voluptas repellat hic atque aut. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Beatae omnis explicabo sunt qui dolores laborum. message: Vero quia corporis ut. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Aut id mollitia voluptas aut maiores. message: Libero dolore non quos est autem. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Explicabo eius voluptates in asperiores ducimus aut. message: Adipisci consequatur sapiente at. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/{survey_uid}/recipient_group: delete: tags: - survey summary: delete_recipient_group survey description: Remove a recipient group (committee, project, or foundation) from survey and recalculate statistics (proxies to ITX DELETE /v2/surveys/{survey_uid}/recipient_group) operationId: survey#delete_recipient_group parameters: - name: committee_uid in: query description: Committee UID to remove (indicates specific committee in project) allowEmptyValue: true schema: type: string description: Committee UID to remove (indicates specific committee in project) example: qa1e8536-a985-4cf5-b981-a170927a1d11 example: qa1e8536-a985-4cf5-b981-a170927a1d11 - name: project_uid in: query description: Project UID to remove (all removals are attached to a project) allowEmptyValue: true schema: type: string description: Project UID to remove (all removals are attached to a project) example: 003170000123XHTAA2 example: 003170000123XHTAA2 - name: foundation_id in: query description: Foundation ID (indicates project_uid references a foundation and all subprojects should be removed) allowEmptyValue: true schema: type: string description: Foundation ID (indicates project_uid references a foundation and all subprojects should be removed) example: 003170000123XHTAA2 example: 003170000123XHTAA2 - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Iusto voluptates est recusandae. message: Corrupti eos repudiandae. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Deserunt ex et esse aut quo corporis. message: Animi laboriosam. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Illum aspernatur animi maxime est et. message: Eius ratione nisi facere. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Enim placeat harum voluptatem. message: Sed voluptatibus doloribus optio in sit reprehenderit. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Iusto autem. message: Qui sequi repudiandae est alias nisi doloremque. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: In cum ipsa aliquam. message: Nisi qui repudiandae omnis molestiae assumenda. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/{survey_uid}/responses/{response_id}: delete: tags: - survey summary: delete_survey_response survey description: Delete survey response - removes recipient from survey and recalculates statistics (proxies to ITX DELETE /v2/surveys/{survey_uid}/responses/{response_id}) operationId: survey#delete_survey_response parameters: - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 - name: response_id in: path description: Response identifier required: true schema: type: string description: Response identifier example: cba14f40-1636-11ec-9621-0242ac130002 example: cba14f40-1636-11ec-9621-0242ac130002 responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Consectetur modi quisquam non a omnis. message: Incidunt veritatis molestiae molestiae temporibus rerum. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Laborum impedit sed minima molestiae. message: Non quisquam ea earum. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Non ea necessitatibus ut. message: Possimus et aut repudiandae beatae autem repellendus. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Rerum dolores enim distinctio rerum eius earum. message: Assumenda enim culpa. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Reiciendis facilis sunt. message: Eum possimus laudantium aut pariatur qui provident. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Eligendi quasi doloremque quidem. message: Est ducimus ut omnis et. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/{survey_uid}/responses/{response_id}/resend: post: tags: - survey summary: resend_survey_response survey description: Resend survey email to a specific user (proxies to ITX POST /v2/surveys/{survey_uid}/responses/{response_id}/resend) operationId: survey#resend_survey_response parameters: - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 - name: response_id in: path description: Response identifier required: true schema: type: string description: Response identifier example: cba14f40-1636-11ec-9621-0242ac130002 example: cba14f40-1636-11ec-9621-0242ac130002 responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Aliquam nobis. message: Maiores id. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Qui fugit laboriosam. message: Error qui maiores. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Officiis cum voluptatem error eum. message: Error provident quo hic asperiores sint. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Aut eveniet harum quo aut. message: Ut maiores. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Id vel incidunt architecto inventore. message: At reiciendis non consequuntur. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Vel quia quisquam inventore sit. message: Est ad doloribus omnis sit. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/{survey_uid}/send_missing_recipients: post: tags: - survey summary: send_missing_recipients survey description: Send survey emails to committee members who haven't received it (proxies to ITX POST /v2/surveys/{survey_uid}/send_missing_recipients) operationId: survey#send_missing_recipients parameters: - name: committee_uid in: query description: Optional committee UID to resync only that committee allowEmptyValue: true schema: type: string description: Optional committee UID to resync only that committee example: qa1e8536-a985-4cf5-b981-a170927a1d11 example: qa1e8536-a985-4cf5-b981-a170927a1d11 - name: survey_uid in: path description: Survey identifier required: true schema: type: string description: Survey identifier example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309 responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Accusamus tempore nemo nulla. message: Et quasi nam eveniet omnis aspernatur doloremque. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Suscipit occaecati perferendis nostrum. message: Quam repellendus. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Temporibus nostrum qui labore. message: Necessitatibus facere enim natus. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Laborum doloribus maxime ullam voluptatum pariatur iure. message: Expedita ut. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Nesciunt vel voluptatem cupiditate consectetur. message: Ut provident sed in qui. "503": description: 'ServiceUnavailable: Service unavailable' content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' example: code: Nostrum voluptatem. message: At omnis. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/exclusion: delete: tags: - survey summary: delete_exclusion survey description: Delete a survey or global exclusion (proxies to ITX DELETE /v2/surveys/exclusion) operationId: survey#delete_exclusion requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateExclusionRequestBody' example: committee_uid: Asperiores at dicta iusto adipisci est est. email: Repellendus modi illo voluptatem ab possimus. global_exclusion: Soluta facilis rerum exercitationem. survey_uid: Incidunt libero quo voluptates accusamus omnis saepe. user_id: Dolorem voluptatum ab accusantium magni nesciunt deleniti. responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Ut iusto eius qui. message: Recusandae itaque consequatur. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Et mollitia aut provident sint voluptas. message: Sed similique blanditiis. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Tenetur sit facere ab. message: Veniam maiores distinctio temporibus facilis. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Velit quae dolor dolorem. message: Quo et eveniet repudiandae. security: - jwt_header_Authorization: - manage:projects - manage:surveys post: tags: - survey summary: create_exclusion survey description: Create a survey or global exclusion (proxies to ITX POST /v2/surveys/exclusion) operationId: survey#create_exclusion requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateExclusionRequestBody' example: committee_uid: Tenetur omnis. email: Vel ipsam laborum quos provident ad. global_exclusion: Amet deleniti aut. survey_uid: Nihil eos molestiae numquam. user_id: Id minima id. responses: "201": description: Created response. content: application/json: schema: $ref: '#/components/schemas/ExclusionResult' example: committee_uid: Laudantium aut consectetur pariatur omnis. email: test@email.com global_exclusion: Rerum natus placeat explicabo ut. survey_uid: Blanditiis harum quis debitis voluptatem laborum. uid: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e user_id: Non eveniet esse consequatur omnis. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Distinctio impedit cumque. message: Sit numquam et reprehenderit blanditiis animi aut. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Quos consequatur voluptatum eius. message: Voluptatem ipsa quisquam vel velit. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Unde dolor veniam ut laborum quo eos. message: Magni optio. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Dolorum excepturi. message: Dolores temporibus odio cupiditate quam. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/exclusion/{exclusion_id}: delete: tags: - survey summary: delete_exclusion_by_id survey description: Delete exclusion by ID (proxies to ITX DELETE /v2/surveys/exclusion/{exclusion_id}) operationId: survey#delete_exclusion_by_id parameters: - name: exclusion_id in: path description: Exclusion identifier required: true schema: type: string description: Exclusion identifier example: "12345" example: "12345" responses: "204": description: No Content response. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Ut at ex quo. message: Et aliquid et id perspiciatis. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Excepturi tempore unde porro cum ipsum. message: Est saepe numquam eum laudantium doloremque eum. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Id earum quod eum delectus autem et. message: Ad aut odio vero et. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Et aut et eum iste veritatis. message: Quisquam ipsam. security: - jwt_header_Authorization: - manage:projects - manage:surveys get: tags: - survey summary: get_exclusion survey description: Get exclusion by ID (proxies to ITX GET /v2/surveys/exclusion/{exclusion_id}) operationId: survey#get_exclusion parameters: - name: exclusion_id in: path description: Exclusion identifier required: true schema: type: string description: Exclusion identifier example: "12345" example: "12345" responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/ExtendedExclusionResult' example: committee_uid: Quod pariatur. email: test@email.com global_exclusion: Aut autem omnis. survey_uid: Doloremque quia occaecati sunt hic quis. uid: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e user: emails: - email_address: Excepturi totam et qui vel. id: Officiis officiis quasi possimus aut eum eum. is_primary: false - email_address: Excepturi totam et qui vel. id: Officiis officiis quasi possimus aut eum eum. is_primary: false - email_address: Excepturi totam et qui vel. id: Officiis officiis quasi possimus aut eum eum. is_primary: false id: Rerum autem molestias necessitatibus dolores fuga. username: Ab vitae qui ad tenetur vitae. user_id: Distinctio id nihil dolores laboriosam. "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Harum error quis ea quos dicta odio. message: Reprehenderit et iure architecto numquam rerum. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Quis quis quos. message: Commodi soluta tempora molestiae error. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Veniam assumenda et odit veritatis. message: Quis enim. "404": description: 'NotFound: Not found' content: application/json: schema: $ref: '#/components/schemas/NotFoundError' example: code: Molestiae dolores laboriosam enim. message: Dolores debitis expedita quam. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Veniam aut molestiae. message: Enim ducimus corrupti. security: - jwt_header_Authorization: - manage:projects - manage:surveys /surveys/validate_email: post: tags: - survey summary: validate_email survey description: Validate email template body and subject (proxies to ITX POST /v2/surveys/validate_email) operationId: survey#validate_email requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValidateEmailRequestBody' example: body: Vero in. subject: Ratione ut consequatur ullam. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/ValidateEmailResult' example: body: An example survey body with the quarter Q1 subject: An example survey subject with the year 2023 "400": description: 'BadRequest: Bad request' content: application/json: schema: $ref: '#/components/schemas/BadRequestError' example: code: Voluptatem maiores sunt quaerat praesentium reprehenderit eos. message: Consequuntur veniam. "401": description: 'Unauthorized: Unauthorized' content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: code: Quos minima odio. message: Necessitatibus molestias aperiam ea illum delectus optio. "403": description: 'Forbidden: Forbidden' content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: code: Quod porro dignissimos qui sint quod. message: Sed in omnis ipsa fugit iusto. "500": description: 'InternalServerError: Internal server error' content: application/json: schema: $ref: '#/components/schemas/InternalServerError' example: code: Facilis sint. message: Quo qui est maxime ut itaque. security: - jwt_header_Authorization: - manage:projects - manage:surveys components: schemas: BadRequestError: type: object properties: code: type: string description: HTTP status code example: Explicabo omnis sunt maiores blanditiis dolores. message: type: string description: Error message example: Ut inventore consequuntur culpa vitae. description: Bad request error response example: code: Est sunt dolor enim autem provident. message: Expedita ipsum. required: - code - message BulkResendSurveyRequestBody: type: object properties: recipient_ids: type: array items: type: string example: Voluptas qui fuga ut ut maiores. description: Array of recipient IDs to resend survey emails to example: - cba14f40-1636-11ec-9621-0242ac130002 - cba14f40-1636-11ec-9621-0242ac130003 example: recipient_ids: - cba14f40-1636-11ec-9621-0242ac130002 - cba14f40-1636-11ec-9621-0242ac130003 required: - recipient_ids ConflictError: type: object properties: code: type: string description: HTTP status code example: Ad ipsa et cumque in inventore a. message: type: string description: Error message example: Molestiae repellendus sed. description: Conflict error response example: code: Iste est eaque aliquid sunt. message: Nihil sunt. required: - code - message CreateExclusionRequestBody: type: object properties: committee_uid: type: string description: Committee UID for survey-specific exclusion example: Voluptates aut cupiditate dolorum dolorem voluptatem. email: type: string description: Survey responder's email example: Ducimus qui ad qui. global_exclusion: type: string description: Global exclusion flag example: Et eligendi provident. survey_uid: type: string description: Survey UID for survey-specific exclusion example: Veritatis numquam vel et enim repudiandae. user_id: type: string description: Recipient's user ID example: Dolor fuga temporibus sed. example: committee_uid: Ullam rem amet minus cupiditate quam in. email: Aut sunt ut. global_exclusion: Sed incidunt rerum labore. survey_uid: Qui dolorum quia voluptatem in beatae omnis. user_id: Laborum id aut reprehenderit veniam sit ut. ExcludedCommittee: type: object properties: committee_category: type: string description: Committee category example: Technical Steering Committee enum: - Legal Committee - Finance Committee - Special Interest Group - Board - Technical Oversight Committee/Technical Advisory Committee - Technical Steering Committee committee_name: type: string description: Committee name example: Technical Steering Committee committee_uid: type: string description: Committee UID example: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: type: string description: Project name example: Kubernetes project_uid: type: string description: Project UID example: 003170000123XHTAA2 description: Committee information for preview send example: committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 required: - project_uid - project_name - committee_uid - committee_name - committee_category ExclusionResult: type: object properties: committee_uid: type: string description: Committee UID example: Delectus saepe. email: type: string description: Survey responder's email example: test@email.com global_exclusion: type: string description: Global exclusion flag example: Consequuntur consequuntur pariatur. survey_uid: type: string description: Survey UID example: Suscipit harum sequi ipsum vitae quia dolore. uid: type: string description: Exclusion unique identifier example: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e user_id: type: string description: Recipient's user ID example: Quo totam fuga maxime eveniet velit sed. description: A survey or global exclusion example: committee_uid: Soluta illo iure reprehenderit culpa. email: test@email.com global_exclusion: Nihil iste in. survey_uid: Et fugiat et. uid: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e user_id: Qui totam esse unde cupiditate laboriosam. required: - uid ExclusionUser: type: object properties: emails: type: array items: $ref: '#/components/schemas/UserEmail' description: User emails example: - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true id: type: string description: User ID example: Cumque similique. username: type: string description: Username example: Rerum nesciunt fugiat. description: User information for an exclusion example: emails: - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true id: At ipsam deleniti. username: Quis aut voluptates deserunt laborum. ExtendedExclusionResult: type: object properties: committee_uid: type: string description: Committee UID example: Ab numquam. email: type: string description: Survey responder's email example: test@email.com global_exclusion: type: string description: Global exclusion flag example: Illum debitis. survey_uid: type: string description: Survey UID example: Labore similique dolore quod consectetur qui. uid: type: string description: Exclusion unique identifier example: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e user: $ref: '#/components/schemas/ExclusionUser' user_id: type: string description: Recipient's user ID example: Eum pariatur laborum consectetur. description: A survey or global exclusion with user information example: committee_uid: Sit error delectus quos. email: test@email.com global_exclusion: Et sed velit qui. survey_uid: Assumenda accusantium nulla aperiam sit et doloribus. uid: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e user: emails: - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true - email_address: Saepe voluptas. id: Laboriosam ipsam explicabo et consequuntur accusantium. is_primary: true id: Cum reiciendis ad expedita iusto sunt ab. username: Voluptatum porro ut quo occaecati. user_id: Quos quis sint incidunt qui est harum. required: - uid ForbiddenError: type: object properties: code: type: string description: HTTP status code example: Unde quibusdam ex. message: type: string description: Error message example: Dolor cupiditate incidunt nesciunt voluptas a. description: Forbidden error response example: code: Eius repellat est. message: Inventore recusandae ab qui voluptate. required: - code - message ITXPreviewRecipient: type: object properties: email: type: string description: Email address example: john.doe@example.com format: email first_name: type: string description: User first name example: John last_name: type: string description: User last name example: Doe name: type: string description: User full name example: John Doe role: type: string description: Role in committee example: Voting Rep enum: - Chair - Voting Rep - Member user_id: type: string description: LF user ID example: 005f1000009RbC4AAK username: type: string description: Linux Foundation ID example: jdoe description: Recipient information for preview send example: email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe required: - user_id - email InternalServerError: type: object properties: code: type: string description: HTTP status code example: Nemo odit. message: type: string description: Error message example: Impedit veniam voluptatem laboriosam voluptatem. description: Internal server error response example: code: Reprehenderit et et. message: Consequatur voluptas eos qui dolore rerum. required: - code - message LFXProject: type: object properties: id: type: string description: Project ID example: 003170000123XHTAA2 logo_url: type: string description: Project logo URL example: Incidunt et. name: type: string description: Project name example: Express JS slug: type: string description: Project slug example: express-gateway status: type: string description: Project status/stage example: Active enum: - Formation - Exploratory - Formation - Engaged - Active - Archived - Formation - On Hold - Formation - Disengaged - Formation - Confidential - Prospect description: LFX Project information example: id: 003170000123XHTAA2 logo_url: Reiciendis sit maiores magnam deserunt et perspiciatis. name: Express JS slug: express-gateway status: Active required: - id - name - slug - status NotFoundError: type: object properties: code: type: string description: HTTP status code example: Iste velit perspiciatis animi reprehenderit. message: type: string description: Error message example: Qui autem et ea. description: Not found error response example: code: Culpa illum. message: Voluptatem dolor quasi sed sed nostrum. required: - code - message PreviewSendResult: type: object properties: affected_committees: type: array items: $ref: '#/components/schemas/ExcludedCommittee' description: List of affected committees example: - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 affected_projects: type: array items: $ref: '#/components/schemas/LFXProject' description: List of affected projects example: - id: 003170000123XHTAA2 logo_url: Quisquam ipsum eum mollitia ea magni. name: Express JS slug: express-gateway status: Active - id: 003170000123XHTAA2 logo_url: Quisquam ipsum eum mollitia ea magni. name: Express JS slug: express-gateway status: Active - id: 003170000123XHTAA2 logo_url: Quisquam ipsum eum mollitia ea magni. name: Express JS slug: express-gateway status: Active - id: 003170000123XHTAA2 logo_url: Quisquam ipsum eum mollitia ea magni. name: Express JS slug: express-gateway status: Active affected_recipients: type: array items: $ref: '#/components/schemas/ITXPreviewRecipient' description: List of affected recipients example: - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe description: Preview of recipients, committees, and projects affected by a resend example: affected_committees: - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 - committee_category: Technical Steering Committee committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 project_name: Kubernetes project_uid: 003170000123XHTAA2 affected_projects: - id: 003170000123XHTAA2 logo_url: Quisquam ipsum eum mollitia ea magni. name: Express JS slug: express-gateway status: Active - id: 003170000123XHTAA2 logo_url: Quisquam ipsum eum mollitia ea magni. name: Express JS slug: express-gateway status: Active affected_recipients: - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe - email: john.doe@example.com first_name: John last_name: Doe name: John Doe role: Voting Rep user_id: 005f1000009RbC4AAK username: jdoe ScheduleSurveyRequestBody: type: object properties: committee_uid: type: string description: Committee UID to send survey to example: qa1e8536-a985-4cf5-b981-a170927a1d11 committee_voting_enabled: type: boolean description: Whether committee voting is enabled example: false creator_id: type: string description: Creator's user ID example: Non et. creator_name: type: string description: Creator's full name example: Quia a ut molestias qui. creator_username: type: string description: Creator's username example: Aliquid est sit laborum sit quia. email_body: type: string description: Email body HTML content example: Saepe doloribus recusandae. email_body_text: type: string description: Email body plain text content example: Ex id voluptas. email_subject: type: string description: Email subject line example: Excepturi qui ut architecto. is_project_survey: type: boolean description: Whether the survey is project-level (true) or global-level (false) example: true send_immediately: type: boolean description: Send immediately (true) or schedule for later (false) example: true stage_filter: type: string description: Project stage filter for global surveys example: Sunt ex. survey_cutoff_date: type: string description: Survey cutoff/end date (RFC3339 format) example: Quidem rerum quae. survey_monkey_id: type: string description: SurveyMonkey survey ID example: Voluptas exercitationem. survey_reminder_rate_days: type: integer description: Days between automatic reminder emails (0 = no reminders) example: 7328611094451502257 format: int64 survey_send_date: type: string description: Date to send the survey (RFC3339 format) example: Explicabo ullam alias quisquam et sed quis. survey_title: type: string description: Survey title example: Et aut blanditiis qui libero et tempore. example: committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 committee_voting_enabled: false creator_id: Corrupti voluptas qui est suscipit nihil aliquid. creator_name: Ipsa velit rem totam. creator_username: Officiis voluptatem. email_body: Nemo neque natus deleniti assumenda et. email_body_text: Molestiae temporibus. email_subject: Libero reprehenderit dicta repellat beatae. is_project_survey: false send_immediately: true stage_filter: Esse explicabo et deleniti. survey_cutoff_date: Numquam in facilis. survey_monkey_id: Excepturi qui perspiciatis blanditiis voluptas totam aut. survey_reminder_rate_days: 4814888659035368650 survey_send_date: Provident eligendi praesentium voluptatem reiciendis suscipit molestiae. survey_title: Est reiciendis nulla sed voluptatem quam consequatur. required: - committee_uid ServiceUnavailableError: type: object properties: code: type: string description: HTTP status code example: Animi ab sapiente. message: type: string description: Error message example: Ut id consequuntur sit aut aspernatur. description: Service unavailable error response example: code: Quasi est fugiat placeat enim. message: Perferendis aliquid reprehenderit sit possimus magnam omnis. required: - code - message SurveyCommittee: type: object properties: committee_name: type: string description: Committee name example: Technical Steering Committee committee_uid: type: string description: Committee UID example: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: type: number description: NPS value for this committee example: 0.3474379275416848 format: double project_name: type: string description: Project name example: Kubernetes project_uid: type: string description: Project UID example: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: type: string description: Survey URL for this committee example: https://surveymonkey.com/r/abc123 total_recipients: type: integer description: Total recipients for this committee example: 3141893145609172741 format: int64 total_responses: type: integer description: Total responses for this committee example: 2728308064949776656 format: int64 description: Survey committee details example: committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.21872305851724838 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 8693291114078661955 total_responses: 8056228715476607245 SurveySchedulePayload: type: object properties: committee_voting_enabled: type: boolean description: Whether committee voting is enabled default: false example: true committees: type: array items: type: string example: Modi a provident ex ad exercitationem beatae. description: Array of committee IDs to send survey to example: - com-123 - com-456 creator_id: type: string description: Creator's user ID example: john-doe-id creator_name: type: string description: Creator's full name example: John Doe creator_username: type: string description: Creator's username example: john23 email_body: type: string description: Email body HTML content example:

Hi there

Please take our survey

email_body_text: type: string description: Email body plain text content example: 'Hi there! Please take our survey at: https://surveymonkey.com/...' email_subject: type: string description: Email subject line example: 'You''re invited: Q1 2026 Developer Survey' maxLength: 200 is_project_survey: type: boolean description: Whether the survey is project-level (true) or global-level (false) default: false example: false send_immediately: type: boolean description: Send immediately (true) or schedule for later (false) default: false example: false stage_filter: type: string description: Project stage filter for global surveys example: Formation - Engaged survey_cutoff_date: type: string description: Survey cutoff/end date (RFC3339 format) example: "2026-03-15T09:00:00Z" format: date-time survey_monkey_id: type: string description: SurveyMonkey survey ID example: "123456789" survey_reminder_rate_days: type: integer description: Days between automatic reminder emails (0 = no reminders) example: 7 format: int64 minimum: 0 survey_send_date: type: string description: Date to send the survey (RFC3339 format) example: "2026-02-15T09:00:00Z" format: date-time survey_title: type: string description: Survey title example: Q1 2026 Developer Satisfaction Survey maxLength: 255 description: Payload for scheduling a survey example: committee_voting_enabled: true committees: - com-123 - com-456 creator_id: john-doe-id creator_name: John Doe creator_username: john23 email_body:

Hi there

Please take our survey

email_body_text: 'Hi there! Please take our survey at: https://surveymonkey.com/...' email_subject: 'You''re invited: Q1 2026 Developer Survey' is_project_survey: false send_immediately: false stage_filter: Formation - Engaged survey_cutoff_date: "2026-03-15T09:00:00Z" survey_monkey_id: "123456789" survey_reminder_rate_days: 7 survey_send_date: "2026-02-15T09:00:00Z" survey_title: Q1 2026 Developer Satisfaction Survey SurveyScheduleResult: type: object properties: committee_category: type: string description: Committee category example: Rem rem earum nihil. committee_voting_enabled: type: boolean description: Committee voting enabled example: false committees: type: array items: $ref: '#/components/schemas/SurveyCommittee' description: Survey committees example: - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 created_at: type: string description: Creation timestamp example: "2004-05-27T21:17:31Z" format: date-time creator_id: type: string description: Creator's user ID example: Fugiat quis dolores sint perspiciatis eos earum. creator_name: type: string description: Creator's full name example: Omnis nam et. creator_username: type: string description: Creator's username example: Ipsam assumenda quam rerum. email_body: type: string description: Email body HTML example: Harum quaerat sequi perspiciatis omnis provident. email_body_text: type: string description: Email body plain text example: Quibusdam sapiente. email_subject: type: string description: Email subject line example: Voluptatem tempora id et. is_nps_survey: type: boolean description: Whether this is an NPS survey example: false is_project_survey: type: boolean description: Whether project-level or global-level survey example: false last_modified_at: type: string description: Last modification timestamp example: "1983-10-27T13:38:12Z" format: date-time last_modified_by: type: string description: User ID of last modifier example: Adipisci et quibusdam et voluptatem provident. latest_automated_reminder_sent_at: type: string description: Latest automated reminder sent date example: "1983-06-06T00:53:44Z" format: date-time next_automated_reminder_at: type: string description: Next automated reminder date example: "2002-03-15T16:21:47Z" format: date-time nps_value: type: number description: NPS value example: 0.8519164409906 format: double num_automated_reminders_sent: type: integer description: Number of automated reminders sent example: 1972904916392206914 format: int64 num_automated_reminders_to_send: type: integer description: Number of automated reminders to send example: 4001396657159876410 format: int64 num_detractors: type: integer description: Number of detractors example: 3576976694752166473 format: int64 num_passives: type: integer description: Number of passives example: 3639497964781799593 format: int64 num_promoters: type: integer description: Number of promoters example: 6776505088433966539 format: int64 response_status: type: string description: Response status example: scheduled enum: - scheduled - open - closed send_immediately: type: boolean description: Whether survey is sent immediately example: false stage_filter: type: string description: Project stage filter example: Est quos id voluptates odit velit. survey_cutoff_date: type: string description: Survey cutoff date example: "2013-05-30T01:48:04Z" format: date-time survey_monkey_id: type: string description: SurveyMonkey survey ID example: Repudiandae vel. survey_reminder_rate_days: type: integer description: Days between reminder emails example: 1268332027555056005 format: int64 survey_send_date: type: string description: Survey send date example: "2003-03-21T17:17:44Z" format: date-time survey_status: type: string description: Survey status example: scheduled enum: - scheduled - sending - sent - cancelled survey_title: type: string description: Survey title example: Voluptatem ullam nemo libero eos et. survey_url: type: string description: Survey URL example: Sit earum doloribus quibusdam quasi. total_bounced_emails: type: integer description: Number of bounced emails example: 254440082301907429 format: int64 total_recipients: type: integer description: Total number of recipients example: 3165488552227472947 format: int64 total_responses: type: integer description: Total number of responses example: 1742409208008675494 format: int64 uid: type: string description: Survey unique identifier example: 4e8165a9-9b29-4506-b093-ab0a4aae9b84 description: Scheduled survey details example: committee_category: Quis quibusdam velit ut blanditiis et voluptatem. committee_voting_enabled: true committees: - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 - committee_name: Technical Steering Committee committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 nps_value: 0.5183088611218446 project_name: Kubernetes project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 survey_url: https://surveymonkey.com/r/abc123 total_recipients: 2315858510787901347 total_responses: 4319941305328081628 created_at: "1991-02-16T17:29:02Z" creator_id: Odio quas incidunt neque facere sit debitis. creator_name: Minus tempore. creator_username: Ab est velit aperiam recusandae voluptatum qui. email_body: In id dolores. email_body_text: Tenetur esse veritatis. email_subject: Incidunt voluptas quis suscipit iste nisi at. is_nps_survey: false is_project_survey: true last_modified_at: "2004-08-13T14:38:40Z" last_modified_by: Facilis qui ut. latest_automated_reminder_sent_at: "1984-04-10T15:20:14Z" next_automated_reminder_at: "2003-02-01T02:11:33Z" nps_value: 0.15364128203492167 num_automated_reminders_sent: 2145270834145761878 num_automated_reminders_to_send: 6632543082441364214 num_detractors: 6351795924184130794 num_passives: 3280994576108905970 num_promoters: 777312228626795634 response_status: scheduled send_immediately: false stage_filter: Consequatur quasi. survey_cutoff_date: "1988-07-31T19:17:28Z" survey_monkey_id: Quos aut necessitatibus in est. survey_reminder_rate_days: 7084723093881984689 survey_send_date: "2009-11-01T12:03:22Z" survey_status: scheduled survey_title: Maxime id. survey_url: Maiores inventore. total_bounced_emails: 55392808957965234 total_recipients: 5713742991241156416 total_responses: 6837913107047442008 uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84 required: - uid - survey_status UnauthorizedError: type: object properties: code: type: string description: HTTP status code example: Dicta magni quasi architecto. message: type: string description: Error message example: Dolorum velit ratione possimus velit labore voluptatem. description: Unauthorized error response example: code: Culpa dolor id pariatur. message: Consectetur porro aut eius ab officia. required: - code - message UpdateSurveyRequestBody: type: object properties: committee_uid: type: string description: Committee UID to send survey to example: qa1e8536-a985-4cf5-b981-a170927a1d11 committee_voting_enabled: type: boolean description: Whether committee voting is enabled example: true creator_id: type: string description: Creator's user ID example: Nihil dolore. email_body: type: string description: Email body HTML content example: Deleniti autem doloribus rem temporibus. email_body_text: type: string description: Email body plain text content example: In et ullam. email_subject: type: string description: Email subject line example: Est vitae quia. survey_cutoff_date: type: string description: Survey cutoff/end date (RFC3339 format) example: A cumque nesciunt quasi aliquam tempora soluta. survey_reminder_rate_days: type: integer description: Days between automatic reminder emails (0 = no reminders) example: 3018393064459007843 format: int64 survey_send_date: type: string description: Date to send the survey (RFC3339 format) example: Molestiae aut quis aut vel omnis. survey_title: type: string description: Survey title example: Recusandae et laboriosam. example: committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11 committee_voting_enabled: false creator_id: Asperiores dicta quis temporibus. email_body: Quod qui veniam sunt et explicabo. email_body_text: Assumenda asperiores minus eaque facilis fugit. email_subject: Totam et optio atque quidem. survey_cutoff_date: Laborum optio sunt ipsam rerum. survey_reminder_rate_days: 6334930941210685040 survey_send_date: Architecto quaerat nemo amet est est. survey_title: Odio non. UserEmail: type: object properties: email_address: type: string description: Email address example: Molestias dolorem doloremque in sit qui. id: type: string description: Email ID example: Est quisquam aut est illum veritatis labore. is_primary: type: boolean description: Whether this is the primary email example: true description: User email information example: email_address: Esse qui non veniam iure labore. id: Minima at suscipit. is_primary: false ValidateEmailRequestBody: type: object properties: body: type: string description: Email body template example: Excepturi qui vitae aut repudiandae. subject: type: string description: Email subject template example: Voluptatem consequuntur nostrum velit sunt. example: body: Alias hic sed et aut porro. subject: Corporis harum dolores sint dignissimos in. ValidateEmailResult: type: object properties: body: type: string description: Validated email body example: An example survey body with the quarter Q1 subject: type: string description: Validated email subject example: An example survey subject with the year 2023 description: Validated email template body and subject example: body: An example survey body with the quarter Q1 subject: An example survey subject with the year 2023 required: - body - subject securitySchemes: jwt_header_Authorization: type: http description: Heimdall JWT authorization scheme: bearer tags: - name: openapi - name: survey description: Survey service that proxies to ITX survey API