Skip to content

Conversation

@matiasperrone-exo
Copy link
Contributor

@matiasperrone-exo matiasperrone-exo commented Oct 6, 2025

Summary:

This is the initial scaffolding work to organize Swagger/OpenAPI documentation schemas, breaking them down into logical domain-specific files oriented as the serializers are organized.

Establishes the connection between the main schemas file and all the modular schema files, ensuring that when schemas.php is loaded, all the related schema definitions from the separate files will be available. This follows a modular approach to organizing Swagger/OpenAPI schema definitions while maintaining a single entry point.

Key Changes:

Created 24 new PHP schema files in the Swagger directory. All files follow the same pattern:

  • Each file contains only a basic PHP opening tag and empty comment
  • All files are essentially placeholder/skeleton files with no actual implementation yet

Namespace formatting: Fixed the namespace declaration by adding proper spacing and separating it from the PHP opening tag.
Added require statements: Added 22 require statements to include all the newly created schema files:
Uses __DIR__ . DIRECTORY_SEPARATOR for cross-platform path compatibility.

Files Created:

  • AuditSchemas.php - For audit-related API schemas
  • CCLASchemas.php - For CCLA (Contributor License Agreement) schemas
  • ChatTeamsSchemas.php - For chat teams functionality
  • CompaniesSchemas.php - For company-related schemas
  • ElectionsSchemas.php - For election/voting schemas
  • LocationsSchemas.php - For location/venue schemas
  • MarketplaceSchemas.php - For marketplace functionality
  • ResourceServerSchemas.php - For resource server schemas
  • SoftwareSchemas.php - For software-related schemas
  • SummitMetricsSchemas.php - For summit metrics and analytics
  • SummitPresentationSchemas.php - For presentation schemas
  • SummitPresentationTrackQuestionsSchemas.php - For track question schemas
  • SummitProposedScheduleSchemas.php - For proposed schedule schemas
  • SummitRSVPSchemas.php - For RSVP functionality
  • SummitRSVPTemplatesSchemas.php - For RSVP template schemas
  • SummitRegistrationPrintSchemas.php - For registration printing
  • SummitRegistrationPromoCodesSchemas.php - For promo code schemas
  • SummitRegistrationRefundsSchemas.php - For refund schemas
  • SummitRegistrationSchemas.php - For registration schemas
  • SummitSchemas.php - For general summit schemas
  • SummitSpeakersSchemas.php - For speaker schemas
  • SummitTrackTagGroupsSchemas.php - For track tag group schemas

Related task:

Ref: https://app.clickup.com/t/86b6zbayf

@matiasperrone-exo matiasperrone-exo self-assigned this Oct 6, 2025
@matiasperrone-exo matiasperrone-exo changed the title Chore | OpenAPI schemas re-organization Chore | OpenAPI schemas re-organization scaffolding Oct 6, 2025
Copy link
Collaborator

@smarcet smarcet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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.

3 participants