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.

Sign up for GitHub

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

feat: add api-compact.yml and api.yaml #544

Merged
merged 4 commits into from
Dec 14, 2023
Merged

feat: add api-compact.yml and api.yaml #544

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c4e3eb5
feat: add api-compact.yml
hamzawaleed01 Dec 10, 2023
ecd79e7
feat: add api.yaml and fix api-compact.yaml
hamzawaleed01 Dec 12, 2023
820c740
feat: update yaml files
hamzawaleed01 Dec 13, 2023
8ca198b
feat: update yaml files
hamzawaleed01 Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 108 additions & 0 deletions api-compact.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# License Manager IDA: upstream API definitions, including vendor extensions.
# Note, while this document is not strictly to Swagger spec, each HTTP method's
# definition _must_ be to spec or the downstream ref will fail.
#
# Clients must include an Authorization header with OAuth2 access token in order to communicate:
# Authorization: JWT {access_token}
#
#
# Available service endpoints -- note that alternate endpoints may be presented at the API Gateway tier
# POST /api/v1/subscriptions/{subscription_plan_uuid}/licenses/assign/

apigateway_responses: &apigateway_responses
default:
statusCode: "400"
200:
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"

responses: &responses
200:
description: "OK"
400:
description: "Bad Request"
401:
description: "Unauthorized"
403:
description: "Forbidden"
404:
description: "Not Found"
429:
description: "Too Many Requests"
500:
description: "Internal Server Error"

sameenfatima78 marked this conversation as resolved.
Show resolved Hide resolved
sameenfatima78 marked this conversation as resolved.
Show resolved Hide resolved
subscription_plan_uuid: &subscription_plan_uuid
sameenfatima78 marked this conversation as resolved.
Show resolved Hide resolved
name: "subscription_plan_uuid"
in: "path"
required: true
type: "string"

auth_header: &auth_header
name: "Authorization"
in: "header"
required: true
type: "string"

endpoints:
v1:

# /v1/subscriptions/{subscription_plan_uuid}/licenses/assign/
assignLicenses:
post:
description: "Assigns a license to given user emails and sends an activation email."
operationId: "assign_licenses"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- *auth_header
- *subscription_plan_uuid
- name: "body"
in: "body"
description: "List of emails to assign licenses."
required: true
schema:
type: "array"
items:
type: "object"
properties:
user_emails:
description: "List of emails to assign licenses."
type: "array"
required: true
user_sfids:
description: "List of salesforce user ids to assign licenses."
type: "array"
required: true
greeting:
description: "Email template closing e.g Hello."
type: "string"
required: true
closing:
description: "Email template closing e.g Goodbye."
type: "string"
required: true
notify_users:
description: "Send license assignment email or not."
type: "boolean"
required: true
responses: *responses
x-amazon-apigateway-integration:
responses: *apigateway_responses
httpMethod: "POST"
type: "http"
requestParameters:
integration.request.header.Authorization: "method.request.header.Authorization"
integration.request.path.subscription_plan_uuid: "method.request.path.subscription_plan_uuid"
uri: "https://${stageVariables.license_manager_host}/v1/subscriptions/{subscription_plan_uuid}/licenses/assign/"
126 changes: 126 additions & 0 deletions api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
hamzawaleed01 marked this conversation as resolved.
Show resolved Hide resolved
apigateway_responses:
"200":
statusCode: "200"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
responses:
"200":
description: OK
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
subscription_plan_uuid:
name: subscription_plan_uuid
in: path
required: true
type: string
auth_header:
name: Authorization
in: header
required: true
type: string
endpoints:
sameenfatima78 marked this conversation as resolved.
Show resolved Hide resolved
v1:
assignLicenses:
post:
description: Assigns a license to given user emails and sends an activation email.
operationId: assign_licenses
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: subscription_plan_uuid
in: path
required: true
type: string
- name: body
in: body
description: List of emails to assign licenses.
required: true
schema:
type: array
items:
type: object
properties:
user_emails:
description: List of emails to assign licenses.
type: array
required: true
user_sfids:
description: List of salesforce user ids to assign licenses.
type: array
required: true
greeting:
description: Email template closing e.g Hello.
type: string
required: true
closing:
description: Email template closing e.g Goodbye.
type: string
required: true
notify_users:
description: Send license assignment email or not.
type: boolean
required: true
responses:
"200":
description: OK
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
httpMethod: POST
type: http
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.subscription_plan_uuid: method.request.path.subscription_plan_uuid
uri: https://${stageVariables.license_manager_host}/v1/subscriptions/{subscription_plan_uuid}/licenses/assign/
Loading