apim-apps Fix: Remove incorrect validation message for GraphQL Endpoint input

Fixes https://github.com/wso2/api-manager/issues/3724#issuecomment-2687465288

Issue URL:https://github.com/wso2/api-manager/issues/3724#issuecomment-2687465288

Problem

Publisher portal shows an incorrect validation message "URL should not be empty" when creating a GraphQL API with an Endpoint, even when the user has entered a valid domain name (e.g., "countries.trevorblades.com").

Root Cause

The validateURL function in ProvideGraphQL.jsx uses APIValidation.url.required().validate() which requires a full URL with http:// or https:// scheme. When users enter just a domain name, this strict URL validation fails and displays the misleading "URL should not be empty" message.

Solution

Modified the validation logic in ProvideGraphQL.jsx (line 196-216) to:

For GraphQL Endpoint: Skip strict URL validation and only check if the input is not empty
For GraphQL SDL URL: Keep the strict URL validation as before
Let the backend API validation handle the actual endpoint validation through introspection

Changes Made

Modified: portals/publisher/src/main/webapp/source/src/app/components/Apis/Create/GraphQL/Steps/ProvideGraphQL.jsx
Added conditional validation based on input type (ENDPOINT vs URL)
Allows domain names without protocol for GraphQL Endpoint

Build Information

Java 11 (Temurin-Hotspot)
Maven 3.6.3
Built component: Publisher portal
Generated artifact: target/publisher.war

Artifacts Replaced

Frontend: Replaced publisher folder in wso2am-4.6.0/repository/deployment/server/webapps/
Unzipped publisher.war to create updated folder structure

Testing

No testing required for frontend changes (as per workflow guidelines)

Modified wso2am Pack Download

The complete modified wso2am-4.6.0 pack is available as a GitHub Actions artifact.

🔗 Download from GitHub Actions

Artifact Details:

Name: wso2am-4.6.0-issue-68.zip
How to Download:
1. Click the link above
2. Scroll to "Artifacts" section
3. Download the zip file
4. Extract and use directly

Contents: Complete wso2am pack with all updated artifacts ready to use.

🤖 Generated with Claude Code

Co-Authored-By: Claude [email protected]

Summary by CodeRabbit

Bug Fixes
- GraphQL endpoint validation now supports flexible endpoint formats, including domain-like entries without requiring full URL formatting with protocol specifications
- Improved error messaging provides clearer feedback when GraphQL endpoint values are empty

Nov 12 '25 04:11 ranuka-laksika

Walkthrough

The change modifies the validateURL function in ProvideGraphQL.jsx to conditionally validate GraphQL endpoints based on input type. For ENDPOINT types, strict URL validation is bypassed, allowing domain-like values without protocols. For other types, standard URL validation is retained. Error messaging is adjusted to specify "GraphQL Endpoint should not be empty" for ENDPOINT type validation failures.

Changes

Cohort / File(s)	Change Summary
GraphQL endpoint validation logic `portals/publisher/src/main/webapp/source/src/app/components/Apis/Create/GraphQL/Steps/ProvideGraphQL.jsx`	Modified `validateURL` function to conditionally apply URL validation based on `inputType`. ENDPOINT type skips strict validation and allows domain-like values; other types retain APIValidation.url.required() validation. Adjusted error messaging for ENDPOINT type validation failures.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant User as User Input
    participant ValidateURL as validateURL()
    participant Validation as APIValidation
    participant Debounce as debouncedValidateURLOrEndpoint

    rect rgb(200, 240, 220)
    Note over ValidateURL: New: ENDPOINT Type Path
    User->>ValidateURL: Input value, inputType="ENDPOINT"
    alt value is empty
        ValidateURL->>ValidateURL: Set error: "GraphQL Endpoint<br/>should not be empty"
        ValidateURL->>User: onValidate(false)
    else value is not empty
        ValidateURL->>Debounce: Trigger debounced validation
        Debounce->>User: Proceed with validation
    end
    end

    rect rgb(220, 235, 245)
    Note over ValidateURL: Existing: Other Input Types
    User->>ValidateURL: Input value, inputType≠"ENDPOINT"
    ValidateURL->>Validation: APIValidation.url.required().validate(value)
    alt validation succeeds
        Validation->>Debounce: Trigger debounced validation
    else validation fails
        Validation->>ValidateURL: Return error
        ValidateURL->>User: Update validity, onValidate(false)
    end
    end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Focus areas:
- Verify conditional logic correctly distinguishes between ENDPOINT and other input types
- Confirm error message "GraphQL Endpoint should not be empty" aligns with UI requirements
- Validate that debounced validation is properly triggered for non-empty ENDPOINT values
- Check that existing URL validation for other input types remains functionally unchanged

Poem

🐰 A rabbit hops through endpoint lands, Where protocols need not take a stand, Domain-like values now find their way, No strict URL rules hold sway, Validation flows with flexible grace! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The PR only addresses validation message removal for GraphQL Endpoint input, but linked issue #3724 requires fixing operation-level rate limiting UI behavior and preventing API save without throttling policies.	Address all coding requirements from issue #3724: disable operation-level rate limiting dropdowns when API-level is selected, and prevent API save without API-level policy selection.
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	Title directly addresses the main change: removing incorrect validation message for GraphQL Endpoint input by allowing domain names without protocol.
Out of Scope Changes check	✅ Passed	The change to ProvideGraphQL.jsx validation logic is directly scoped to the stated objective of fixing the GraphQL Endpoint validation message issue.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

[ ] 📝 Generate docstrings

🧪 Generate unit tests (beta)

[ ] Create PR with unit tests
[ ] Post copyable unit tests in a comment

[!TIP]

📝 Customizable high-level summaries are now available!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

Provide custom instructions to shape the summary (bullet lists, tables, contributor stats, etc.).

Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example:

"Create a concise high-level summary as a bullet-point list. Then include a Markdown table showing lines added and removed by each contributing author."

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Nov 12 '25 04:11 coderabbitai[bot]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Nov 12 '25 04:11 sonarqubecloud[bot]