schul-cloud-ressources-api-v1 1.0.0-48

Authentication

There are these options for authentication:

• no authentication: this is the default and nothing needs to be done.

• basic authentication: authentication with user name and password

• api_key authentication: a key is supplied to authorize the requests.

The authentication is a global state. All ApiClients use this global state. Thus, you can only authenticate at one API at a time.

import schul_cloud_ressources_api_v1.auth as auth

You can remove all authentication. This is the default case.

auth.none()

You can authenticate with username and password. This is Basic Authentication <https://en.wikipedia.org/wiki/Basic_access_authentication>.

auth.basic("username", "password")

You can authenticate with an api key.

auth.api_key("your-api-key")

Verifying Ressources

When you use ressources, you may want to verify if they have the correct format. The format is specified in the ressource-schema. This schema is included in the api.

from schul_cloud_ressources_api_v1.schema import (
    get_valid_examples, get_invalid_examples, validate_ressource, is_valid_ressource
)

You can test if a ressource is valid or not using is_valid_ressource

valid_ressource = get_valid_examples()[0]
assert is_valid_ressource(valid_ressource)

invalid_ressource = get_invalid_examples()[0]
assert not is_valid_ressource(invalid_ressource)

If you would like to find out more about why the ressource is not valid, you can use validate_ressource.

validate_ressource({'title': 'hello'})

Which results in an error that the url property is not present but is required.

jsonschema.exceptions.ValidationError: 'url' is a required property

Failed validating 'required' in schema:
    {'properties': {'contentCategory': {'$ref': '#/definitions/ContentCategory'},
                    'contextUrl': {'$ref': '#/definitions/URL'},
                    'curricula': {'items': {'$ref': '../curriculum/curriculum.json'},
                                  'type': 'array'},
                    'dimensions': {'$ref': '#/definitions/Dimensions'},
                    'duration': {'type': 'number'},
                    'languages': {'description': 'As described in IEEE '
                                                 'LOM, Section 1.3 '
                                                 'http://129.115.100.158/txlor/docs/IEEE_LOM_1484_12_1_v1_Final_Draft.pdf',
                                  'items': {'$ref': '#/definitions/Language'},
                                  'type': 'array'},
                    'licenses': {'items': {'$ref': '../license/license.json'},
                                 'type': 'array'},
                    'mimeType': {'description': 'https://tools.ietf.org/html/rfc2046',
                                 'example': 'text/html',
                                 'type': 'string'},
                    'size': {'format': 'int64', 'type': 'integer'},
                    'thumbnail': {'$ref': '#/definitions/URL'},
                    'title': {'description': 'The title of the ressource.',
                              'example': 'Schul-Cloud',
                              'type': 'string'},
                    'url': {'$ref': '#/definitions/URL'}},
     'required': ['title',
                  'url',
                  'licenses',
                  'mimeType',
                  'contentCategory',
                  'languages'],
     'type': 'object'}

On instance:
    {'title': 'hello'}