Commit e771253e authored by Eric Eastwood's avatar Eric Eastwood

Add tags to routes for prettier docs

parent 40eed7ed
Pipeline #6282673 failed with stages
......@@ -2,7 +2,16 @@ swagger: "2.0"
info:
version: 1.0.0
title: Swagger API Lab
description: API mocks for use with GitLab
description:
API mocks for use with GitLab
See https://gitlab.com/gitlab-org/apilab
host: apilab.gitlab.com
schemes:
- https
consumes:
- application/x-www-form-urlencoded
......@@ -10,6 +19,15 @@ consumes:
produces:
- application/json
tags:
- name: Pets
description: Everything about your Pets
- name: Users
description: Interact with and retrive data about a user
definitions:
user:
required:
......@@ -93,6 +111,8 @@ paths:
/users:
post:
description: Creates a new user in the store
tags:
- Users
operationId: addUser
parameters:
- name: user
......@@ -117,6 +137,8 @@ paths:
get:
description: Returns a user by user ID
tags:
- Users
operationId: findUserByUserId
responses:
default:
......@@ -126,6 +148,8 @@ paths:
patch:
description: Updates a user by user ID
tags:
- Users
parameters:
- name: user
in: body
......@@ -145,6 +169,8 @@ paths:
post:
description: Creates a new snippet in the store
tags:
- Users
operationId: addSnippetUnderUser
parameters:
- name: snippet
......@@ -174,6 +200,8 @@ paths:
get:
description: Returns a snippet by ID
tags:
- Users
operationId: findSnippetUnderUserById
responses:
default:
......@@ -183,6 +211,8 @@ paths:
patch:
description: Updates a snippet by ID
tags:
- Users
parameters:
- name: snippet
in: body
......@@ -200,6 +230,8 @@ paths:
/pets:
get:
description: Returns all pets, optionally filtered by one or more criteria
tags:
- Pets
operationId: findPets
parameters: &petFilters
- name: tags
......@@ -247,6 +279,8 @@ paths:
delete:
description: Deletes all pets, optionally filtered by one or more criteria
tags:
- Pets
operationId: deletePets
parameters: *petFilters
responses:
......@@ -259,6 +293,8 @@ paths:
post:
description: Creates a new pet in the store
tags:
- Pets
operationId: addPet
parameters:
- name: pet
......@@ -283,6 +319,8 @@ paths:
get:
description: Returns a pet by name
tags:
- Pets
operationId: findPetByName
responses:
default:
......@@ -296,6 +334,8 @@ paths:
delete:
description: Deletes a single pet based on the name supplied
tags:
- Pets
operationId: deletePet
responses:
default:
......@@ -305,6 +345,8 @@ paths:
patch:
description: Updates a pet by name
tags:
- Pets
parameters:
- name: pet
in: body
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment