Skip to content

feat(swagger): add 'Public' tag to all /api/public/ OpenAPI operations - #587

Open
mulldug wants to merge 1 commit into
mainfrom
feat/add-public-swagger
Open

feat(swagger): add 'Public' tag to all /api/public/ OpenAPI operations#587
mulldug wants to merge 1 commit into
mainfrom
feat/add-public-swagger

Conversation

@mulldug

@mulldug mulldug commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

ref: https://app.clickup.com/t/9014802374/86bbe65my

Adds 'Public' as an additional tag to all 66 OpenAPI operations whose path begins with /api/public/. Existing domain tags are preserved. Covers 32 controller files across Summit, Main, Marketplace, and top-level controller namespaces.

Summary by CodeRabbit

  • Documentation
    • Updated API documentation to consistently classify publicly accessible endpoints under the Public category across countries, languages, marketplace, summit, member, company, release, timezone, payment, and other public services.
    • Improved API documentation scanning by excluding internal factory directories.
    • No runtime behavior or endpoint functionality changed.

Adds 'Public' as an additional tag to all 66 OpenAPI operations whose
path begins with /api/public/. Existing domain tags are preserved.
Covers 32 controller files across Summit, Main, Marketplace, and
top-level controller namespaces.
@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 77a66aed-d638-4004-b35d-658df4b704b8

📥 Commits

Reviewing files that changed from the base of the PR and between 76b79ae and 8e13c74.

📒 Files selected for processing (33)
  • app/Http/Controllers/Apis/CountriesApiController.php
  • app/Http/Controllers/Apis/LanguagesApiController.php
  • app/Http/Controllers/Apis/Marketplace/AppliancesApiController.php
  • app/Http/Controllers/Apis/Marketplace/ConsultantsApiController.php
  • app/Http/Controllers/Apis/Marketplace/DistributionsApiController.php
  • app/Http/Controllers/Apis/Marketplace/PrivateCloudsApiController.php
  • app/Http/Controllers/Apis/Marketplace/PublicCloudsApiController.php
  • app/Http/Controllers/Apis/Marketplace/RemoteCloudsApiController.php
  • app/Http/Controllers/Apis/Protected/Main/OAuth2ChunkedFilesApiController.php
  • app/Http/Controllers/Apis/Protected/Main/OAuth2CompaniesApiController.php
  • app/Http/Controllers/Apis/Protected/Main/OAuth2ElectionsApiController.php
  • app/Http/Controllers/Apis/Protected/Main/OAuth2LegalDocumentsApiController.php
  • app/Http/Controllers/Apis/Protected/Main/OAuth2MembersApiController.php
  • app/Http/Controllers/Apis/Protected/Main/OAuth2SponsoredProjectApiController.php
  • app/Http/Controllers/Apis/Protected/Main/OAuth2UserStoriesApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2RSVPInvitationApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitEventsApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitLocationsApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitMembersApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitNotificationsApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitOrderExtraQuestionTypeApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitOrdersApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitRegistrationInvitationApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSelectionPlansApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSpeakersApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSponsorApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitTracksApiController.php
  • app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitsEventTypesApiController.php
  • app/Http/Controllers/Apis/ReleasesApiController.php
  • app/Http/Controllers/Apis/TimezonesApiController.php
  • app/Http/Controllers/PaymentGatewayWebHookController.php
  • config/l5-swagger.php

Included review availability: Your plan includes up to 1 review per rolling hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Changes

Public OpenAPI metadata

Layer / File(s) Summary
Swagger scan exclusions
config/l5-swagger.php
Swagger scanning now excludes the Summit and Main Factories directories.
General and marketplace public operations
app/Http/Controllers/Apis/CountriesApiController.php, app/Http/Controllers/Apis/LanguagesApiController.php, app/Http/Controllers/Apis/Marketplace/*, app/Http/Controllers/Apis/ReleasesApiController.php, app/Http/Controllers/Apis/TimezonesApiController.php, app/Http/Controllers/PaymentGatewayWebHookController.php
The affected operations now include the Public OpenAPI tag while retaining their existing tags.
Main public operations
app/Http/Controllers/Apis/Protected/Main/*
Company, election, legal-document, member, sponsored-project, user-story, and file-upload operations now include the Public tag.
Summit public operations
app/Http/Controllers/Apis/Protected/Summit/*
Public summit-related operations now include the Public tag alongside their existing tags.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 8e13c

This change only adds the Public tag to documented public API operations while preserving existing tags; no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: smarcet

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: adding the Public tag to all /api/public/ OpenAPI operations.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/add-public-swagger

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.

@github-actions

Copy link
Copy Markdown

📘 OpenAPI / Swagger preview

➡️ https://OpenStackweb.github.io/summit-api/openapi/pr-587/

This page is automatically updated on each push to this PR.

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