utils¶
JSONAPIResponse
¶
Bases: JSONResponse
This class simply patches fastapi.responses.JSONResponse
to use the
JSON:API 'application/vnd.api+json' MIME type.
Source code in optimade/server/routers/utils.py
40 41 42 43 44 45 46 |
|
get_base_url(parsed_url_request)
¶
Get base URL for current server
Take the base URL from the config file, if it exists, otherwise use the request.
Source code in optimade/server/routers/utils.py
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
|
get_entries(collection, request, params)
¶
Generalized /{entry} endpoint getter
Source code in optimade/server/routers/utils.py
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
|
get_included_relationships(results, ENTRY_COLLECTIONS, include_param)
¶
Filters the included relationships and makes the appropriate compound request to include them in the response.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
results |
Union[EntryResource, list[EntryResource], dict, list[dict]]
|
list of returned documents. |
required |
ENTRY_COLLECTIONS |
dict[str, EntryCollection]
|
dictionary containing collections to query, with key based on endpoint type. |
required |
include_param |
list[str]
|
list of queried related resources that should be included in
|
required |
Returns:
Type | Description |
---|---|
list[Union[EntryResource, dict[str, Any]]]
|
Dictionary with the same keys as ENTRY_COLLECTIONS, each containing the list of resource objects for that entry type. |
Source code in optimade/server/routers/utils.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|
get_providers(add_mongo_id=False)
¶
Retrieve Materials-Consortia providers (from https://providers.optimade.org/v1/links).
Fallback order if providers.optimade.org is not available:
- Try Materials-Consortia/providers on GitHub.
- Try submodule
providers
' list of providers. - Log warning that providers list from Materials-Consortia is not included in the
/links
-endpoint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
add_mongo_id |
bool
|
Whether to populate the |
False
|
Returns:
Type | Description |
---|---|
list
|
List of raw JSON-decoded providers including MongoDB object IDs. |
Source code in optimade/utils.py
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
|
handle_response_fields(results, exclude_fields, include_fields)
¶
Handle query parameter response_fields
.
It is assumed that all fields are under attributes
.
This is due to all other top-level fields are REQUIRED in the response.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
exclude_fields |
set[str]
|
Fields under |
required |
include_fields |
set[str]
|
Fields under |
required |
Returns:
Type | Description |
---|---|
list[dict[str, Any]]
|
List of resulting resources as dictionaries after pruning according to |
list[dict[str, Any]]
|
the |
Source code in optimade/server/routers/utils.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
|
meta_values(url, data_returned, data_available, more_data_available, schema=None, **kwargs)
¶
Helper to initialize the meta values
Source code in optimade/server/routers/utils.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
|
mongo_id_for_database(database_id, database_type)
¶
Produce a MongoDB ObjectId for a database
Source code in optimade/utils.py
93 94 95 96 97 98 99 100 101 102 103 |
|