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

Add tags to specs #74

Open
johnchaffee opened this issue Sep 2, 2022 · 2 comments · May be fixed by #76
Open

Add tags to specs #74

johnchaffee opened this issue Sep 2, 2022 · 2 comments · May be fixed by #76
Labels
status: help wanted requesting help from the community type: community enhancement feature request not on Twilio's roadmap

Comments

@johnchaffee
Copy link

johnchaffee commented Sep 2, 2022

Issue Summary

Please add tags to the specs to make them easier to navigate when using tools like Swagger UI.

For example, this is the current untagged Verify spec when rendered in Swagger UI:

https://johnchaffee.wiki/twilio-swagger/apis/verify-untagged/

And this is the same spec with tags added:

https://johnchaffee.wiki/twilio-swagger/apis/verify/

As you can see, the tagged version is easier for a human to navigate.

Steps to Reproduce

For each method (get, post, put, delete) add a tags item that describes the resource it is associated with.

For example, add "tags": ["Verifications"] to the post method in the /v2/Services/{ServiceSid}/Verifications path:

      "post": {
        "tags": ["Verifications"],
        "description": "Create a new Verification using a Service",

Technical details:

  • twilio-oai version: 1.3.4

Other

Let me know if I can help in any way.

@twilio-dx
Copy link
Collaborator

Ahoy! Thank you for opening your first issue here! If this request is regarding troubleshooting your application, please reach out to the support team via https://support.twilio.com.

@JenniferMah JenniferMah added status: help wanted requesting help from the community type: community enhancement feature request not on Twilio's roadmap labels Sep 6, 2022
@JenniferMah
Copy link
Contributor

This issue has been added to our internal backlog to be prioritized. Pull requests and +1s on the issue summary will help it move up the backlog.

@johnchaffee johnchaffee linked a pull request Sep 23, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: help wanted requesting help from the community type: community enhancement feature request not on Twilio's roadmap
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants