references¶
Person
¶
Bases: BaseModel
A person, i.e., an author, editor or other.
Source code in optimade/models/references.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
ReferenceResource
¶
Bases: EntryResource
The references
entries describe bibliographic references.
The following properties are used to provide the bibliographic details:
- address, annote, booktitle, chapter, crossref, edition, howpublished, institution, journal, key, month, note, number, organization, pages, publisher, school, series, title, volume, year: meanings of these properties match the BibTeX specification, values are strings;
- bib_type: type of the reference, corresponding to type property in the BibTeX specification, value is string;
- authors and editors: lists of person objects which are dictionaries with the following keys:
- name: Full name of the person, REQUIRED.
- firstname, lastname: Parts of the person's name, OPTIONAL.
- doi and url: values are strings.
- Requirements/Conventions:
- Support: OPTIONAL support in implementations, i.e., any of the properties MAY be
null
. - Query: Support for queries on any of these properties is OPTIONAL. If supported, filters MAY support only a subset of comparison operators.
- Every references entry MUST contain at least one of the properties.
- Support: OPTIONAL support in implementations, i.e., any of the properties MAY be
Source code in optimade/models/references.py
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
|
attributes
instance-attribute
¶
id
instance-attribute
¶
links = None
class-attribute
instance-attribute
¶
meta = None
class-attribute
instance-attribute
¶
model_config = ConfigDict(json_schema_extra=resource_json_schema_extra)
class-attribute
instance-attribute
¶
relationships = None
class-attribute
instance-attribute
¶
type = 'references'
class-attribute
instance-attribute
¶
validate_attributes(value)
classmethod
¶
Source code in optimade/models/references.py
323 324 325 326 327 328 329 330 331 332 333 |
|
ReferenceResourceAttributes
¶
Bases: EntryResourceAttributes
Model that stores the attributes of a reference.
Many properties match the meaning described in the BibTeX specification.
Source code in optimade/models/references.py
42 43 44 45 46 47 48 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 84 85 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 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 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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 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 |
|
address = None
class-attribute
instance-attribute
¶
annote = None
class-attribute
instance-attribute
¶
authors = None
class-attribute
instance-attribute
¶
bib_type = None
class-attribute
instance-attribute
¶
booktitle = None
class-attribute
instance-attribute
¶
chapter = None
class-attribute
instance-attribute
¶
crossref = None
class-attribute
instance-attribute
¶
doi = None
class-attribute
instance-attribute
¶
edition = None
class-attribute
instance-attribute
¶
editors = None
class-attribute
instance-attribute
¶
howpublished = None
class-attribute
instance-attribute
¶
immutable_id = None
class-attribute
instance-attribute
¶
institution = None
class-attribute
instance-attribute
¶
journal = None
class-attribute
instance-attribute
¶
key = None
class-attribute
instance-attribute
¶
last_modified
instance-attribute
¶
model_config = ConfigDict(extra='allow')
class-attribute
instance-attribute
¶
month = None
class-attribute
instance-attribute
¶
note = None
class-attribute
instance-attribute
¶
number = None
class-attribute
instance-attribute
¶
organization = None
class-attribute
instance-attribute
¶
pages = None
class-attribute
instance-attribute
¶
publisher = None
class-attribute
instance-attribute
¶
school = None
class-attribute
instance-attribute
¶
series = None
class-attribute
instance-attribute
¶
title = None
class-attribute
instance-attribute
¶
url = None
class-attribute
instance-attribute
¶
volume = None
class-attribute
instance-attribute
¶
year = None
class-attribute
instance-attribute
¶
cast_immutable_id_to_str(value)
classmethod
¶
Convenience validator for casting immutable_id
to a string.
Source code in optimade/models/entries.py
110 111 112 113 114 115 116 117 |
|
check_illegal_attributes_fields()
¶
Source code in optimade/models/jsonapi.py
330 331 332 333 334 335 336 337 338 |
|