Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
C
course-discovery
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
course-discovery
Commits
71812e34
Commit
71812e34
authored
Mar 18, 2016
by
Clinton Blackburn
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added YAML configuration for API Gateway
ECOM-3862
parent
5bc5bb59
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
204 additions
and
0 deletions
+204
-0
api-compact.yaml
+96
-0
api.yaml
+108
-0
No files found.
api-compact.yaml
0 → 100644
View file @
71812e34
# Discovery 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.
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"
produces
:
&produces
-
"
application/json"
-
"
application/csv"
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"
id_parameter
:
&id_parameter
name
:
"
id"
in
:
"
path"
required
:
true
type
:
"
number"
auth_header
:
&auth_header
name
:
"
Authorization"
in
:
"
header"
required
:
true
type
:
"
string"
# AWS API Gateway vendor extension point. This information is used
# by https://github.com/awslabs/aws-apigateway-importer.
x-amazon-apigateway-integration
:
&apigateway_integration
responses
:
*apigateway_responses
httpMethod
:
"
GET"
type
:
"
http"
requestParameters
:
integration.request.header.Authorization
:
"
method.request.header.Authorization"
x-amazon-apigateway-integration-with-id
:
&apigateway_integration_with_id_parameter
responses
:
*apigateway_responses
httpMethod
:
"
GET"
type
:
"
http"
requestParameters
:
integration.request.header.Authorization
:
"
method.request.header.Authorization"
integration.request.path.id
:
"
method.request.path.id"
endpoints
:
v1
:
# /v1/catalogs
catalogs
:
get
:
produces
:
*produces
parameters
:
-
*auth_header
operationId
:
"
get_catalogs"
responses
:
*responses
x-amazon-apigateway-integration
:
<<
:
*apigateway_integration
uri
:
"
https://${stageVariables.discovery_host}/v1/catalogs/"
# /v1/catalogs/{id}
catalogsById
:
get
:
produces
:
*produces
parameters
:
-
*auth_header
-
*id_parameter
operationId
:
"
get_catalogs_by_id"
responses
:
*responses
x-amazon-apigateway-integration
:
<<
:
*apigateway_integration_with_id_parameter
uri
:
"
https://${stageVariables.discovery_host}/v1/catalogs/{id}/"
api.yaml
0 → 100644
View file @
71812e34
# 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/.
---
endpoints
:
v1
:
catalogs
:
get
:
operationId
:
get_catalogs
parameters
:
-
in
:
header
name
:
Authorization
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
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.discovery_host}/v1/catalogs/"
catalogsById
:
get
:
operationId
:
get_catalogs_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.discovery_host}/v1/catalogs/{id}/"
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment