Skip to content

Commit

Permalink
Update swagger.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
PranjalChaitanya authored Feb 15, 2024
1 parent 7f21ebb commit 52f3a38
Showing 1 changed file with 16 additions and 40 deletions.
56 changes: 16 additions & 40 deletions docs/swagger.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,23 @@
---
openapi: 3.0.3
info:
title: ACM UIUC Admin API
version: "1.0.0"
version: 1.0.0
contact:
name: ACM Infrastructure Team
email: [email protected]

servers:
- url: adminapi.acm.illinois.edu


paths:
/api/v1/healthz:
get:
summary: Ping the API
operationId: ping

responses:
200:
"200":
description: OK


x-amazon-apigateway-auth:
type: NONE

x-amazon-apigateway-integration:
responses:
default:
Expand All @@ -33,8 +27,7 @@ paths:
contentHandling: CONVERT_TO_TEXT
type: aws_proxy
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations

Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations
/api/v1/create_user:
get:
summary: Creates a user
Expand All @@ -58,15 +51,11 @@ paths:
type: string
required: true
description: perms

responses:
200:
"200":
description: OK


x-amazon-apigateway-auth:
type: NONE

x-amazon-apigateway-integration:
responses:
default:
Expand All @@ -76,8 +65,7 @@ paths:
contentHandling: CONVERT_TO_TEXT
type: aws_proxy
uri:
Fn::Sub: "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations"

Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations
/api/v1/get_user:
get:
summary: Get User
Expand All @@ -89,14 +77,11 @@ paths:
type: string
required: true
description: Users NetID

responses:
200:
"200":
description: OK

x-amazon-apigateway-auth:
type: NONE

x-amazon-apigateway-integration:
responses:
default:
Expand All @@ -106,8 +91,7 @@ paths:
contentHandling: CONVERT_TO_TEXT
type: aws_proxy
uri:
Fn::Sub: "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations"

Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations
/api/v1/delete_user:
get:
summary: Deletes a User
Expand All @@ -119,14 +103,11 @@ paths:
type: string
required: true
description: Users NetID

responses:
200:
"200":
description: OK

x-amazon-apigateway-auth:
type: NONE

x-amazon-apigateway-integration:
responses:
default:
Expand All @@ -136,8 +117,7 @@ paths:
contentHandling: CONVERT_TO_TEXT
type: aws_proxy
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations

Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations
/api/v1/update_user:
get:
summary: updates existing user
Expand All @@ -156,19 +136,16 @@ paths:
required: true
description: updates with new role
- in: query
name: newPerms
schema:
name: newPerms
schema: null
type: string
required: true
description: updates with new permission

required: true
description: updates with new permission
responses:
200:
"200":
description: OK

x-amazon-apigateway-auth:
type: NONE

x-amazon-apigateway-integration:
responses:
default:
Expand All @@ -178,5 +155,4 @@ paths:
contentHandling: CONVERT_TO_TEXT
type: aws_proxy
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations

Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${AdminAPIUserManagementLambda}/invocations

0 comments on commit 52f3a38

Please sign in to comment.