Open jbrauchler opened 8 years ago
Did you want something like the following?
## Pizza [/pizzas/{id}]
+ Parameters
+ id - Id of the pizza
### Customize a Pizza [PUT]
...
### Delete a Pizza [DELETE]
...
I know how to accomplish that, I was trying to make it so that each action within the api has its own label above it.
Are you looking for something like this?
## Customize Pizza [PUT /pizzas/{id}]
...
## Delete Pizza [DELETE /pizzas/{id}]
...
Yes exactly but I attempted that, and it doesn't work because they have the same uri
@jbrauchler True, you would get a warning on that because they have the same url endpoint and thus should be merged into a single resource instead of 2 different actions according to good API design.
Is there a way to get around that by chance?
AFAIK, no.
Okay Thanks
@jbrauchler can you please elaborate on what you are refering to when you say "label above it".
The following example will allow you to add description for each action.
FORMAT: 1A
# Pizza API
## Pizza [/pizzas/{id}]
+ Parameters
+ id: abc
## Customise Pizza [PUT]
Description for customising a pizza
## Delete Pizza [DELETE]
Description for deleting a pizza
Rendered:
Is there a way to make it so that if you have multiple actions with the same uri to document that but still have labels for each action that show up above in the documentation.
Something like this....