Skip to content

ebisu-flashcards/flashcard-api-client

BranchesTags

Repository files navigation

flashcards-api-client

API Docs for flashcards-server

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.7

Migration from other generators like python and python-legacy

Changes

  1. This generator uses spec case for all (object) property names and parameter names.
    • So if the spec has a property name like camelCase, it will use camelCase rather than camel_case
    • So you will need to update how you input and read properties to use spec case
  2. Endpoint parameters are stored in dictionaries to prevent collisions (explanation below)
    • So you will need to update how you pass data in to endpoints
  3. Endpoint responses now include the original response, the deserialized response body, and (todo)the deserialized headers
    • So you will need to update your code to use response.body to access deserialized data
  4. All validated data is instantiated in an instance that subclasses all validated Schema classes and Decimal/str/list/tuple/frozendict/NoneClass/BoolClass/bytes/io.FileIO
    • This means that you can use isinstance to check if a payload validated against a schema class
    • This means that no data will be of type None/True/False
      • ingested None will subclass NoneClass
      • ingested True will subclass BoolClass
      • ingested False will subclass BoolClass
      • So if you need to check is True/False/None, instead use instance.is_true_oapg()/.is_false_oapg()/.is_none_oapg()
  5. All validated class instances are immutable except for ones based on io.File
    • This is because if properties were changed after validation, that validation would no longer apply
    • So no changing values or property values after a class has been instantiated
  6. String + Number types with formats
    • String type data is stored as a string and if you need to access types based on its format like date, date-time, uuid, number etc then you will need to use accessor functions on the instance
    • type string + format: See .as_date_oapg, .as_datetime_oapg, .as_decimal_oapg, .as_uuid_oapg
    • type number + format: See .as_float_oapg, .as_int_oapg
    • this was done because openapi/json-schema defines constraints. string data may be type string with no format keyword in one schema, and include a format constraint in another schema
    • So if you need to access a string format based type, use as_date_oapg/as_datetime_oapg/as_decimal_oapg/as_uuid_oapg
    • So if you need to access a number format based type, use as_int_oapg/as_float_oapg
  7. Property access on AnyType(type unset) or object(dict) schemas
    • Only required keys with valid python names are properties like .someProp and have type hints
    • All optional keys may not exist, so properties are not defined for them
    • One can access optional values with dict_instance['optionalProp'] and KeyError will be raised if it does not exist
    • Use get_item_oapg if you need a way to always get a value whether or not the key exists
      • If the key does not exist, schemas.unset is returned from calling dict_instance.get_item_oapg('optionalProp')
      • All required and optional keys have type hints for this method, and @typing.overload is used
      • A type hint is also generated for additionalProperties accessed using this method
    • So you will need to update you code to use some_instance['optionalProp'] to access optional property and additionalProperty values
  8. The location of the api classes has changed
    • Api classes are located in your_package.apis.tags.some_api
    • This change was made to eliminate redundant code generation
    • Legacy generators generated the same endpoint twice if it had > 1 tag on it
    • This generator defines an endpoint in one class, then inherits that class to generate apis by tags and by paths
    • This change reduces code and allows quicker run time if you use the path apis
      • path apis are at your_package.apis.paths.some_path
    • Those apis will only load their needed models, which is less to load than all of the resources needed in a tag api
    • So you will need to update your import paths to the api classes

Why are Oapg and _oapg used in class and method names?

Classes can have arbitrarily named properties set on them Endpoints can have arbitrary operationId method names set For those reasons, I use the prefix Oapg and _oapg to greatly reduce the likelihood of collisions on protected + public classes/methods. oapg stands for OpenApi Python Generator.

Object property spec case

This was done because when payloads are ingested, they can be validated against N number of schemas. If the input signature used a different property name then that has mutated the payload. So SchemaA and SchemaB must both see the camelCase spec named variable. Also it is possible to send in two properties, named camelCase and camel_case in the same payload. That use case should be support so spec case is used.

Parameter spec case

Parameters can be included in different locations including:

  • query
  • path
  • header
  • cookie

Any of those parameters could use the same parameter names, so if every parameter was included as an endpoint parameter in a function signature, they would collide. For that reason, each of those inputs have been separated out into separate typed dictionaries:

  • query_params
  • path_params
  • header_params
  • cookie_params

So when updating your code, you will need to pass endpoint parameters in using those dictionaries.

Endpoint responses

Endpoint responses have been enriched to now include more information. Any response reom an endpoint will now include the following properties: response: urllib3.HTTPResponse body: typing.Union[Unset, Schema] headers: typing.Union[Unset, TODO] Note: response header deserialization has not yet been added

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import flashcards_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import flashcards_api_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import flashcards_api_client
from pprint import pprint
from flashcards_api_client.apis.tags import algorithms_api
from flashcards_api_client.model.http_validation_error import HTTPValidationError
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flashcards_api_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2PasswordBearer
configuration = flashcards_api_client.Configuration(
    host = "http://localhost",
    access_token = 'YOUR_ACCESS_TOKEN'
)

# Enter a context with an instance of the API client
with flashcards_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = algorithms_api.AlgorithmsApi(api_client)
    offset = 0 # int |  (optional) (default to CodegenParameter{isFormParam=false, isQueryParam=true, isPathParam=false, isHeaderParam=false, isCookieParam=false, isBodyParam=false, isContainer=false, isCollectionFormatMulti=false, isPrimitiveType=true, isModel=false, isExplode=true, baseName='offset', paramName='offset', dataType='int', datatypeWithEnum='null', dataFormat='null', collectionFormat='null', description='null', unescapedDescription='null', baseType='null', defaultValue='0', enumDefaultValue='null', enumName='null', style='FORM', deepObject='false', allowEmptyValue='false', example='0', jsonSchema='{
  "name" : "offset",
  "in" : "query",
  "required" : false,
  "style" : "form",
  "explode" : true,
  "schema" : {
    "title" : "Offset",
    "type" : "integer",
    "default" : 0
  }
}', isString=false, isNumeric=false, isInteger=true, isShort=false, isLong=false, isUnboundedInteger=true, isNumber=false, isFloat=false, isDouble=false, isDecimal=false, isByteArray=false, isBinary=false, isBoolean=false, isDate=false, isDateTime=false, isUuid=false, isUri=false, isEmail=false, isPassword=false, isFreeFormObject=false, isAnyType=false, isArray=false, isMap=false, isFile=false, isEnum=false, _enum=null, allowableValues=null, items=null, mostInnerItems=null, additionalProperties=null, vars=[], requiredVars=[], vendorExtensions={}, hasValidation=false, maxProperties=null, minProperties=null, isNullable=false, isDeprecated=false, required=false, maximum='null', exclusiveMaximum=false, minimum='null', exclusiveMinimum=false, maxLength=null, minLength=null, pattern='null', maxItems=null, minItems=null, uniqueItems=false, uniqueItemsBoolean=null, contentType=null, multipleOf=null, isNull=false, getAdditionalPropertiesIsAnyType=false, getHasVars=false, getHasRequired=false, getHasDiscriminatorWithNonEmptyMapping=false, composedSchemas=null, hasMultipleTypes=false, schema=CodegenProperty{openApiType='integer', baseName='OffsetSchema', complexType='null', getter='getOffset', setter='setOffset', description='null', dataType='int', datatypeWithEnum='int', dataFormat='null', name='offset', min='null', max='null', defaultValue='0', defaultValueWithParam=' = data.offset;', baseType='int', containerType='null', title='Offset', unescapedDescription='null', maxLength=null, minLength=null, pattern='null', example='0', jsonSchema='{
  "title" : "Offset",
  "type" : "integer",
  "default" : 0
}', minimum='null', maximum='null', exclusiveMinimum=false, exclusiveMaximum=false, required=false, deprecated=false, hasMoreNonReadOnly=false, isPrimitiveType=true, isModel=false, isContainer=false, isString=false, isNumeric=false, isInteger=true, isShort=false, isLong=false, isUnboundedInteger=true, isNumber=false, isFloat=false, isDouble=false, isDecimal=false, isByteArray=false, isBinary=false, isFile=false, isBoolean=false, isDate=false, isDateTime=false, isUuid=false, isUri=false, isEmail=false, isPassword=false, isFreeFormObject=false, isArray=false, isMap=false, isEnum=false, isInnerEnum=false, isEnumRef=false, isAnyType=false, isReadOnly=false, isWriteOnly=false, isNullable=false, isSelfReference=false, isCircularReference=false, isDiscriminator=false, isNew=false, isOverridden=null, _enum=null, allowableValues=null, items=null, additionalProperties=null, vars=[], requiredVars=[], mostInnerItems=null, vendorExtensions={}, hasValidation=false, isInherited=false, discriminatorValue='null', nameInCamelCase='Offset', nameInSnakeCase='null', enumName='null', maxItems=null, minItems=null, maxProperties=null, minProperties=null, uniqueItems=false, uniqueItemsBoolean=null, multipleOf=null, isXmlAttribute=false, xmlPrefix='null', xmlName='null', xmlNamespace='null', isXmlWrapped=false, isNull=false, getAdditionalPropertiesIsAnyType=false, getHasVars=false, getHasRequired=false, getHasDiscriminatorWithNonEmptyMapping=false, composedSchemas=null, hasMultipleTypes=false, requiredVarsMap=null, ref=null, schemaIsFromAdditionalProperties=false, isBooleanSchemaTrue=false, isBooleanSchemaFalse=false, format=null, dependentRequired=null, contains=null}, content=null, requiredVarsMap=null, ref=null, schemaIsFromAdditionalProperties=false})
limit = 100 # int |  (optional) (default to CodegenParameter{isFormParam=false, isQueryParam=true, isPathParam=false, isHeaderParam=false, isCookieParam=false, isBodyParam=false, isContainer=false, isCollectionFormatMulti=false, isPrimitiveType=true, isModel=false, isExplode=true, baseName='limit', paramName='limit', dataType='int', datatypeWithEnum='null', dataFormat='null', collectionFormat='null', description='null', unescapedDescription='null', baseType='null', defaultValue='100', enumDefaultValue='null', enumName='null', style='FORM', deepObject='false', allowEmptyValue='false', example='100', jsonSchema='{
  "name" : "limit",
  "in" : "query",
  "required" : false,
  "style" : "form",
  "explode" : true,
  "schema" : {
    "title" : "Limit",
    "type" : "integer",
    "default" : 100
  }
}', isString=false, isNumeric=false, isInteger=true, isShort=false, isLong=false, isUnboundedInteger=true, isNumber=false, isFloat=false, isDouble=false, isDecimal=false, isByteArray=false, isBinary=false, isBoolean=false, isDate=false, isDateTime=false, isUuid=false, isUri=false, isEmail=false, isPassword=false, isFreeFormObject=false, isAnyType=false, isArray=false, isMap=false, isFile=false, isEnum=false, _enum=null, allowableValues=null, items=null, mostInnerItems=null, additionalProperties=null, vars=[], requiredVars=[], vendorExtensions={}, hasValidation=false, maxProperties=null, minProperties=null, isNullable=false, isDeprecated=false, required=false, maximum='null', exclusiveMaximum=false, minimum='null', exclusiveMinimum=false, maxLength=null, minLength=null, pattern='null', maxItems=null, minItems=null, uniqueItems=false, uniqueItemsBoolean=null, contentType=null, multipleOf=null, isNull=false, getAdditionalPropertiesIsAnyType=false, getHasVars=false, getHasRequired=false, getHasDiscriminatorWithNonEmptyMapping=false, composedSchemas=null, hasMultipleTypes=false, schema=CodegenProperty{openApiType='integer', baseName='LimitSchema', complexType='null', getter='getLimit', setter='setLimit', description='null', dataType='int', datatypeWithEnum='int', dataFormat='null', name='limit', min='null', max='null', defaultValue='100', defaultValueWithParam=' = data.limit;', baseType='int', containerType='null', title='Limit', unescapedDescription='null', maxLength=null, minLength=null, pattern='null', example='100', jsonSchema='{
  "title" : "Limit",
  "type" : "integer",
  "default" : 100
}', minimum='null', maximum='null', exclusiveMinimum=false, exclusiveMaximum=false, required=false, deprecated=false, hasMoreNonReadOnly=false, isPrimitiveType=true, isModel=false, isContainer=false, isString=false, isNumeric=false, isInteger=true, isShort=false, isLong=false, isUnboundedInteger=true, isNumber=false, isFloat=false, isDouble=false, isDecimal=false, isByteArray=false, isBinary=false, isFile=false, isBoolean=false, isDate=false, isDateTime=false, isUuid=false, isUri=false, isEmail=false, isPassword=false, isFreeFormObject=false, isArray=false, isMap=false, isEnum=false, isInnerEnum=false, isEnumRef=false, isAnyType=false, isReadOnly=false, isWriteOnly=false, isNullable=false, isSelfReference=false, isCircularReference=false, isDiscriminator=false, isNew=false, isOverridden=null, _enum=null, allowableValues=null, items=null, additionalProperties=null, vars=[], requiredVars=[], mostInnerItems=null, vendorExtensions={}, hasValidation=false, isInherited=false, discriminatorValue='null', nameInCamelCase='Limit', nameInSnakeCase='null', enumName='null', maxItems=null, minItems=null, maxProperties=null, minProperties=null, uniqueItems=false, uniqueItemsBoolean=null, multipleOf=null, isXmlAttribute=false, xmlPrefix='null', xmlName='null', xmlNamespace='null', isXmlWrapped=false, isNull=false, getAdditionalPropertiesIsAnyType=false, getHasVars=false, getHasRequired=false, getHasDiscriminatorWithNonEmptyMapping=false, composedSchemas=null, hasMultipleTypes=false, requiredVarsMap=null, ref=null, schemaIsFromAdditionalProperties=false, isBooleanSchemaTrue=false, isBooleanSchemaFalse=false, format=null, dependentRequired=null, contains=null}, content=null, requiredVarsMap=null, ref=null, schemaIsFromAdditionalProperties=false})

    try:
        # Get Algorithms
        api_response = api_instance.get_algorithms(offset=offsetlimit=limit)
        pprint(api_response)
    except flashcards_api_client.ApiException as e:
        print("Exception when calling AlgorithmsApi->get_algorithms: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AlgorithmsApi get_algorithms get /algorithms/ Get Algorithms
AuthApi auth_jwt_login post /auth/jwt/login Auth:Jwt.Login
AuthApi auth_jwt_logout post /auth/jwt/logout Auth:Jwt.Logout
AuthApi register_register post /register Register:Register
AuthApi reset_forgot_password post /forgot-password Reset:Forgot Password
AuthApi reset_reset_password post /reset-password Reset:Reset Password
AuthApi verify_request_token post /request-verify-token Verify:Request-Token
AuthApi verify_verify post /verify Verify:Verify
DecksApi add_related_card_to_card put /decks/{deck_id}/cards/{card_id}/related Add Related Card To Card
DecksApi assign_answer_context_to_card put /decks/{deck_id}/cards/{card_id}/context/answer/{fact_id} Assign Answer Context To Card
DecksApi assign_question_context_to_card put /decks/{deck_id}/cards/{card_id}/context/question/{fact_id} Assign Question Context To Card
DecksApi assign_tag_to_card put /decks/{deck_id}/cards/{card_id}/tags/{tag_name} Assign Tag To Card
DecksApi create_card post /decks/{deck_id}/cards Create Card
DecksApi create_deck post /decks/ Create Deck
DecksApi delete_card delete /decks/{deck_id}/cards/{card_id} Delete Card
DecksApi delete_deck delete /decks/{deck_id} Delete Deck
DecksApi edit_card patch /decks/{deck_id}/cards/{card_id} Edit Card
DecksApi edit_deck patch /decks/{deck_id} Edit Deck
DecksApi get_card get /decks/{deck_id}/cards/{card_id} Get Card
DecksApi get_cards get /decks/{deck_id}/cards Get Cards
DecksApi get_deck get /decks/{deck_id} Get Deck
DecksApi get_my_decks get /decks Get My Decks
DecksApi get_reviews get /decks/{deck_id}/cards/{card_id}/reviews Get Reviews
DecksApi remove_answer_context_from_card delete /decks/{deck_id}/cards/{card_id}/context/answer/{fact_id} Remove Answer Context From Card
DecksApi remove_question_context_from_card delete /decks/{deck_id}/cards/{card_id}/context/question/{fact_id} Remove Question Context From Card
DecksApi remove_related_card delete /decks/{deck_id}/cards/{card_id}/related Remove Related Card
DecksApi remove_tag_from_card delete /decks/{deck_id}/cards/{card_id}/tags/{tag_name} Remove Tag From Card
DefaultApi root get / Root
FactsApi assign_related_fact put /facts/{fact_id}/related/ Assign Related Fact
FactsApi assign_tag_to_fact put /facts/{fact_id}/tags/{tag_name} Assign Tag To Fact
FactsApi create_fact post /facts/ Create Fact
FactsApi delete_fact delete /facts/{fact_id} Delete Fact
FactsApi edit_fact patch /facts/{fact_id} Edit Fact
FactsApi get_fact get /facts/{fact_id} Get Fact
FactsApi get_facts get /facts/ Get Facts
FactsApi get_facts_by_tag get /facts/tag/{tag_name} Get Facts By Tag
FactsApi remove_related_fact delete /facts/{fact_id}/related/ Remove Related Fact
FactsApi remove_tag_from_fact delete /facts/{fact_id}/tags/{tag_name} Remove Tag From Fact
StudyApi first_card get /study/{deck_id}/start First Card
StudyApi next_card post /study/{deck_id}/next Next Card
TagsApi create_tag post /tags/ Create Tag
TagsApi delete_tag delete /tags/{tag_id} Delete Tag
TagsApi edit_tag patch /tags/{tag_id} Edit Tag
TagsApi get_tag get /tags/{tag_id} Get Tag
TagsApi get_tags get /tags/ Get Tags
UsersApi users_current_user get /users/me Users:Current User
UsersApi users_delete_user delete /users/{id} Users:Delete User
UsersApi users_patch_current_user patch /users/me Users:Patch Current User
UsersApi users_patch_user patch /users/{id} Users:Patch User
UsersApi users_user get /users/{id} Users:User

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in flashcards_api_client.apis and flashcards_api_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from flashcards_api_client.apis.default_api import DefaultApi
  • from flashcards_api_client.model.pet import Pet

Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import flashcards_api_client
from flashcards_api_client.apis import *
from flashcards_api_client.models import *

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages