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

Documenting STATUS codes #7693

Merged
merged 9 commits into from
Feb 6, 2023
Merged

Documenting STATUS codes #7693

merged 9 commits into from
Feb 6, 2023

Conversation

daveaugustus
Copy link
Contributor

@daveaugustus daveaugustus commented Feb 1, 2023

Signed-off-by: Pappu Kumar pappu.kumar@progress.com

🔩 Description: What code changed, and why?

As an Automate user accessing the API page would like to know all the possible error codes that can be returned by the APIs with all the possible scenarios

⛓️ Related Resources

👍 Definition of Done

  • A new section should be added at the top of the page in Chef Automate API
  • The section can be termed as “Status codes”
  • Each Code should have the description of the error
  • Each code should have the general failure scenarios
  • Each code should exceptional scenarios too with references to the APIs

👟 How to Build and Test the Change

Changes will reflect in the documentation

✅ Checklist

All PRs must tick these:

With occasional exceptions, all PRs from Progress employees must tick these:

  • Is the code clear? (complicated code or lots of comments--subdivide and use well-named methods, meaningful variable names, etc.)
  • Consistency checked? (user notifications, user prompts, visual patterns, code patterns, variable names)
  • Repeated code blocks eliminated? (adapt and reuse existing components, blocks, functions, etc.)
  • Spelling, grammar, typos checked? (at a minimum use make spell in any component directory)
  • Code well-formatted? (indents, line breaks, etc. improve rather than hinder readability)

All PRs from Progress employees should tick these if appropriate:

  • Tests added/updated? (all new code needs new tests)
  • Docs added/updated? (all customer-facing changes)

Please add a note next to any checkbox above if you are NOT ticking it.

📷 Screenshots, if applicable

Signed-off-by: Pappu Kumar <pappu.kumar@progress.com>
@netlify
Copy link

netlify bot commented Feb 1, 2023

Deploy Preview for chef-automate ready!

Name Link
🔨 Latest commit 164cb16
🔍 Latest deploy log https://app.netlify.com/sites/chef-automate/deploys/63dd15c55dc6b4000a5d4464
😎 Deploy Preview https://deploy-preview-7693--chef-automate.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added the documentation Anything related to the Automate docs. label Feb 1, 2023
@daveaugustus daveaugustus self-assigned this Feb 1, 2023
@daveaugustus daveaugustus marked this pull request as ready for review February 1, 2023 10:39
@daveaugustus daveaugustus requested a review from a team as a code owner February 1, 2023 10:39
kalroy and others added 6 commits February 2, 2023 11:55
Signed-off-by: Kallol Roy <kallol.roy@progress.com>
Signed-off-by: Pappu Kumar <pappu.kumar@progress.com>
Signed-off-by: Pappu Kumar <pappu.kumar@progress.com>
Signed-off-by: Pappu Kumar <pappu.kumar@progress.com>
Signed-off-by: Kallol Roy <kallol.roy@progress.com>
Signed-off-by: Kallol Roy <kallol.roy@progress.com>
Signed-off-by: Kallol Roy <kallol.roy@progress.com>
Signed-off-by: Kallol Roy <kallol.roy@progress.com>
@sonarcloud
Copy link

sonarcloud bot commented Feb 3, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Collaborator

@dishanktiwari2501 dishanktiwari2501 left a comment

Choose a reason for hiding this comment

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

The changes look good to me.

@kalroy kalroy merged commit 42ea6f9 into main Feb 6, 2023
@kalroy kalroy deleted the dave/STALWART-312 branch February 6, 2023 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the Automate docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants