Skip to content

Add techtenstein.com/lorem-forge - #2846

Open
sathvic-kollu wants to merge 1 commit into
APIs-guru:mainfrom
techtenstein-labs:add-techtenstein-lorem-forge-1784260373
Open

sathvic-kollu wants to merge 1 commit into
APIs-guru:mainfrom
techtenstein-labs:add-techtenstein-lorem-forge-1784260373

Conversation

@sathvic-kollu

Copy link
Copy Markdown

Adding lorem-forge API — Lorem ipsum placeholder text — words, sentences, paragraphs, plain or HTML.

Live: https://lorem-forge.techtenstein.com
OpenAPI: https://lorem-forge.techtenstein.com/openapi.json

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

Copy link
Copy Markdown

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 the initial OpenAPI 3.1.0 specification for the lorem-forge API, defining endpoints for generating random words, sentences, and paragraphs, along with health and documentation paths. Feedback on the specification highlights that the /, /health, and /openapi.json paths are missing the required responses field, which violates the OpenAPI specification. Additionally, it is recommended to change the html query parameter on the /paragraphs endpoint from a string to a boolean type for better API design.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +24 to +32
/:
get:
summary: "Landing / docs"
/health:
get:
summary: "Health"
/openapi.json:
get:
summary: "OpenAPI spec"

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

According to the OpenAPI Specification, the responses field is required for every operation object. Currently, the /, /health, and /openapi.json paths do not define any responses, which makes this an invalid OpenAPI document. Adding a default 200 response for these paths resolves this issue.

  /:
    get:
      summary: "Landing / docs"
      responses:
        200:
          description: "Success"
  /health:
    get:
      summary: "Health"
      responses:
        200:
          description: "Success"
  /openapi.json:
    get:
      summary: "OpenAPI spec"
      responses:
        200:
          description: "Success"

Comment on lines +69 to +73
- name: "html"
in: "query"
schema:
type: "string"
default: "false"

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 html parameter is a boolean flag but is currently defined as a string type with a default value of "false". It is cleaner and more idiomatic to define it as a boolean type with a boolean default value of false.

        - name: "html"
          in: "query"
          schema:
            type: "boolean"
            default: false

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