Skip to content

feat: add common employee signup and email API contracts - #877

Open
Aniruddha-Shriwant wants to merge 1 commit into
mainfrom
feat/common-employee-signup-email-api-specs
Open

feat: add common employee signup and email API contracts#877
Aniruddha-Shriwant wants to merge 1 commit into
mainfrom
feat/common-employee-signup-email-api-specs

Conversation

@Aniruddha-Shriwant

Copy link
Copy Markdown
Contributor

Description

  • Adds OpenAPI contracts for five Common employee, organization-signup, and secondary-email operations.
  • Documents OAuth security for the two employee operations and explicit unauthenticated security for the three routes whitelisted by fyle-auth.
  • Adds request, response, and runtime error schemas derived from platform-api routes, Marshmallow schemas, actions, fixtures, and current clients.
  • Regenerates reference/common.yaml with Redocly CLI 2.19.0.
  • Does not add x-internal; these contracts remain public.

Runtime evidence

  • Existing YAML fixtures cover approver_allowed, signup/validate, and secondary_emails/verify.
  • employees/is_mobile_verified currently has no API YAML fixture.
  • orgs/signup has focused core pytest coverage but no API YAML fixture; test additions remain deferred.

Validation

  • Redocly 2.19.0 bundle completed successfully.
  • Redocly lint reports no findings for the five new operations. The Common root still has five pre-existing security-defined errors and one pre-existing info-license warning.
  • git diff --check passed.

Clickup

Task link was not provided; repository-check placeholder: https://app.clickup.com/

@github-actions github-actions Bot added the size/XL Extra Large PR label Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XL Extra Large PR

Development

Successfully merging this pull request may close these issues.

1 participant