diff options
Diffstat (limited to 'fatcat-openapi/docs')
| -rw-r--r-- | fatcat-openapi/docs/ContainerEntity.md | 3 | ||||
| -rw-r--r-- | fatcat-openapi/docs/FilesetFile.md | 3 | ||||
| -rw-r--r-- | fatcat-openapi/docs/ReleaseExtIds.md | 1 | ||||
| -rw-r--r-- | fatcat-openapi/docs/default_api.md | 39 |
4 files changed, 45 insertions, 1 deletions
diff --git a/fatcat-openapi/docs/ContainerEntity.md b/fatcat-openapi/docs/ContainerEntity.md index 376130e..e42b28e 100644 --- a/fatcat-openapi/docs/ContainerEntity.md +++ b/fatcat-openapi/docs/ContainerEntity.md @@ -11,8 +11,11 @@ Name | Type | Description | Notes **edit_extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with specific entity edits (eg, creation/update/delete). | [optional] [default to None] **name** | **String** | Name of the container (eg, Journal title). Required for entity creation. | [optional] [default to None] **container_type** | **String** | Type of container, eg 'journal' or 'proceedings'. See Guide for list of valid types. | [optional] [default to None] +**publication_status** | **String** | Whether the container is active, discontinued, etc | [optional] [default to None] **publisher** | **String** | Name of the organization or entity responsible for publication. Not the complete imprint/brand. | [optional] [default to None] **issnl** | **String** | Linking ISSN number (ISSN-L). Should be valid and registered with issn.org | [optional] [default to None] +**issne** | **String** | Electronic ISSN number (ISSN-E). Should be valid and registered with issn.org | [optional] [default to None] +**issnp** | **String** | Print ISSN number (ISSN-P). Should be valid and registered with issn.org | [optional] [default to None] **wikidata_qid** | **String** | | [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) diff --git a/fatcat-openapi/docs/FilesetFile.md b/fatcat-openapi/docs/FilesetFile.md index b023e4a..24d4b11 100644 --- a/fatcat-openapi/docs/FilesetFile.md +++ b/fatcat-openapi/docs/FilesetFile.md @@ -8,7 +8,8 @@ Name | Type | Description | Notes **md5** | **String** | MD5 hash of data, in hex encoding | [optional] [default to None] **sha1** | **String** | SHA-1 hash of data, in hex encoding | [optional] [default to None] **sha256** | **String** | SHA-256 hash of data, in hex encoding | [optional] [default to None] -**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form additional metadata about this specific file in the set. Eg, `mimetype`. See guide for nomative (but unenforced) schema fields. | [optional] [default to None] +**mimetype** | **String** | | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form additional metadata about this specific file in the set. Eg, `original_url`. See guide for normative (but unenforced) schema fields. | [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) diff --git a/fatcat-openapi/docs/ReleaseExtIds.md b/fatcat-openapi/docs/ReleaseExtIds.md index 416d595..8afa1fe 100644 --- a/fatcat-openapi/docs/ReleaseExtIds.md +++ b/fatcat-openapi/docs/ReleaseExtIds.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **doaj** | **String** | DOAJ article-level identifier | [optional] [default to None] **dblp** | **String** | dblp (https://dblp.uni-trier.de/) paper identifier; eg for conference proceedings | [optional] [default to None] **oai** | **String** | OAI-PMH identifier; only used when an OAI-PMH record is the only authoritative metadata (eg, journal OAI-PMH feeds w/o DOIs) | [optional] [default to None] +**hdl** | **String** | Handle identifier. Do not put DOIs in this field | [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) diff --git a/fatcat-openapi/docs/default_api.md b/fatcat-openapi/docs/default_api.md index 5308e84..5adc6d9 100644 --- a/fatcat-openapi/docs/default_api.md +++ b/fatcat-openapi/docs/default_api.md @@ -88,6 +88,7 @@ Method | HTTP request | Description **get_work_revision**](default_api.md#get_work_revision) | **GET** /work/rev/{rev_id} | **lookup_container**](default_api.md#lookup_container) | **GET** /container/lookup | **lookup_creator**](default_api.md#lookup_creator) | **GET** /creator/lookup | +**lookup_editor**](default_api.md#lookup_editor) | **GET** /editor/lookup | **lookup_file**](default_api.md#lookup_file) | **GET** /file/lookup | **lookup_release**](default_api.md#lookup_release) | **GET** /release/lookup | **update_container**](default_api.md#update_container) | **PUT** /editgroup/{editgroup_id}/container/{ident} | @@ -2611,6 +2612,9 @@ Optional parameters are passed through a map[string]interface{}. Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **issnl** | **String**| | + **issne** | **String**| | + **issnp** | **String**| | + **issn** | **String**| | **wikidata_qid** | **String**| | **expand** | **String**| List of sub-entities to expand in response. See `get_container`. | **hide** | **String**| List of entity fields to elide in response. See `get_container`. | @@ -2665,6 +2669,40 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **lookup_editor** +> models::Editor lookup_editor(optional) + + +Fetches editor by, eg, username. One (and only one) lookup identifier should be specified per request. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **optional** | **map[string]interface{}** | optional parameters | nil if no parameters + +### Optional Parameters +Optional parameters are passed through a map[string]interface{}. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| | + +### Return type + +[**models::Editor**](editor.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **lookup_file** > models::FileEntity lookup_file(optional) @@ -2731,6 +2769,7 @@ Name | Type | Description | Notes **doaj** | **String**| | **dblp** | **String**| | **oai** | **String**| | + **hdl** | **String**| | **expand** | **String**| List of sub-entities to expand in response. See `get_release`. | **hide** | **String**| List of sub-entities to elide in response. See `get_release`. | |