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

docs: Add tags to all json specs #76

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

johnchaffee
Copy link

@johnchaffee johnchaffee commented Sep 23, 2022

A tag has been added to each endpoint that matches the last path of the endpoint. This allows common APIs to be grouped by tag in Swagger UI.

For example, the following 5 endpoints are all grouped under the "Messages" tag:

POST    /2010-04-01/Accounts/{AccountSid}/Messages.json
GET     /2010-04-01/Accounts/{AccountSid}/Messages.json
DELETE  /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json
GET     /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json
POST    /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json

You can view the spec + tags rendered in Swagger UI here:

https://johnchaffee.github.io/twilio-swagger/api/api_v2010/

Fixes #74

I added these tags using this script, which you are welcome to clone.

A tag has been added to each endpoint that matches the last path of the endpoint. This allows common APIs to be grouped by tag in Swagger UI.
@childish-sambino
Copy link
Contributor

This issue has been added to our internal backlog to be prioritized as it changes generated configuration. +1s on the issue summary will help it move up the backlog (DI-2364).

@childish-sambino childish-sambino added status: work in progress Twilio or the community is in the process of implementing type: twilio enhancement feature request on Twilio's roadmap code-generation issue deals with generated code labels Sep 30, 2022
@childish-sambino childish-sambino added status: waiting for feature feature will be implemented in the future and removed status: work in progress Twilio or the community is in the process of implementing labels Nov 9, 2022
@Tim-Heartbeat
Copy link

Any chance for this to get merged in or anywhere where I can upvote that issue as having the ability to more selectively import models would be nice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-generation issue deals with generated code status: waiting for feature feature will be implemented in the future type: twilio enhancement feature request on Twilio's roadmap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add tags to specs
4 participants