Skip to content

fix: aligned ErrorInfo with API Design Guidelines#131

Merged
Kevsy merged 2 commits intocamaraproject:mainfrom
Kevsy:main
Sep 3, 2025
Merged

fix: aligned ErrorInfo with API Design Guidelines#131
Kevsy merged 2 commits intocamaraproject:mainfrom
Kevsy:main

Conversation

@Kevsy
Copy link
Contributor

@Kevsy Kevsy commented Sep 3, 2025

What type of PR is this?

Add one of the following kinds:

  • correction

What this PR does / why we need it:

Aligns order of properties in ErrorInfo with API Design Guidelines

Which issue(s) this PR fixes:

Fixes #130

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

@Kevsy
Copy link
Contributor Author

Kevsy commented Sep 3, 2025

HI @JoseMConde - once this is approved I will merge the updated main branch into the release PR.

@JoseMConde
Copy link
Contributor

Hi @Kevsy , couple of doubts. :-)
Why a different PR, doesn't make sense do it in the M4 PR??
It was not mandatory, as far as I remember, the order of the properties, is it now??

@Kevsy
Copy link
Contributor Author

Kevsy commented Sep 3, 2025

HI @JoseMConde -

Why a different PR, doesn't make sense do it in the M4 PR??

That's because the M4 PR "A release PR does not change the content the repository other than the following changes" (i.e. version metadata, etc.)

It was not mandatory, as far as I remember, the order of the properties, is it now??

No, it's not mandatory - but 'encouraged' :).

Both orders are compliant with r3.3 (API Design Guidelines has a different order to CAMARA_common.yaml). But on the release management call we agreed it was best to do it where possible because there can be an impact on code generation tools. Because SED is having a major version change anyway, it makes sense to do it now

@JoseMConde
Copy link
Contributor

HI @JoseMConde -

Why a different PR, doesn't make sense do it in the M4 PR??

That's because the M4 PR "A release PR does not change the content the repository other than the following changes" (i.e. version metadata, etc.)

It was not mandatory, as far as I remember, the order of the properties, is it now??

No, it's not mandatory - but 'encouraged' :).

Both orders are compliant with r3.3 (API Design Guidelines has a different order to CAMARA_common.yaml). But on the release management call we agreed it was best to do it where possible because there can be an impact on code generation tools. Because SED is having a major version change anyway, it makes sense to do it now

Thank you!! Understood! :)

@Kevsy Kevsy merged commit 4a575c7 into camaraproject:main Sep 3, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: not aligned with API Design Guidelines for the ErrorInfo order

2 participants