Getting Started / Overview
Content
OpenAPI Swagger UI docs: https://apim-similarity-detector.azure-api.net/v1/docs
Azure Functions conventions
| HTTP method | CRUD operation |
|---|---|
| POST | Create |
| GET | Read |
| PUT | Update |
| DELETE | Delete |
Current Azure Functions
All Azure Functions are defined as operationIds in the OpenAPI definition
Path parameters
| Variable | Type | Example |
|---|---|---|
componentType | String | capacitors |
componentId | Int | 42 |
Query parameters
| Azure Function name | Parameter name | Type | Description | Examples |
|---|---|---|---|---|
| ReadSimilarities | ordering | String | It allows to specify a specific ordering for the result set. Given an attribute named type the ordering will be ascending (-type descending). | ...&ordering=type |
| differenceInAsString | Any | When it is declared the differencesIn attribute gets returned as a string instead of a list. | ...&differenceInAsString=true |
Search (query) filter
Operators
The table below lists the operator names with their corresponding mathematical symbols and the corresponding short forms.
| Operator Name | Symbol | Name |
|---|---|---|
| equal to | = | eq |
| not equal to | ≠ | ne |
| less than | < | lt |
| greater than | > | gt |
| less than or equal to | ≤ | le |
| greater than or equal to | ≥ | ge |
If you want to search for a capacitor that has a voltage greater than 10 (voltage > 10) and a voltage less than or equal to 100 (voltage ≤ 100) and a height of 42 (height = 42) use the query parameters:
?voltage__gt=10&voltage__le=100&height__eq=42- https://apim-similarity-detector.azure-api.net/v1/componentTypes/capacitors/42/similarities?voltage__gt=10&voltage__le=100&height__eq=42
To search for a component in a specific range use for example the following command: ...&height__gt=42&height__lt=100. So you can search for a component that has a height > 42 and < 100.
API hierarchy
- https://apim-similarity-detector.azure-api.net/v1
- /v1
- /componentTypes (GET)
- /componentTypes/{componentType} (GET)
- /componentTypes/{componentType} (POST)
- /componentTypes/{componentType}/{componentId} (GET)
- /componentTypes/{componentType}/{componentId}/similarities (GET)
- /componentTypes/{componentType}/{componentId}/similarities (POST)
- /filter/{componentType} (GET)
- /machineLearningMock (POST)
- /docs (GET)
- /openapi (GET)
- /v1