2 Star 1 Fork 0

OrhonTeam/edx-enterprise

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
api.yaml 21.86 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695
# This file is a "de-compacted" version of api-compact.yaml. The consuming tools are unable to process YAML anchors.
# This file was generated using http://www.yamllint.com/.
---
apigateway_responses:
200:
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
apigateway_responses_with_mapping_template_for_id:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($id = $input.params('id'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceIdMatch = "{id}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
apigateway_responses_with_mapping_template_for_uuid:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($uuid = $input.params('uuid'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceUuidMatch = "{uuid}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
auth_header:
in: header
name: Authorization
required: true
type: string
endpoints:
v1:
enterpriseCatalogById:
get:
operationId: get_enterprise_catalog_by_id
parameters:
-
in: header
name: Authorization
required: true
type: string
-
in: path
name: id
required: true
type: number
produces:
- application/json
- application/csv
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:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.id: method.request.path.id
responses:
200:
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
uri: "https://${stageVariables.enterprise_host}/enterprise/api/v1/catalogs/{id}/"
enterpriseCatalogCourses:
get:
operationId: get_enterprise_catalog_courses
parameters:
-
in: header
name: Authorization
required: true
type: string
-
in: path
name: id
required: true
type: number
-
in: query
name: limit
required: false
type: number
-
in: query
name: offset
required: false
type: number
-
in: query
name: page
required: false
type: number
-
in: query
name: page_size
required: false
type: number
produces:
- application/json
- application/csv
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:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.id: method.request.path.id
integration.request.querystring.limit: method.request.querystring.limit
integration.request.querystring.offset: method.request.querystring.offset
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($id = $input.params('id'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceIdMatch = "{id}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
uri: "https://${stageVariables.enterprise_host}/enterprise/api/v1/catalogs/{id}/courses/"
enterpriseCatalogs:
get:
operationId: get_enterprise_catalogs
parameters:
-
in: header
name: Authorization
required: true
type: string
-
in: query
name: limit
required: false
type: number
-
in: query
name: offset
required: false
type: number
-
in: query
name: page
required: false
type: number
-
in: query
name: page_size
required: false
type: number
produces:
- application/json
- application/csv
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:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.querystring.limit: method.request.querystring.limit
integration.request.querystring.offset: method.request.querystring.offset
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($id = $input.params('id'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceIdMatch = "{id}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
uri: "https://${stageVariables.enterprise_host}/enterprise/api/v1/catalogs/"
enterpriseCustomerCatalogByUuid:
get:
operationId: get_enterprise_customer_catalog_by_uuid
parameters:
-
in: header
name: Authorization
required: true
type: string
-
in: query
name: page
required: false
type: number
-
in: query
name: page_size
required: false
type: number
-
in: path
name: uuid
required: true
type: string
produces:
- application/json
- application/csv
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:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.uuid: method.request.path.uuid
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
uri: "https://${stageVariables.enterprise_host}/enterprise/api/v1/enterprise-catalogs/{uuid}/"
enterpriseCustomerCatalogs:
get:
operationId: get_enterprise_customer_catalogs
parameters:
-
in: header
name: Authorization
required: true
type: string
-
in: query
name: page
required: false
type: number
-
in: query
name: page_size
required: false
type: number
produces:
- application/json
- application/csv
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:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($uuid = $input.params('uuid'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceUuidMatch = "{uuid}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
uri: "https://${stageVariables.enterprise_host}/enterprise/api/v1/enterprise-catalogs/"
programByUuid:
get:
operationId: get_program_by_uuid
parameters:
-
in: header
name: Authorization
required: true
type: string
-
in: query
name: page
required: false
type: number
-
in: query
name: page_size
required: false
type: number
-
in: path
name: uuid
required: true
type: string
produces:
- application/json
- application/csv
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:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.uuid: method.request.path.uuid
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
uri: "https://${stageVariables.enterprise_host}/enterprise/api/v1/programs/{uuid}/"
id_parameter:
in: path
name: id
required: true
type: number
limit_qs_parameter:
in: query
name: limit
required: false
type: number
offset_qs_parameter:
in: query
name: offset
required: false
type: number
page_qs_parameter:
in: query
name: page
required: false
type: number
page_size_qs_parameter:
in: query
name: page_size
required: false
type: number
produces:
- application/json
- application/csv
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"
uuid_parameter:
in: path
name: uuid
required: true
type: string
x-amazon-apigateway-integration-id-response:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.querystring.limit: method.request.querystring.limit
integration.request.querystring.offset: method.request.querystring.offset
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($id = $input.params('id'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceIdMatch = "{id}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
x-amazon-apigateway-integration-uuid-response:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($uuid = $input.params('uuid'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceUuidMatch = "{uuid}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
x-amazon-apigateway-integration-with-id:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.id: method.request.path.id
responses:
200:
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
x-amazon-apigateway-integration-with-id-and-querystring-parameters:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.id: method.request.path.id
integration.request.querystring.limit: method.request.querystring.limit
integration.request.querystring.offset: method.request.querystring.offset
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
responseTemplates:
application/json: |
#set($inputRoot = $input.path('$')) #set($host = $stageVariables.gateway_host) #set($id = $input.params('id'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceIdMatch = "{id}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceIdMatch, $id)",
"results": $inputRoot.results
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
x-amazon-apigateway-integration-with-uuid:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.uuid: method.request.path.uuid
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
200:
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/orhonteam/edx-enterprise.git
git@gitee.com:orhonteam/edx-enterprise.git
orhonteam
edx-enterprise
edx-enterprise
master

搜索帮助