Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(guidelines): remove consumer-facing rules that have been included in API Portal #62

Merged
merged 6 commits into from
Feb 5, 2024

Conversation

BirgitBader
Copy link
Contributor

@BirgitBader BirgitBader commented Feb 1, 2024

Changelog:

Removal

The following rules have been removed as they contained consumer-facing content. This content has been included in the API Portal in the REST API sections "Status codes", "Headers" "Preview", and "Deprecation" respectively.

  • MUST NOT rely on API components marked as preview
  • MUST NOT not start using deprecated APIs
  • MUST accept undocumented status codes
  • MUST follow redirection
  • SHOULD honor available ETag header on subsequent modifications

@BirgitBader BirgitBader requested a review from cgebken February 1, 2024 17:13
@BirgitBader
Copy link
Contributor Author

For your review @plemech23 🙂

Copy link
Contributor

@cgebken cgebken left a comment

Choose a reason for hiding this comment

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

Almost perfect ;) Furthermore, I was wondering if we should add the rule numbers in the changelog? Usually the number is pretty prominent and if people only noted the number but not the rule name, they might still find the information that it was removed @BirgitBader ?

…es/should-add-deprecation-and-sunset-header-to-responses.md

Co-authored-by: Christina Framke <[email protected]>
@BirgitBader
Copy link
Contributor Author

Almost perfect ;) Furthermore, I was wondering if we should add the rule numbers in the changelog? Usually the number is pretty prominent and if people only noted the number but not the rule name, they might still find the information that it was removed @BirgitBader ?

I remember that we discussed this already, when we crafted the PR template for the guidelines. And we decided against it.
We already had a removal on 2023-06-23 and it worked well.

@BirgitBader BirgitBader requested a review from cgebken February 5, 2024 07:36
@BirgitBader BirgitBader merged commit d3a84df into main Feb 5, 2024
1 check passed
@BirgitBader BirgitBader deleted the remove-consumer-facing-rules branch February 5, 2024 09:10
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