Skip to content

initial pass at adding tags #579

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

Merged
merged 4 commits into from
Jan 12, 2022
Merged

initial pass at adding tags #579

merged 4 commits into from
Jan 12, 2022

Conversation

ahl
Copy link
Contributor

@ahl ahl commented Jan 7, 2022

closes #535

This adds tags and a mechanism to verify that there's exactly one per endpoint. This also creates a file of tags and endpoints to help people see how endpoints are organized when adding new ones.

@jessfraz I picked not very good names for the tags; if you have opinions about better names, let me know.

If we want the tags property of the openapi header to be populated with a list of these, we can make that change in Dropshot, but it's not required by the spec so we didn't bother.

@jessfraz jessfraz mentioned this pull request Jan 7, 2022
@ahl ahl marked this pull request as ready for review January 8, 2022 06:56
Copy link
Collaborator

@davepacheco davepacheco left a comment

Choose a reason for hiding this comment

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

This looks good. I think it'd be helpful if the expected test output file was more self-describing (e.g., operations for tag "hardware" instead of just "hardware", maybe column headers for the table beneath each tag).

@@ -0,0 +1,81 @@
hardware
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@davepacheco like this:

Suggested change
hardware
operations for tag "hardware"

Copy link
Collaborator

Choose a reason for hiding this comment

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

That is what I meant. Even more explicit though:

Suggested change
hardware
API operations found with tag "hardware"
OPERATION NAME URL PATH

@ahl ahl removed the request for review from david-crespo January 11, 2022 20:15
@ahl ahl merged commit b214c18 into main Jan 12, 2022
@ahl ahl deleted the openapi-tags branch January 12, 2022 04:30
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.

api spec issues
2 participants