Files
peeringdb-peeringdb/docs/dev/modules/autocomplete_views.py.md
Stefan Pratter 5eb925e319 Support 202301 (#1329)
* fix next redirect when using U2F 2FA auth (#1191)

* Added self identifier to API

* fix migrations hierarchy after merging in previous support branch

* campus object

Co-authored-by: Stefan Pratter <stefan@20c.com>

* fix out of bound error message
add city / country to campus view

* fix tests

* relock poetry

* linting

* linting

* fix docs regen

* regen docs

* linting

* refactor self entity view to support carrier and campus object types and also make it easier to support additional object types in the future

* remove debug message

---------

Co-authored-by: Gajanan Patil <dipaksavaliya.python@gmail.com>
2023-02-15 07:55:01 +00:00

318 lines
4.8 KiB
Markdown

Generated from autocomplete_views.py on 2023-02-14 15:33:37.135106
# peeringdb_server.autocomplete_views
Autocomplete views.
Handle most autocomplete functionality found in peeringdb.
Note: Quick search behavior is specified in search.py
# Classes
---
## AutocompleteHTMLResponse
```
AutocompleteHTMLResponse(dal_select2.views.Select2QuerySetView)
```
List options for a Select2 widget.
### Methods
#### render_to_response
`def render_to_response(self, context)`
Return a JSON response in Select2 format.
---
## CommandLineToolHistoryAutocomplete
```
CommandLineToolHistoryAutocomplete(dal_select2.views.Select2QuerySetView)
```
Autocomplete for command line tools that were run via the admin ui.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
#### get_result_label
`def get_result_label(self, item)`
Return the label of a result.
---
## DeletedVersionAutocomplete
```
DeletedVersionAutocomplete(dal_select2.views.Select2QuerySetView)
```
Autocomplete that will show reversion versions where an object
was set to deleted.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
#### get_result_label
`def get_result_label(self, item)`
Return the label of a result.
---
## ExchangeAutocomplete
```
ExchangeAutocomplete(peeringdb_server.autocomplete_views.AutocompleteHTMLResponse)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
#### get_result_label
`def get_result_label(self, item)`
Return the label of a result.
---
## ExchangeAutocompleteJSON
```
ExchangeAutocompleteJSON(dal_select2.views.Select2QuerySetView)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
## FacilityAutocomplete
```
FacilityAutocomplete(peeringdb_server.autocomplete_views.AutocompleteHTMLResponse)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
#### get_result_label
`def get_result_label(self, item)`
Return the label of a result.
---
## FacilityAutocompleteForExchange
```
FacilityAutocompleteForExchange(peeringdb_server.autocomplete_views.FacilityAutocomplete)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
## FacilityAutocompleteForNetwork
```
FacilityAutocompleteForNetwork(peeringdb_server.autocomplete_views.FacilityAutocomplete)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
## FacilityAutocompleteForOrganization
```
FacilityAutocompleteForOrganization(peeringdb_server.autocomplete_views.FacilityAutocomplete)
```
List of facilities under same organization ownership
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
## FacilityAutocompleteJSON
```
FacilityAutocompleteJSON(dal_select2.views.Select2QuerySetView)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
## GrappelliHandlerefAutocomplete
```
GrappelliHandlerefAutocomplete(peeringdb_server.autocomplete_views.PDBAdminGrappelliAutocomplete)
```
Make sure that the auto-complete fields managed
by grappelli in django admin exclude soft-deleted
objects.
## IXLanAutocomplete
```
IXLanAutocomplete(peeringdb_server.autocomplete_views.AutocompleteHTMLResponse)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
#### get_result_label
`def get_result_label(self, item)`
Return the label of a result.
---
## NetworkAutocomplete
```
NetworkAutocomplete(peeringdb_server.autocomplete_views.AutocompleteHTMLResponse)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
#### get_result_label
`def get_result_label(self, item)`
Return the label of a result.
---
## OrganizationAutocomplete
```
OrganizationAutocomplete(peeringdb_server.autocomplete_views.AutocompleteHTMLResponse)
```
List options for a Select2 widget.
### Methods
#### get_queryset
`def get_queryset(self)`
Filter the queryset with GET['q'].
---
#### get_result_label
`def get_result_label(self, item)`
Return the label of a result.
---
## PDBAdminGrappelliAutocomplete
```
PDBAdminGrappelliAutocomplete(grappelli.views.related.AutocompleteLookup)
```
AutocompleteLookup
## ToolHistory
```
ToolHistory(peeringdb_server.autocomplete_views.CommandLineToolHistoryAutocomplete)
```
Autocomplete for command line tools that were run via the admin ui.