Skip to content

feat: add Kiprio.com APIs (email-validate, bizday, hash)#2503

Open
ForeverTools wants to merge 3 commits into
APIs-guru:mainfrom
ForeverTools:add-kiprio-apis
Open

feat: add Kiprio.com APIs (email-validate, bizday, hash)#2503
ForeverTools wants to merge 3 commits into
APIs-guru:mainfrom
ForeverTools:add-kiprio-apis

Conversation

@ForeverTools
Copy link
Copy Markdown

New APIs: kiprio.com

Adding 3 APIs from Kiprio.com — a developer-focused API platform providing utility HTTP endpoints.

APIs added:

  1. Email Validation (/v1/email-validate)

  2. Business Days Calculator (/v1/bizday)

  3. Hash & Encode (/v1/hash)

All specs are OpenAPI 3.0.3, served from stable URLs on kiprio.com (cPanel, 99.9% uptime).
Free demo tier on every endpoint, no key required for testing.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces three new OpenAPI 3.0.3 specifications for Kiprio's Business Days Calculator, Email Validation, and Hash & Encode APIs. The review feedback focuses on enhancing the robustness of these definitions for better client generation. Key recommendations include adding missing response content for the HMAC endpoint, defining required properties across all response schemas to ensure consistent model generation, and maintaining consistency for date formats and algorithm enums across different operations.

default: sha256
responses:
'200':
description: HMAC result
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The 200 response for the /hmac endpoint is missing a content definition. Without a schema, client generators cannot produce typed responses for this operation.

          description: HMAC result
          content:
            application/json:
              schema:
                type: object
                required:
                  - input
                  - algo
                  - hash
                properties:
                  input:
                    type: string
                  algo:
                    type: string
                  hash:
                    type: string

Comment on lines +57 to +62
type: object
properties:
from:
type: string
to:
type: string
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The response schema should define required properties to ensure consistent behavior in generated clients. Additionally, the from and to fields in the response should include format: date to match the input parameters.

                type: object
                required:
                  - from
                  - to
                  - business_days
                  - calendar_days
                  - country
                properties:
                  from:
                    type: string
                    format: date
                  to:
                    type: string
                    format: date

Comment on lines +43 to +44
type: object
properties:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

It is best practice to specify which properties are required in the response schema. This helps client generators create more accurate models.

                type: object
                required:
                  - input
                  - valid
                  - syntax_ok
                  - mx_found
                  - disposable
                  - role_based
                  - free_provider
                  - confidence
                properties:

Comment on lines +48 to +49
type: object
properties:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The response schema for the hash operation should define required properties to ensure the output is correctly parsed by generated clients.

                type: object
                required:
                  - input
                  - algo
                  - hash
                properties:

Comment on lines +72 to +74
algo:
type: string
default: sha256
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The algo property in the HMAC request body should include the same enum as the GET endpoint to restrict inputs to supported algorithms and improve documentation.

                algo:
                  type: string
                  enum: [md5, sha1, sha256, sha384, sha512, sha3-256, sha3-512]
                  default: sha256

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.

1 participant