Stefan Pratter
2e8788b595
* Allow REALPEER to overwrite GHOSTPEER netixlan entry, if asn and IPv6/v4 addresses matches the IX-F Members Export information #983 * Lightweight user notification mechanism #758 * do not allow affiliation with a deleted organisation #953 * Improve readability when users have special permissions #659 * fix advanced search export when api-cache exist and no filters were supplied #1153 * Ops: Throttle strings with "Response size" should be renamed "Repeated request" #1168 * allow ixlan prefix to be changed / deleted regardless of existence of netixlans in the address space #924 * linting * poetry relock * remove debug code * linting * fixed Reset IX-F suggestions link non-functional #1253 * solved UI shows own email when viewing affiliation requests for an organization #1250 * Adjust "Add Facility" menu to include newly defined fields #1091 * Footer "Global System Statistics" should be cached within django instance, not updated with every page load #1283 * linting * django-handleref to 1.1.0 and relock poetry * GLOBAL_STATS_CACHE_DURATION default to 900 seconds * remove vscode and idea * remove Ctl/dev/docker-compose.debug.yml * remove unsused variable * rename STATS to __STATS * linting * regen docs
2.7 KiB
Generated from api_schema.py on 2022-11-08 14:31:50.933987
peeringdb_server.api_schema
Augment REST API schema to use for open-api schema generation.
open-api schema generation leans heavily on automatic generation implemented through the django-rest-framework.
Specify custom fields to be added to the generated open-api schema.
Classes
BaseSchema
BaseSchema(rest_framework.schemas.openapi.AutoSchema)
Augments the openapi schema generation for the peeringdb API docs.
Methods
augment_create_ix
def augment_create_ix(self, serializer, model, op_dict)
Augment openapi schema for create ix operation.
augment_create_operation
def augment_create_operation(self, op_dict, op_args)
Augment openapi schema for object creation.
augment_delete_operation
def augment_delete_operation(self, op_dict, op_args)
Augment openapi schema for delete operation.
augment_list_filters
def augment_list_filters(self, model, serializer, parameters)
Further augment openapi schema for object listing by filling the query parameter list with all the possible query filters for the object.
augment_list_operation
def augment_list_operation(self, op_dict, op_args)
Augment openapi schema for object listings.
augment_retrieve_operation
def augment_retrieve_operation(self, op_dict, op_args)
Augment openapi schema for single object retrieval.
augment_update_fac
def augment_update_fac(self, serializer, model, op_dict)
Augment openapi schema for update fac operation.
augment_update_ix
def augment_update_ix(self, serializer, model, op_dict)
Augment openapi schema for update ix operation.
augment_update_net
def augment_update_net(self, serializer, model, op_dict)
Augment openapi schema for update net operation.
augment_update_operation
def augment_update_operation(self, op_dict, op_args)
Augment openapi schema for update operation.
get_classes
def get_classes(self, *op_args)
Try to relate a serializer and model class to the openapi operation.
Returns:
- tuple(serializers.Serializer, models.Model)
get_operation
def get_operation(self, *args, **kwargs)
Override this so we can augment the operation dict for an openapi schema operation.
get_operation_id
def get_operation_id(self, path, method)
Override this so operation ids become "{op} {reftag}"
get_operation_type
def get_operation_type(self, *args)
Determine if this is a list retrieval operation.
request_body_schema
def request_body_schema(self, op_dict, content=application/json)
Helper function that return the request body schema for the specified content type.