Skip to content

Commit

Permalink
Initial commit for gerrit
Browse files Browse the repository at this point in the history 
Change-Id: If73906bf41ed18bb709309becdf88d22f92ad7e1
  • Loading branch information
Duane Johnson committed Feb 14, 2014
0 parents commit 97b696b
Show file tree
Hide file tree
Showing 158 changed files with 49,115 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@
.git-old
.DS_Store
clients/ruby/pandarus*.gem
target/
330 changes: 330 additions & 0 deletions api/account_authentication_services.json

Large diffs are not rendered by default.

327 changes: 327 additions & 0 deletions api/account_reports.json
@@ -0,0 +1,327 @@
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "http://canvas.instructure.com/api",
"resourcePath": "/account reports",
"produces": [
"application/json"
],
"apis": [
{
"path": "/v1/accounts/{account_id}/reports",
"description": "Returns the list of reports for the current context.",
"operations": [
{
"method": "GET",
"summary": "List Available Reports",
"notes": "Returns the list of reports for the current context.",
"nickname": "list_available_reports",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "void"
}
]
},
{
"path": "/v1/accounts/{account_id}/reports/{report}",
"description": "Generates a report instance for the account.",
"operations": [
{
"method": "POST",
"summary": "Start a Report",
"notes": "Generates a report instance for the account.",
"nickname": "start_report",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "report",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "[parameters]",
"description": "The parameters will vary for each report",
"type": "string",
"format": null,
"required": true
}
],
"type": "Report"
}
]
},
{
"path": "/v1/accounts/{account_id}/reports/{report}",
"description": "Shows all reports that have been run for the account of a specific type.",
"operations": [
{
"method": "GET",
"summary": "Index of Reports",
"notes": "Shows all reports that have been run for the account of a specific type.",
"nickname": "index_of_reports",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "report",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "array",
"items": {
"$ref": "Report"
}
}
]
},
{
"path": "/v1/accounts/{account_id}/reports/{report}/{id}",
"description": "Returns the status of a report.",
"operations": [
{
"method": "GET",
"summary": "Status of a Report",
"notes": "Returns the status of a report.",
"nickname": "status_of_report",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "report",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "report_id",
"description": "The report id.",
"type": "integer",
"format": "int64",
"required": true
}
],
"type": "Report"
}
]
},
{
"path": "/v1/accounts/{account_id}/reports/{report}/{id}",
"description": "Deletes a generated report instance.",
"operations": [
{
"method": "DELETE",
"summary": "Delete a Report",
"notes": "Deletes a generated report instance.",
"nickname": "delete_report",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "report",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "Report"
}
]
}
],
"models": {
"Report": {
"id": "Report",
"description": "",
"required": [

],
"properties": {
"id": {
"description": "The unique identifier for the report.",
"example": "1",
"type": "integer"
},
"report": {
"description": "The type of report.",
"example": "sis_export_csv",
"type": "string"
},
"file_url": {
"description": "The url to the report download.",
"example": "https://example.com/some/path",
"type": "string"
},
"status": {
"description": "The status of the report",
"example": "complete",
"type": "string"
},
"parameters": {
"description": "The report parameters",
"$ref": "ReportParameters"
},
"progress": {
"description": "The progress of the report",
"example": "100",
"type": "string"
}
}
},
"ReportParameters": {
"id": "ReportParameters",
"description": "The parameters returned will vary for each report.",
"required": [

],
"properties": {
"enrollment_term_id": {
"description": "The canvas id of the term to get grades from",
"example": 2,
"type": "integer"
},
"include_deleted": {
"description": "Include deleted objects",
"example": false,
"type": "boolean"
},
"course_id": {
"description": "The course to report on",
"example": 2,
"type": "integer"
},
"order": {
"description": "The sort order for the csv, Options: 'users', 'courses', 'outcomes'.",
"example": "users",
"type": "string",
"allowableValues": {
"values": [
"users",
"courses",
"outcomes"
]
}
},
"users": {
"description": "Get the data for users",
"example": false,
"type": "boolean"
},
"accounts": {
"description": "Get the data for accounts",
"example": false,
"type": "boolean"
},
"terms": {
"description": "Get the data for terms",
"example": false,
"type": "boolean"
},
"courses": {
"description": "Get the data for courses",
"example": false,
"type": "boolean"
},
"sections": {
"description": "Get the data for sections",
"example": false,
"type": "boolean"
},
"enrollments": {
"description": "Get the data for enrollments",
"example": false,
"type": "boolean"
},
"groups": {
"description": "Get the data for groups",
"example": false,
"type": "boolean"
},
"xlist": {
"description": "Get the data for cross-listed courses",
"example": false,
"type": "boolean"
},
"start_at": {
"description": "The beginning date for submissions. Max time range is 2 weeks.",
"example": "2012-07-13T10:55:20-06:00",
"type": "datetime"
},
"end_at": {
"description": "The end date for submissions. Max time range is 2 weeks.",
"example": "2012-07-13T10:55:20-06:00",
"type": "datetime"
},
"sis_terms_csv": {
"example": 1,
"type": "integer"
},
"sis_accounts_csv": {
"example": 1,
"type": "integer"
}
}
}
}
}

0 comments on commit 97b696b

Please sign in to comment.