Skip to content

feat: OAuth2 diagram, SEO config, auth flow builder, schema type descriptions - #262

Open
john2ydep2-gt wants to merge 1 commit into
Pidoko257:mainfrom
john2ydep2-gt:feat/issues-251-252-253-255
Open

feat: OAuth2 diagram, SEO config, auth flow builder, schema type descriptions#262
john2ydep2-gt wants to merge 1 commit into
Pidoko257:mainfrom
john2ydep2-gt:feat/issues-251-252-253-255

Conversation

@john2ydep2-gt

Copy link
Copy Markdown

Summary

This PR resolves four enhancement issues in a single batch commit.


Closes #251 — Interactive OAuth2 Flow Diagram

  • Added an animated OAuth2FlowDiagram component to src/pages/index.tsx
  • Supports three flows: Authorization Code, PKCE, and Implicit (Legacy)
  • Each step is clickable and shows actor details + a link to the API reference
  • "Animate Flow" button steps through the sequence with CSS animations
  • Mobile fallback renders a plain ordered list
  • All diagram CSS added to src/css/custom.css

Closes #252 — Docusaurus SEO Optimizations

  • Configured sitemap.xml generation via the preset sitemap option in docusaurus.config.ts
  • Added full OG meta tags (og:title, og:description, og:type, og:url, og:image)
  • Added Twitter Card meta tags
  • Injected Schema.org JSON-LD structured data via headTags
  • Added a <link rel="canonical"> tag
  • Created static/robots.txt with Allow: / and sitemap reference

Closes #253 — Request Builder with Authentication Flows

  • Extended src/components/ApiReference.tsx with a full AuthFlowBuilder component
  • Supports four authentication methods via tabbed UI:
    • OAuth 2.0 — grant type selector, client ID/secret, scope, mock token generation, refresh, and revoke
    • API Key — header or query parameter placement, live preview
    • Bearer Token — manual entry or mock generation, Authorization header preview
    • Session — username/password login, mock session token, expiry display
  • Token status badges show Active / Expired / Idle states

Closes #255 — Response Schema Type Descriptions

  • Added SchemaTypeTooltip component that shows hover popups with human-readable type info
  • Covers: string, integer, number, boolean, array, object, date-time, date, uuid, email, uri, password, binary, int64, float, double
  • Tooltips display: description, format, constraints, enum values
  • Added SchemaDisplay table showing example Transaction response schema with required/optional badges and constraint ranges
  • All styles added to src/css/custom.css

Files Changed

File Issues
src/pages/index.tsx #251
docusaurus.config.ts #252
static/robots.txt #252
src/components/ApiReference.tsx #253, #255
src/css/custom.css #251, #253, #255

…oko257#255

Pidoko257#251 - Add interactive animated OAuth2 flow diagram to index.tsx
with step-by-step animation, clickable details, alternate flows
(Authorization Code, PKCE, Implicit), and mobile fallback list.
CSS styles added for all diagram elements.

Pidoko257#252 - Enhance Docusaurus config with SEO optimizations:
structured data (Schema.org JSON-LD), OG meta tags, Twitter Card
tags, canonical URL, sitemap.xml generation via preset, and
robots.txt in static/.

Pidoko257#253 - Add visual authentication flow builder to ApiReference.tsx
supporting OAuth2 (with grant type selector, token display, refresh
and revoke), API Key (header/query, auto-insertion preview), Bearer
Token (manual entry or mock generation), and Session (username/
password, session token display).

Pidoko257#255 - Add response schema type descriptions with hover tooltips
showing human-readable info for string, integer, date-time, uuid,
email, uri, boolean, and other types. Includes format, constraints,
and enum values. Schema fields table shows required/optional badges
and constraint ranges.
@drips-wave

drips-wave Bot commented Jul 26, 2026

Copy link
Copy Markdown

@john2ydep2-gt Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant