Merge pull request #101 from Leaseweb/chore/sort-enum

chore: add sort enum for ipmgmt

ipmgmt/.openapi-generator/FILES

@@ -1,5 +1,4 @@
 .gitignore
-.openapi-generator-ignore
 .travis.yml
 README.md
 api/openapi.yaml
@@ -19,6 +18,7 @@ docs/NullRouteIPOpts.md
 docs/NullRoutedIP.md
 docs/ProtocolVersion.md
 docs/ReverseLookup.md
+docs/Sort.md
 docs/Subnet.md
 docs/UpdateIPOpts.md
 docs/UpdateNullRouteOpts.md
@@ -39,11 +39,11 @@ model_null_route_ip_opts.go
 model_null_routed_ip.go
 model_protocol_version.go
 model_reverse_lookup.go
+model_sort.go
 model_subnet.go
 model_update_ip_opts.go
 model_update_null_route_opts.go
 model_update_reverse_lookup_records_opts.go
 model_update_reverse_lookup_records_result.go
 response.go
-test/api_ipmgmt_test.go
 utils.go

ipmgmt/README.md

@@ -104,6 +104,7 @@ Class | Method | HTTP request | Description
  - [NullRoutedIP](docs/NullRoutedIP.md)
  - [ProtocolVersion](docs/ProtocolVersion.md)
  - [ReverseLookup](docs/ReverseLookup.md)
+ - [Sort](docs/Sort.md)
  - [Subnet](docs/Subnet.md)
  - [UpdateIPOpts](docs/UpdateIPOpts.md)
  - [UpdateNullRouteOpts](docs/UpdateNullRouteOpts.md)

ipmgmt/api/openapi.yaml

@@ -151,7 +151,7 @@ paths:
         name: sort
         required: false
         schema:
-          type: string
+          $ref: '#/components/schemas/sort'
         style: form
       - description: Filter by reverse lookup.
         example: mydomain1.example.com
@@ -887,7 +887,7 @@ paths:
         name: sort
         required: false
         schema:
-          type: string
+          $ref: '#/components/schemas/sort'
         style: form
       responses:
         "200":
@@ -1182,7 +1182,7 @@ components:
       name: sort
       required: false
       schema:
-        type: string
+        $ref: '#/components/schemas/sort'
       style: form
     reverseLookup:
       description: Filter by reverse lookup.
@@ -1287,6 +1287,12 @@ components:
       - ROUTER2
       - IPMI
       type: string
+    sort:
+      enum:
+      - ip
+      - nullRouted
+      - reverseLookup
+      type: string
     assignedContract:
       description: An explanation about the purpose of this instance.
       example:

ipmgmt/docs/IpmgmtAPI.md

@@ -48,7 +48,7 @@ func main() {
 	ips := "ips_example" // string | Return only IPs specified as a comma-separated list (optional)
 	equipmentIds := "equipmentIds_example" // string | Return only IPs assigned to equipment items specified as a comma-separated list of IDs (optional)
 	assignedContractIds := "assignedContractIds_example" // string | Return only IPs assigned to contracts specified as a comma-separated list of IDs (optional)
-	sort := "sort_example" // string | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. (optional)
+	sort := openapiclient.sort("ip") // Sort | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. (optional)
 	reverseLookup := "mydomain1.example.com" // string | Filter by reverse lookup. (optional)
 
 	configuration := openapiclient.NewConfiguration()
@@ -86,7 +86,7 @@ Name | Type | Description  | Notes
  **ips** | **string** | Return only IPs specified as a comma-separated list | 
  **equipmentIds** | **string** | Return only IPs assigned to equipment items specified as a comma-separated list of IDs | 
  **assignedContractIds** | **string** | Return only IPs assigned to contracts specified as a comma-separated list of IDs | 
- **sort** | **string** | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. | 
+ **sort** | [**Sort**](Sort.md) | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. | 
  **reverseLookup** | **string** | Filter by reverse lookup. | 
 
 ### Return type
@@ -138,7 +138,7 @@ func main() {
 	ticketId := "ticketId_example" // string | Filter by the reference stored with the null route (optional)
 	contractId := "contractId_example" // string | Filter by ID of the contract assigned to the IP at the time of null route creation (optional)
 	equipmentId := "equipmentId_example" // string | Filter by ID of the server assigned to the IP at the time of null route creation (optional)
-	sort := "sort_example" // string | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. (optional)
+	sort := openapiclient.sort("ip") // Sort | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. (optional)
 
 	configuration := openapiclient.NewConfiguration()
 	apiClient := openapiclient.NewAPIClient(configuration)
@@ -174,7 +174,7 @@ Name | Type | Description  | Notes
  **ticketId** | **string** | Filter by the reference stored with the null route | 
  **contractId** | **string** | Filter by ID of the contract assigned to the IP at the time of null route creation | 
  **equipmentId** | **string** | Filter by ID of the server assigned to the IP at the time of null route creation | 
- **sort** | **string** | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. | 
+ **sort** | [**Sort**](Sort.md) | Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. `sort=ip,-nullrouted`. Sortable field names are ip, nullRouted, reverseLookup. | 
 
 ### Return type
 

ipmgmt/docs/Sort.md

@@ -0,0 +1,15 @@
+# Sort
+
+## Enum
+
+
+* `IP` (value: `"ip"`)
+
+* `NULL_ROUTED` (value: `"nullRouted"`)
+
+* `REVERSE_LOOKUP` (value: `"reverseLookup"`)
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+