Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend SDK to include FrontendAPI calls #26

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Conversation

sam-corbado
Copy link
Contributor

Description

We extend the Node SDK with calls that are useful to our Firebase service. This then releases the Firebase service from directly interacting with the API.

Fixes #20.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

…rontend OpenAPI TypeScript Axios code

✨ feat(Makefile): add support for generating OpenAPI Backend TypeScript Axios code from backend_api_public.yml
✨ feat(Makefile): add support for generating OpenAPI Frontend TypeScript Axios code from frontend_api_public.yml
📦 chore(frontendApi): add base.ts file for Corbado Frontend API

📦 chore(frontendApi): add common.ts file for Corbado Frontend API

📦 chore(frontendApi): add configuration.ts file for Corbado Frontend API
…on file

This commit adds the Corbado Frontend API specification file, which provides an overview of all Corbado Frontend API calls to implement passwordless authentication. The specification includes information about the API version, title, description, contact details, servers, security schemes, tags, and paths for various API endpoints.

The added file is `frontend_api_public.yml`.
…e clear guidelines for creating pull requests

The pull request template includes sections for description, type of change, testing, checklist, and more. This template will help contributors provide relevant information and ensure that the pull request meets the project's guidelines and requirements.
…ules to improve code organization and reusability
Copy link

codecov bot commented Jan 29, 2024

Codecov Report

Attention: 68 lines in your changes are missing coverage. Please review.

Comparison is base (79321c7) 26.26% compared to head (b13211e) 21.64%.

Files Patch % Lines
src/generated/frontendApi/common.ts 18.96% 46 Missing and 1 partial ⚠️
src/generated/frontendApi/configuration.ts 7.69% 12 Missing ⚠️
src/generated/frontendApi/base.ts 40.00% 6 Missing and 3 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
- Coverage   26.26%   21.64%   -4.62%     
==========================================
  Files          25       29       +4     
  Lines        3233     4125     +892     
  Branches      618      803     +185     
==========================================
+ Hits          849      893      +44     
- Misses       2192     3006     +814     
- Partials      192      226      +34     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend SDK to include FrontendAPI calls
1 participant