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

Set required proto fields in cursor messages #5061

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

eleftherias
Copy link
Contributor

Summary

Set the fields in Cursor and CursorPage as required or optional, to generate a correct OpenAPI spec.

Ref #4952

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@eleftherias eleftherias requested a review from a team as a code owner November 27, 2024 08:43
rdimitrov
rdimitrov previously approved these changes Nov 27, 2024
@coveralls
Copy link

coveralls commented Nov 27, 2024

Coverage Status

coverage: 54.665% (+0.003%) from 54.662%
when pulling 69b32ba on eleftherias:openapi-required-cursor
into 2b44edb on mindersec:main.

@@ -100,12 +100,14 @@ message Cursor {
(buf.validate.field).string = {
pattern: "^[[:word:]=]*$",
max_len: 200,
}
},
(google.api.field_behavior) = REQUIRED
Copy link
Contributor

Choose a reason for hiding this comment

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

is the cursor actually required? Thought an empty cursor was valid and it would be the start.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right, thank you

@eleftherias eleftherias merged commit 5170f07 into mindersec:main Nov 27, 2024
26 checks passed
@eleftherias eleftherias deleted the openapi-required-cursor branch November 27, 2024 10:13
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.

4 participants