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

Operation build example #23

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

maishanisa1
Copy link

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

Copy link
Contributor

Choose a reason for hiding this comment

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

Please don't update this file when making other changes.

Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

Thanks for adding a prices feature to the API. There are a few things in this pull request to improve before we are ready to merge. First of all: please complete the pull request template and update the pull request title to explain what this pull request does and why it matters.

In design terms, would be better to re-use parameters wherever possible, otherwise the API design can easily lose consistency. For these *2 entries, it looks like the only change is the description. Instead of duplicating the parameter, consider either:

  • making the parameter description generic enough that it makes sense in multiple contexts.
  • adding a description alongside $ref if a specific description is needed.

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.

None yet

2 participants