feat: implement URL store API #1400
Open
+1,226
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
nitinja
requested changes
Nov 6, 2025
API Enhancements: - Add sortBy and sortOrder query parameters to all listing endpoints - Support sorting by: rank, traffic, url, createdAt, updatedAt - Add rank and traffic fields to add/update operations - Update OpenAPI documentation with new parameters and fields Performance Improvements: - Refactor bulk operations to use Promise.allSettled for parallel processing - Replace sequential for-loops with parallel map operations - Improve response time for bulk add/update/delete operations Code Quality: - Fix all 15 pre-existing linting errors - Remove unused encodeUrlToBase64 function - Eliminate no-continue statements (7 instances) - Eliminate no-await-in-loop violations (7 instances) - Fix trailing spaces and OpenAPI YAML syntax errors - All linting now passing (0 errors)
- Resolved conflicts in src/index.js and src/routes/index.js - Kept both URL Store Controller and PTA2 Controller features
Add REST API endpoints to manage and query offsite brand presence URLs
(Wikipedia, YouTube, social media, etc.) alongside primary site URLs.
New Endpoints:
- GET /sites/{siteId}/url-store/by-platform/{platformType}
Query URLs by specific platform type with sorting/pagination
- GET /sites/{siteId}/url-store/offsite
Get all offsite URLs with sorting/pagination
Controller Changes:
- Add listUrlsByPlatform() endpoint handler
- Add listOffsiteUrls() endpoint handler
- Update addUrls() to accept and validate platformType
- Update updateUrls() to accept and validate platformType
- Import PLATFORM_TYPES from data access layer
OpenAPI Documentation:
- Document new endpoints with full specifications
- Add platformType field to all URL schemas
- Include sorting parameters (rank, traffic, etc.)
- Add platform type enum validation
Testing:
- Add 13 comprehensive controller tests
- Test platform type validation
- Test sorting and pagination
- Test default value behavior
All endpoints support sorting by rank, traffic, url, createdAt, updatedAt
with asc/desc ordering and cursor-based pagination.
Note: OpenAPI validation warnings for nullable fields are pre-existing
and tracked separately.
nitinja
approved these changes
Nov 17, 2025
…RLs" This reverts commit a572480.
HollywoodTonight
force-pushed
the
urlStore_tud
branch
from
db6846c to
cdb477e
Compare
…ery parameter
Replace the 'source' string attribute with 'byCustomer' boolean to simplify
filtering and clearly distinguish between customer-added (true) and
system-added (false) URLs.
API Changes:
- Update GET /sites/{siteId}/url-store to accept byCustomer query parameter (default: true)
- Remove GET /sites/{siteId}/url-store/by-source/{source} endpoint
- Update listUrls() to filter by byCustomer with default true
- Remove listUrlsBySource() function
- Update addUrls() to use byCustomer instead of source
- Update deleteUrls() to check byCustomer instead of source
OpenAPI Changes:
- Add byCustomer query parameter to url-store-list endpoint
- Remove url-store-by-source endpoint documentation
- Update all schemas: AuditUrl, AuditUrlInput with byCustomer boolean
- Update example responses to use byCustomer
Migration:
- source='manual' → byCustomer=true
- source='sitemap'/'discovery'/other → byCustomer=false
Resolve conflict in src/routes/index.js: - Keep both urlStoreController and pta2Controller in JSDoc - Both controllers already present in function signature
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please ensure your pull request adheres to the following guidelines:
describe here the problem you're solving.
If the PR is changing the API specification:
yet. Ideally, return a 501 status code with a message explaining the feature is not implemented yet.
If the PR is changing the API implementation or an entity exposed through the API:
If the PR is introducing a new audit type:
Related Issues
Thanks for contributing!