summaryrefslogtreecommitdiffstats
path: root/fatcat-openapi/docs/ReleaseRef.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@archive.org>2021-02-09 18:57:00 -0800
committerBryan Newbold <bnewbold@archive.org>2021-02-09 18:57:00 -0800
commit19c582a3cf1c42e9c75170650ccd141eda903479 (patch)
tree0738781689e4c12308016f184cb6eb02af1716a6 /fatcat-openapi/docs/ReleaseRef.md
parentbab3fb9fdcc921e1bb8a81e0f2b4e12558d2dde7 (diff)
downloadfatcat-cli-19c582a3cf1c42e9c75170650ccd141eda903479.tar.gz
fatcat-cli-19c582a3cf1c42e9c75170650ccd141eda903479.zip
move source code to top-level directory
Diffstat (limited to 'fatcat-openapi/docs/ReleaseRef.md')
-rw-r--r--fatcat-openapi/docs/ReleaseRef.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/fatcat-openapi/docs/ReleaseRef.md b/fatcat-openapi/docs/ReleaseRef.md
new file mode 100644
index 0000000..980cb0b
--- /dev/null
+++ b/fatcat-openapi/docs/ReleaseRef.md
@@ -0,0 +1,17 @@
+# ReleaseRef
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **i64** | Zero-indexed sequence number of this reference in the list of references. Assigned automatically and used internally; don't confuse with `key`. | [optional] [default to None]
+**target_release_id** | **String** | Optional, fatcat identifier of release entity that this reference is citing. | [optional] [default to None]
+**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Additional free-form JSON metadata about this citation. Generally follows Citation Style Language (CSL) JSON schema. See guide for details. | [optional] [default to None]
+**key** | **String** | Short string used to indicate this reference from within the release text; or numbering of references as typeset in the release itself. Optional; don't confuse with `index` field. | [optional] [default to None]
+**year** | **i64** | Year that the cited work was published in. | [optional] [default to None]
+**container_name** | **String** | Name of the container (eg, journal) that the citation work was published as part of. May be an acronym or full name. | [optional] [default to None]
+**title** | **String** | Name of the work being cited. | [optional] [default to None]
+**locator** | **String** | Page number or other indicator of the specific subset of a work being cited. Not to be confused with the first page (or page range) of an entire paper or chapter being cited. | [optional] [default to None]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+