mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-06-03 07:20:51 +00:00
* start implementation of HTTP signature * add api key parameters for http message signature * HTTP signature authentication * start implementation of HTTP signature * add api key parameters for http message signature * HTTP signature authentication * HTTP signature authentication * start implementation of HTTP signature * fix merge issues * Address formatting issues * Address formatting issues * move python-experimental-openapiv3-sample to a separate PR * Add support for HTTP signature * Add code comments * Add code comments * Fix formatting issues * Fix formatting issues * Fix formatting issues * add code comments * add code comments * fix python formatting issues * Make PKCS1v15 string constant consistent between Python and Golang * fix python formatting issues * Add code comments in generated Python. Start adding unit tests for HTTP signature * compliance with HTTP signature draft 12 * compliance with HTTP signature draft 12 * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * fix python formatting issues * fix trailing white space * address PR comments * address PR comments * address PR comments * Add suppport for '(expires)' signature parameter * address PR comments * address PR comments * Fix python formatting issues * Fix python formatting issues * Starting to move code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * move method to ProcessUtils * conditionally build signing.py * move method to ProcessUtils * Code reformatting * externalize http signature configuration * address PR review comments * address PR review comments * run samples scripts * Address PR review comments * Move 'private_key' field to signing module * Move 'private_key' field to signing module * code cleanup * remove use of strftime('%s'), which is non portable * code cleanup * code cleanup * code cleanup * run sample scripts * Address PR review comments. * Add http-signature security scheme * Run sample scripts for go * Fix issue uncovered in integration branch * Fix issue uncovered in integration branch * Fix issue uncovered in integration branch * Fix issue uncovered in integration branch * Run samples scripts * move http signature tests to separate file * move http signature tests to separate file * unit tests for HTTP signature * continue implementation of unit tests * add http_signature_test to security scheme * add unit tests for http signature * address review comments * remove http signature from petapi * Add separate OAS file with support for HTTP signature * Add support for private key passphrase. Add more unit tests * Add unit test to validate the signature against the public key * remove http signature from petstore-with-fake-endpoints-models-for-testing.yaml * fix unit test issues * run scripts in bin directory * Refact unit test with better variable names * do not throw exception if security scheme is unrecognized * change URL of apache license to use https * sync from master * fix usage of escape character in python regex. Fix generated python documentation * write HTTP signed headers in user-specified order. Fix PEP8 formatting issues * write HTTP signed headers in user-specified order. Fix PEP8 formatting issues * http signature unit tests * Fix PEP8 format issue * spread out each requirement to a separate line * run samples scripts * run sample scripts * remove encoding of '+' character
petstore-api
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
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 petstore_api
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 petstore_api
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Create an instance of the API class
api_instance = petstore_api.AnotherFakeApi(petstore_api.ApiClient(configuration))
body = petstore_api.Client() # Client | client model
try:
# To test special tags
api_response = api_instance.call_123_test_special_tags(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnotherFakeApi->call_123_test_special_tags: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://petstore.swagger.io:80/v2
Class | Method | HTTP request | Description |
---|---|---|---|
AnotherFakeApi | call_123_test_special_tags | PATCH /another-fake/dummy | To test special tags |
FakeApi | create_xml_item | POST /fake/create_xml_item | creates an XmlItem |
FakeApi | fake_outer_boolean_serialize | POST /fake/outer/boolean | |
FakeApi | fake_outer_composite_serialize | POST /fake/outer/composite | |
FakeApi | fake_outer_number_serialize | POST /fake/outer/number | |
FakeApi | fake_outer_string_serialize | POST /fake/outer/string | |
FakeApi | test_body_with_file_schema | PUT /fake/body-with-file-schema | |
FakeApi | test_body_with_query_params | PUT /fake/body-with-query-params | |
FakeApi | test_client_model | PATCH /fake | To test "client" model |
FakeApi | test_endpoint_parameters | POST /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 |
FakeApi | test_enum_parameters | GET /fake | To test enum parameters |
FakeApi | test_group_parameters | DELETE /fake | Fake endpoint to test group parameters (optional) |
FakeApi | test_inline_additional_properties | POST /fake/inline-additionalProperties | test inline additionalProperties |
FakeApi | test_json_form_data | GET /fake/jsonFormData | test json serialization of form data |
FakeApi | test_query_parameter_collection_format | PUT /fake/test-query-paramters | |
FakeClassnameTags123Api | test_classname | PATCH /fake_classname_test | To test class name in snake case |
PetApi | add_pet | POST /pet | Add a new pet to the store |
PetApi | delete_pet | DELETE /pet/{petId} | Deletes a pet |
PetApi | find_pets_by_status | GET /pet/findByStatus | Finds Pets by status |
PetApi | find_pets_by_tags | GET /pet/findByTags | Finds Pets by tags |
PetApi | get_pet_by_id | GET /pet/{petId} | Find pet by ID |
PetApi | update_pet | PUT /pet | Update an existing pet |
PetApi | update_pet_with_form | POST /pet/{petId} | Updates a pet in the store with form data |
PetApi | upload_file | POST /pet/{petId}/uploadImage | uploads an image |
PetApi | upload_file_with_required_file | POST /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
StoreApi | delete_order | DELETE /store/order/{order_id} | Delete purchase order by ID |
StoreApi | get_inventory | GET /store/inventory | Returns pet inventories by status |
StoreApi | get_order_by_id | GET /store/order/{order_id} | Find purchase order by ID |
StoreApi | place_order | POST /store/order | Place an order for a pet |
UserApi | create_user | POST /user | Create user |
UserApi | create_users_with_array_input | POST /user/createWithArray | Creates list of users with given input array |
UserApi | create_users_with_list_input | POST /user/createWithList | Creates list of users with given input array |
UserApi | delete_user | DELETE /user/{username} | Delete user |
UserApi | get_user_by_name | GET /user/{username} | Get user by user name |
UserApi | login_user | GET /user/login | Logs user into the system |
UserApi | logout_user | GET /user/logout | Logs out current logged in user session |
UserApi | update_user | PUT /user/{username} | Updated user |
Documentation For Models
- AdditionalPropertiesAnyType
- AdditionalPropertiesArray
- AdditionalPropertiesBoolean
- AdditionalPropertiesClass
- AdditionalPropertiesInteger
- AdditionalPropertiesNumber
- AdditionalPropertiesObject
- AdditionalPropertiesString
- Animal
- ApiResponse
- ArrayOfArrayOfNumberOnly
- ArrayOfNumberOnly
- ArrayTest
- BigCat
- BigCatAllOf
- Capitalization
- Cat
- CatAllOf
- Category
- ClassModel
- Client
- Dog
- DogAllOf
- EnumArrays
- EnumClass
- EnumTest
- File
- FileSchemaTestClass
- FormatTest
- HasOnlyReadOnly
- List
- MapTest
- MixedPropertiesAndAdditionalPropertiesClass
- Model200Response
- ModelReturn
- Name
- NumberOnly
- Order
- OuterComposite
- OuterEnum
- Pet
- ReadOnlyFirst
- SpecialModelName
- Tag
- TypeHolderDefault
- TypeHolderExample
- User
- XmlItem
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
api_key_query
- Type: API key
- API key parameter name: api_key_query
- Location: URL query string
http_basic_test
- Type: HTTP basic authentication
petstore_auth
- Type: OAuth
- Flow: implicit
- Authorization URL: http://petstore.swagger.io/api/oauth/dialog
- Scopes:
- write:pets: modify pets in your account
- read:pets: read your pets