spec: Update schema definitions for recent changes
Specifically: - the registration_token is now added to the oidc_configuration_url as a query parameter - added privacy_level and registration_config_url when creating a registration - the client_id is not just the local ID anymore, now has the shard test plan: - none flag = lti_dynamic_registration Change-Id: Ia4b70303b47a93faf5614449a636cadbeccc0acf Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/339417 Reviewed-by: Ryan Hawkins <ryan.hawkins@instructure.com> QA-Review: Tucker Mcknight <tmcknight@instructure.com> Product-Review: Tucker Mcknight <tmcknight@instructure.com> Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
This commit is contained in:
Tucker McKnight
Tucker Mcknight
parent
9125e810d5
commit
2bbaf9af64
|
|
@ -29,6 +29,6 @@ paths:
|
|||
- oidc_configuration_url
|
||||
- token
|
||||
example:
|
||||
uuid: 0d3f7978-8635-44dd-aec1-8a63f7520c8f
|
||||
oidc_configuration_url: https://canvas.instructure.com/api/lti/security/openid-configuration
|
||||
token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1dWlkIjoiMGQzZjc5NzgtODYzNS00NGRkLWFlYzEtOGE2M2Y3NTIwYzhmIiwiaW5pdGlhdGVkX2F0IjoiMjAyMy0xMi0zMVQwNDo1MTo1NyswMDowMCIsInVzZXJfaWQiOjE4NDksInJvb3RfYWNjb3VudF9nbG9iYWxfaWQiOjIwMDAwMDAwMDAwMzA3MywiZXhwIjoxNzA0MDAxOTE3fQ.Q_JjbjAYQZTkacPq64y2qa3PqCCrQhTEKp25RAyNy34
|
||||
uuid: a98d2e39-b22d-45f8-9479-ac1f7546363d
|
||||
oidc_configuration_url: https://canvas.instructure.com/api/lti/security/openid-configuration?registration_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1dWlkIjoiYTk4ZDJlMzktYjIyZC00NWY4LTk0NzktYWMxZjc1NDYzNjNkIiwiaW5pdGlhdGVkX2F0IjoiMjAyNC0wMS0zMVQyMzoxNzowOSswMDowMCIsInVzZXJfaWQiOjE5MjAsInJvb3RfYWNjb3VudF9nbG9iYWxfaWQiOjIwMDAwMDAwMDAwMzE5MiwiZXhwIjoxNzA2NzQ2NjI5fQ.O4e4sWZWX1SEP-8n4jLxxmUbrOskgUa87OuRz6_hrdw
|
||||
token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1dWlkIjoiYTk4ZDJlMzktYjIyZC00NWY4LTk0NzktYWMxZjc1NDYzNjNkIiwiaW5pdGlhdGVkX2F0IjoiMjAyNC0wMS0zMVQyMzoxNzowOSswMDowMCIsInVzZXJfaWQiOjE5MjAsInJvb3RfYWNjb3VudF9nbG9iYWxfaWQiOjIwMDAwMDAwMDAwMzE5MiwiZXhwIjoxNzA2NzQ2NjI5fQ.O4e4sWZWX1SEP-8n4jLxxmUbrOskgUa87OuRz6_hrdw
|
||||
|
|
|
|||
|
|
@ -11,33 +11,8 @@ paths:
|
|||
tags:
|
||||
- Lti::IMS::DynamicRegistration
|
||||
responses:
|
||||
'401':
|
||||
description: returns a 401
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
error_code:
|
||||
type: string
|
||||
required:
|
||||
- message
|
||||
- error_code
|
||||
required:
|
||||
- errors
|
||||
example:
|
||||
errors:
|
||||
- message: An error occurred.
|
||||
error_code: unauthorized
|
||||
'200':
|
||||
description: fills in values on the developer key
|
||||
description: accepts valid params and creates a registration model
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
|
@ -116,6 +91,10 @@ paths:
|
|||
type: string
|
||||
target_link_uri:
|
||||
type: string
|
||||
https://canvas.instructure.com/lti/privacy_level:
|
||||
type: string
|
||||
https://canvas.instructure.com/lti/registration_config_url:
|
||||
type: string
|
||||
required:
|
||||
- domain
|
||||
- messages
|
||||
|
|
@ -134,7 +113,7 @@ paths:
|
|||
- scope
|
||||
- https://purl.imsglobal.org/spec/lti-tool-configuration
|
||||
example:
|
||||
client_id: '941'
|
||||
client_id: '200000000000981'
|
||||
application_type: web
|
||||
grant_types:
|
||||
- client_credentials
|
||||
|
|
@ -167,6 +146,33 @@ paths:
|
|||
- iss
|
||||
- sub
|
||||
target_link_uri: https://example.com/launch
|
||||
https://canvas.instructure.com/lti/privacy_level: email_only
|
||||
https://canvas.instructure.com/lti/registration_config_url: http://test.host/api/lti/registrations/200000000000168/view
|
||||
'401':
|
||||
description: returns a 401
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
error_code:
|
||||
type: string
|
||||
required:
|
||||
- message
|
||||
- error_code
|
||||
required:
|
||||
- errors
|
||||
example:
|
||||
errors:
|
||||
- message: An error occurred.
|
||||
error_code: unauthorized
|
||||
'422':
|
||||
description: returns a 422 with validation errors
|
||||
content:
|
||||
|
|
@ -257,6 +263,8 @@ paths:
|
|||
- icon_uri
|
||||
target_link_uri:
|
||||
type: string
|
||||
https://canvas.instructure.com/lti/privacy_level:
|
||||
type: string
|
||||
required:
|
||||
- claims
|
||||
- domain
|
||||
|
|
@ -288,7 +296,6 @@ paths:
|
|||
- initiate_login_uri
|
||||
- jwks_uri
|
||||
- redirect_uris
|
||||
- registration_token
|
||||
- response_types
|
||||
- scope
|
||||
- token_endpoint_auth_method
|
||||
|
|
@ -316,6 +323,7 @@ paths:
|
|||
- http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor
|
||||
icon_uri: https://example.com/icon.jpg
|
||||
target_link_uri: https://example.com/launch
|
||||
https://canvas.instructure.com/lti/privacy_level: email_only
|
||||
initiate_login_uri: https://example.com/login
|
||||
jwks_uri: https://example.com/api/jwks
|
||||
redirect_uris:
|
||||
|
|
|
|||
Loading…
Reference in New Issue