Skip to content

fix: comment out non-HTTP protocol support (not yet used in CAMARA)#64

Merged
hdamker-bot merged 2 commits intocamaraproject:mainfrom
hdamker:fix/comment-out-non-http-protocols
Apr 2, 2026
Merged

fix: comment out non-HTTP protocol support (not yet used in CAMARA)#64
hdamker-bot merged 2 commits intocamaraproject:mainfrom
hdamker:fix/comment-out-non-http-protocols

Conversation

@hdamker
Copy link
Copy Markdown
Contributor

@hdamker hdamker commented Apr 2, 2026

What type of PR is this?

  • enhancement/feature

What this PR does / why we need it:

Comments out non-HTTP protocol references (MQTT3, MQTT5, AMQP, NATS, KAFKA) in both sample-service-subscriptions.yaml and CAMARA_event_common.yaml, as proposed by the Commonalities WG for Commonalities#606.

Comments stay in the source files signaling future extensibility. After bundling, only HTTP-related schemas appear in the output.

Changes:

  • Protocol enum: converted from inline array to block sequence, only HTTP active
  • Discriminator mappings: only HTTP mapping active in both SubscriptionRequest and Subscription
  • Protocol-specific schemas: 8 non-HTTP request/response schemas commented out
  • Settings schemas: MQTTSettings, AMQPSettings, ApacheKafkaSettings, NATSSettings commented out

Which issue(s) this PR fixes:

Testing ground for Commonalities#606 protocol commenting proposal.

Special notes for reviewers:

Validated locally:

  • YAML syntax: valid
  • redocly bundle: succeeds, bundled output contains zero non-HTTP references
  • spectral lint (r4 ruleset): 0 errors, 14 pre-existing warnings (no new warnings from this change)

Changelog input

 release-note
N/A (test repository)

Additional documentation

docs
N/A

Comment out MQTT3, MQTT5, AMQP, NATS, KAFKA protocol references in both
sample-service-subscriptions.yaml and CAMARA_event_common.yaml. Comments
signal future extensibility; bundled output is now HTTP-only.

Changes:
- Protocol enum: converted to block sequence, only HTTP active
- Discriminator mappings: only HTTP mapping active
- Protocol-specific schemas: 8 non-HTTP schemas commented out
- Settings schemas: MQTTSettings, AMQPSettings, ApacheKafkaSettings,
  NATSSettings commented out, HTTPSettings remains
@hdamker hdamker requested a review from hdamker-bot as a code owner April 2, 2026 12:21
hdamker-bot
hdamker-bot previously approved these changes Apr 2, 2026
yamllint comments-indentation requires comments to match the indent of
the next non-comment content. Commented-out schemas at end of file had
no following content (indent 0), triggering the warning. Moving them
into the section header block before the active HTTP schemas fixes this.
@hdamker-bot hdamker-bot merged commit bbeb6cf into camaraproject:main Apr 2, 2026
2 checks passed
hdamker added a commit to hdamker/Commonalities that referenced this pull request Apr 2, 2026
Comment out MQTT3, MQTT5, AMQP, NATS, KAFKA protocol references in both
sample-service-subscriptions.yaml and CAMARA_event_common.yaml. Comments
signal future extensibility; bundled output is now HTTP-only.

Changes:
- Protocol enum: converted to block sequence, only HTTP active
- Discriminator mappings: only HTTP mapping active
- Protocol-specific schemas: 8 non-HTTP schemas commented out
- Settings schemas: MQTTSettings, AMQPSettings, ApacheKafkaSettings,
  NATSSettings commented out, HTTPSettings remains

Validated on camaraproject/ReleaseTest#64 (bundling + yamllint + spectral).
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.

2 participants