diff options
Diffstat (limited to 'fatcat-openapi/docs')
36 files changed, 3555 insertions, 0 deletions
diff --git a/fatcat-openapi/docs/AuthOidc.md b/fatcat-openapi/docs/AuthOidc.md new file mode 100644 index 0000000..de80baa --- /dev/null +++ b/fatcat-openapi/docs/AuthOidc.md @@ -0,0 +1,13 @@ +# AuthOidc + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provider** | **String** | Fatcat-specific short name (slug) for remote service being used for authentication. | +**sub** | **String** | `SUB` from OIDC protocol. Usually a URL. | +**iss** | **String** | `ISS` from OIDC protocol. Usually a stable account username, number, or identifier. | +**preferred_username** | **String** | What it sounds like; returned by OIDC, and used as a hint when creating new editor accounts. Fatcat usernames are usually this string with the `provider` slug as a suffix, though some munging may occur. | + +[[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/AuthOidcResult.md b/fatcat-openapi/docs/AuthOidcResult.md new file mode 100644 index 0000000..3418bea --- /dev/null +++ b/fatcat-openapi/docs/AuthOidcResult.md @@ -0,0 +1,11 @@ +# AuthOidcResult + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editor** | [***models::Editor**](editor.md) | | +**token** | **String** | | + +[[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/AuthTokenResult.md b/fatcat-openapi/docs/AuthTokenResult.md new file mode 100644 index 0000000..2bb3dd7 --- /dev/null +++ b/fatcat-openapi/docs/AuthTokenResult.md @@ -0,0 +1,10 @@ +# AuthTokenResult + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token** | **String** | | + +[[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/ChangelogEntry.md b/fatcat-openapi/docs/ChangelogEntry.md new file mode 100644 index 0000000..3f62f70 --- /dev/null +++ b/fatcat-openapi/docs/ChangelogEntry.md @@ -0,0 +1,13 @@ +# ChangelogEntry + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **i64** | Monotonically increasing sequence number of this changelog entry. | +**editgroup_id** | **String** | Identifier of editgroup accepted/merged in this changelog entry. | +**timestamp** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | Date and time when the editgroup was accpeted. | +**editgroup** | [***models::Editgroup**](editgroup.md) | | [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/ContainerAutoBatch.md b/fatcat-openapi/docs/ContainerAutoBatch.md new file mode 100644 index 0000000..0413aac --- /dev/null +++ b/fatcat-openapi/docs/ContainerAutoBatch.md @@ -0,0 +1,11 @@ +# ContainerAutoBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**entity_list** | [**Vec<models::ContainerEntity>**](container_entity.md) | | + +[[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/ContainerEntity.md b/fatcat-openapi/docs/ContainerEntity.md new file mode 100644 index 0000000..376130e --- /dev/null +++ b/fatcat-openapi/docs/ContainerEntity.md @@ -0,0 +1,20 @@ +# ContainerEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **String** | | [optional] [default to None] +**ident** | **String** | base32-encoded unique identifier | [optional] [default to None] +**revision** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**redirect** | **String** | base32-encoded unique identifier | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. | [optional] [default to None] +**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] +**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] +**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/CreatorAutoBatch.md b/fatcat-openapi/docs/CreatorAutoBatch.md new file mode 100644 index 0000000..b30375c --- /dev/null +++ b/fatcat-openapi/docs/CreatorAutoBatch.md @@ -0,0 +1,11 @@ +# CreatorAutoBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**entity_list** | [**Vec<models::CreatorEntity>**](creator_entity.md) | | + +[[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/CreatorEntity.md b/fatcat-openapi/docs/CreatorEntity.md new file mode 100644 index 0000000..2b7306c --- /dev/null +++ b/fatcat-openapi/docs/CreatorEntity.md @@ -0,0 +1,20 @@ +# CreatorEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **String** | | [optional] [default to None] +**ident** | **String** | base32-encoded unique identifier | [optional] [default to None] +**revision** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**redirect** | **String** | base32-encoded unique identifier | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. | [optional] [default to None] +**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] +**display_name** | **String** | Name as should be displayed in web interface or in author lists (not index/sorted). Required for valid entities. | [optional] [default to None] +**given_name** | **String** | In English commonly the first name, but ordering is context and culture specific. | [optional] [default to None] +**surname** | **String** | In English commonly the last, or family name, but ordering is context and culture specific. | [optional] [default to None] +**orcid** | **String** | ORCiD (https://orcid.org) identifier | [optional] [default to None] +**wikidata_qid** | **String** | Wikidata entity QID | [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/Editgroup.md b/fatcat-openapi/docs/Editgroup.md new file mode 100644 index 0000000..5faafd6 --- /dev/null +++ b/fatcat-openapi/docs/Editgroup.md @@ -0,0 +1,19 @@ +# Editgroup + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup_id** | **String** | Fatcat identifier for this editgroup. Assigned on creation. | [optional] [default to None] +**editor_id** | **String** | Fatcat identifer of editor that created this editgroup. | [optional] [default to None] +**editor** | [***models::Editor**](editor.md) | | [optional] [default to None] +**changelog_index** | **i64** | For accepted/merged editgroups, the changelog index that the accept occured at. WARNING: not populated in all contexts that an editgroup could be included in a response. | [optional] [default to None] +**created** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | Timestamp when this editgroup was first created. | [optional] [default to None] +**submitted** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | Timestamp when this editgroup was most recently submitted for review. If withdrawn, or never submitted, will be `null`. | [optional] [default to None] +**description** | **String** | Comment describing the changes in this editgroup. Can be updated with PUT request. | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata attached to this editgroup. Eg, metadata provenance, or script user-agent details. See guide for (unenforced) schema norms. | [optional] [default to None] +**annotations** | [**Vec<models::EditgroupAnnotation>**](editgroup_annotation.md) | Only included in GET responses, and not in all contexts. Do not include this field in PUT or POST requests. | [optional] [default to None] +**edits** | [***models::EditgroupEdits**](editgroup_edits.md) | | [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/EditgroupAnnotation.md b/fatcat-openapi/docs/EditgroupAnnotation.md new file mode 100644 index 0000000..3450e4d --- /dev/null +++ b/fatcat-openapi/docs/EditgroupAnnotation.md @@ -0,0 +1,16 @@ +# EditgroupAnnotation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**annotation_id** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**editgroup_id** | **String** | Editgroup that this annotation applies to. Set automatically in creations based on URL parameter. | [optional] [default to None] +**editor_id** | **String** | Defaults to editor created the annotation via POST request. | [optional] [default to None] +**editor** | [***models::Editor**](editor.md) | | [optional] [default to None] +**created** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | Timestamp when annotation was first created. | [optional] [default to None] +**comment_markdown** | **String** | | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Additional free-form JSON metadata that can be included as part of the annotation (or even as the primary annotation itself). See guide for details. | [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/EditgroupEdits.md b/fatcat-openapi/docs/EditgroupEdits.md new file mode 100644 index 0000000..cb3cd82 --- /dev/null +++ b/fatcat-openapi/docs/EditgroupEdits.md @@ -0,0 +1,16 @@ +# EditgroupEdits + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**containers** | [**Vec<models::EntityEdit>**](entity_edit.md) | | [optional] [default to None] +**creators** | [**Vec<models::EntityEdit>**](entity_edit.md) | | [optional] [default to None] +**files** | [**Vec<models::EntityEdit>**](entity_edit.md) | | [optional] [default to None] +**filesets** | [**Vec<models::EntityEdit>**](entity_edit.md) | | [optional] [default to None] +**webcaptures** | [**Vec<models::EntityEdit>**](entity_edit.md) | | [optional] [default to None] +**releases** | [**Vec<models::EntityEdit>**](entity_edit.md) | | [optional] [default to None] +**works** | [**Vec<models::EntityEdit>**](entity_edit.md) | | [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/Editor.md b/fatcat-openapi/docs/Editor.md new file mode 100644 index 0000000..4cf495f --- /dev/null +++ b/fatcat-openapi/docs/Editor.md @@ -0,0 +1,14 @@ +# Editor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editor_id** | **String** | Fatcat identifier for the editor. Can not be changed. | [optional] [default to None] +**username** | **String** | Username/handle (short slug-like string) to identify this editor. May be changed at any time by the editor; use the `editor_id` as a persistend identifer. | +**is_admin** | **bool** | Whether this editor has the `admin` role. | [optional] [default to None] +**is_bot** | **bool** | Whether this editor is a bot (as opposed to a human making manual edits) | [optional] [default to None] +**is_active** | **bool** | Whether this editor's account is enabled (if not API tokens and web logins will not work). | [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/EntityEdit.md b/fatcat-openapi/docs/EntityEdit.md new file mode 100644 index 0000000..5d51a87 --- /dev/null +++ b/fatcat-openapi/docs/EntityEdit.md @@ -0,0 +1,16 @@ +# EntityEdit + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**edit_id** | **String** | Unique UUID for this specific edit object. | +**ident** | **String** | Fatcat identifier of the entity this edit is mutating. | +**revision** | **String** | Entity revision that this edit will set the entity to. May be `null` in the case of deletions. | [optional] [default to None] +**prev_revision** | **String** | Revision of entity just before this edit. May be used in the future to prevent edit race conditions. | [optional] [default to None] +**redirect_ident** | **String** | When an edit is to merge entities (redirect one to another), this is the entity fatcat identifier for the target entity. | [optional] [default to None] +**editgroup_id** | **String** | Editgroup identifier that this edit is part of. | +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | | [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/EntityHistoryEntry.md b/fatcat-openapi/docs/EntityHistoryEntry.md new file mode 100644 index 0000000..4df6b5f --- /dev/null +++ b/fatcat-openapi/docs/EntityHistoryEntry.md @@ -0,0 +1,12 @@ +# EntityHistoryEntry + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**edit** | [***models::EntityEdit**](entity_edit.md) | | +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**changelog_entry** | [***models::ChangelogEntry**](changelog_entry.md) | | + +[[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/ErrorResponse.md b/fatcat-openapi/docs/ErrorResponse.md new file mode 100644 index 0000000..89008f1 --- /dev/null +++ b/fatcat-openapi/docs/ErrorResponse.md @@ -0,0 +1,12 @@ +# ErrorResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | | +**error** | **String** | | +**message** | **String** | | + +[[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/FileAutoBatch.md b/fatcat-openapi/docs/FileAutoBatch.md new file mode 100644 index 0000000..d45685e --- /dev/null +++ b/fatcat-openapi/docs/FileAutoBatch.md @@ -0,0 +1,11 @@ +# FileAutoBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**entity_list** | [**Vec<models::FileEntity>**](file_entity.md) | | + +[[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/FileEntity.md b/fatcat-openapi/docs/FileEntity.md new file mode 100644 index 0000000..496e797 --- /dev/null +++ b/fatcat-openapi/docs/FileEntity.md @@ -0,0 +1,23 @@ +# FileEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **String** | | [optional] [default to None] +**ident** | **String** | base32-encoded unique identifier | [optional] [default to None] +**revision** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**redirect** | **String** | base32-encoded unique identifier | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. | [optional] [default to None] +**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] +**size** | **i64** | Size of file in bytes. Non-zero. | [optional] [default to None] +**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] +**urls** | [**Vec<models::FileUrl>**](file_url.md) | | [optional] [default to None] +**mimetype** | **String** | | [optional] [default to None] +**release_ids** | **Vec<String>** | Set of identifier of release entities this file represents a full manifestation of. Usually a single release, but some files contain content of multiple full releases (eg, an issue of a journal). | [optional] [default to None] +**releases** | [**Vec<models::ReleaseEntity>**](release_entity.md) | Full release entities, included in GET responses when `releases` included in `expand` parameter. Ignored if included in PUT or POST requests. | [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/FileUrl.md b/fatcat-openapi/docs/FileUrl.md new file mode 100644 index 0000000..89a832e --- /dev/null +++ b/fatcat-openapi/docs/FileUrl.md @@ -0,0 +1,11 @@ +# FileUrl + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **String** | URL/URI pointing directly to a machine retrievable copy of this exact file. | +**rel** | **String** | Indicates type of host this URL points to. Eg, \"publisher\", \"repository\", \"webarchive\". See guide for list of acceptable values. | + +[[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/FilesetAutoBatch.md b/fatcat-openapi/docs/FilesetAutoBatch.md new file mode 100644 index 0000000..df41e6b --- /dev/null +++ b/fatcat-openapi/docs/FilesetAutoBatch.md @@ -0,0 +1,11 @@ +# FilesetAutoBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**entity_list** | [**Vec<models::FilesetEntity>**](fileset_entity.md) | | + +[[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/FilesetEntity.md b/fatcat-openapi/docs/FilesetEntity.md new file mode 100644 index 0000000..14ce4bf --- /dev/null +++ b/fatcat-openapi/docs/FilesetEntity.md @@ -0,0 +1,19 @@ +# FilesetEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **String** | | [optional] [default to None] +**ident** | **String** | base32-encoded unique identifier | [optional] [default to None] +**revision** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**redirect** | **String** | base32-encoded unique identifier | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. | [optional] [default to None] +**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] +**manifest** | [**Vec<models::FilesetFile>**](fileset_file.md) | | [optional] [default to None] +**urls** | [**Vec<models::FilesetUrl>**](fileset_url.md) | | [optional] [default to None] +**release_ids** | **Vec<String>** | Set of identifier of release entities this fileset represents a full manifestation of. Usually a single release. | [optional] [default to None] +**releases** | [**Vec<models::ReleaseEntity>**](release_entity.md) | Full release entities, included in GET responses when `releases` included in `expand` parameter. Ignored if included in PUT or POST requests. | [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 new file mode 100644 index 0000000..b023e4a --- /dev/null +++ b/fatcat-openapi/docs/FilesetFile.md @@ -0,0 +1,15 @@ +# FilesetFile + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **String** | Path name of file within this fileset (eg, directory) | +**size** | **i64** | File size in bytes | +**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] + +[[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/FilesetUrl.md b/fatcat-openapi/docs/FilesetUrl.md new file mode 100644 index 0000000..2c38760 --- /dev/null +++ b/fatcat-openapi/docs/FilesetUrl.md @@ -0,0 +1,11 @@ +# FilesetUrl + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **String** | | +**rel** | **String** | Indicates type of host this URL points to. See guide for list of acceptable values. | + +[[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/ReleaseAbstract.md b/fatcat-openapi/docs/ReleaseAbstract.md new file mode 100644 index 0000000..32f9bdc --- /dev/null +++ b/fatcat-openapi/docs/ReleaseAbstract.md @@ -0,0 +1,13 @@ +# ReleaseAbstract + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sha1** | **String** | SHA-1 hash of data, in hex encoding | [optional] [default to None] +**content** | **String** | Abstract content. May be encoded, as per `mimetype` field, but only string/text content may be included. | [optional] [default to None] +**mimetype** | **String** | Mimetype of abstract contents. `text/plain` is the default if content isn't encoded. | [optional] [default to None] +**lang** | **String** | ISO language code of the abstract. Same semantics as release `language` 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/ReleaseAutoBatch.md b/fatcat-openapi/docs/ReleaseAutoBatch.md new file mode 100644 index 0000000..8f60344 --- /dev/null +++ b/fatcat-openapi/docs/ReleaseAutoBatch.md @@ -0,0 +1,11 @@ +# ReleaseAutoBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**entity_list** | [**Vec<models::ReleaseEntity>**](release_entity.md) | | + +[[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/ReleaseContrib.md b/fatcat-openapi/docs/ReleaseContrib.md new file mode 100644 index 0000000..b30b1d8 --- /dev/null +++ b/fatcat-openapi/docs/ReleaseContrib.md @@ -0,0 +1,18 @@ +# ReleaseContrib + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **i64** | Internally assigned zero-indexed sequence number of contribution. Authors should come first; this encodes the order of attriubtion. | [optional] [default to None] +**creator_id** | **String** | If known, indicates the creator entity this contribution was made by. | [optional] [default to None] +**creator** | [***models::CreatorEntity**](creator_entity.md) | | [optional] [default to None] +**raw_name** | **String** | Full name of the contributor as typeset in the release. | [optional] [default to None] +**given_name** | **String** | In English commonly the first name, but ordering is context and culture specific. | [optional] [default to None] +**surname** | **String** | In English commonly the last, or family name, but ordering is context and culture specific. | [optional] [default to None] +**role** | **String** | Short string (slug) indicating type of contribution (eg, \"author\", \"translator\"). See guide for list of accpeted values. | [optional] [default to None] +**raw_affiliation** | **String** | Raw affiliation string as displayed in text | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Additional free-form JSON metadata about this contributor/contribution. See guide for normative schema. | [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/ReleaseEntity.md b/fatcat-openapi/docs/ReleaseEntity.md new file mode 100644 index 0000000..a30561c --- /dev/null +++ b/fatcat-openapi/docs/ReleaseEntity.md @@ -0,0 +1,43 @@ +# ReleaseEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **String** | | [optional] [default to None] +**ident** | **String** | base32-encoded unique identifier | [optional] [default to None] +**revision** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**redirect** | **String** | base32-encoded unique identifier | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. | [optional] [default to None] +**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] +**title** | **String** | Required for valid entities. The title used in citations and for display. Sometimes the English translation of title e even if release content is not English. | [optional] [default to None] +**subtitle** | **String** | Subtitle of release. In many cases, better to merge with title than include as separate field (unless combined title would be very long). See guide for details. | [optional] [default to None] +**original_title** | **String** | Title in original language if `title` field has been translated. See guide for details. | [optional] [default to None] +**work_id** | **String** | Identifier of work this release is part of. In creation (POST) requests, a work entity will be created automatically if this field is not set. | [optional] [default to None] +**container** | [***models::ContainerEntity**](container_entity.md) | | [optional] [default to None] +**files** | [**Vec<models::FileEntity>**](file_entity.md) | Complete file entities identified by `file_ids` field. Only included in GET responses when `files` included in `expand` parameter; ignored in PUT or POST requests. | [optional] [default to None] +**filesets** | [**Vec<models::FilesetEntity>**](fileset_entity.md) | Complete file entities identified by `filesets_ids` field. Only included in GET responses when `filesets` included in `expand` parameter; ignored in PUT or POST requests. | [optional] [default to None] +**webcaptures** | [**Vec<models::WebcaptureEntity>**](webcapture_entity.md) | Complete webcapture entities identified by `webcapture_ids` field. Only included in GET responses when `webcaptures` included in `expand` parameter; ignored in PUT or POST requests. | [optional] [default to None] +**container_id** | **String** | Used to link this release to a container entity that the release was published as part of. | [optional] [default to None] +**release_type** | **String** | \"Type\" or \"medium\" that this release is published as. See guide for valid values. | [optional] [default to None] +**release_stage** | **String** | The stage of publication of this specific release. See guide for valid values and semantics. | [optional] [default to None] +**release_date** | [***chrono::DateTime::<chrono::Utc>**](date.md) | Full date when this release was formally published. ISO format, like `2019-03-05`. See guide for semantics. | [optional] [default to None] +**release_year** | **i64** | Year when this release was formally published. Must match `release_date` if that field is set; this field exists because sometimes only the year is known. | [optional] [default to None] +**withdrawn_status** | **String** | Type of withdrawl or retraction of this release, if applicable. If release has not been withdrawn, should be `null` (aka, not set, not the string \"null\" or an empty string). | [optional] [default to None] +**withdrawn_date** | [***chrono::DateTime::<chrono::Utc>**](date.md) | Full date when this release was formally withdrawn (if applicable). ISO format, like `release_date`. | [optional] [default to None] +**withdrawn_year** | **i64** | Year corresponding with `withdrawn_date` like `release_year`/`release_date`. | [optional] [default to None] +**ext_ids** | [***models::ReleaseExtIds**](release_ext_ids.md) | | +**volume** | **String** | Volume number of container that this release was published in. Often corresponds to the \"Nth\" year of publication, but can be any string. See guide. | [optional] [default to None] +**issue** | **String** | Issue number of volume/container that this release was published in. Sometimes coresponds to a month number in the year, but can be any string. See guide. | [optional] [default to None] +**pages** | **String** | Either a single page number (\"first page\") or a range of pages separated by a dash (\"-\"). See guide for details. | [optional] [default to None] +**number** | **String** | For, eg, technical reports, which are published in series or assigned some other institutional or container-specific identifier. | [optional] [default to None] +**version** | **String** | For, eg, updated technical reports or software packages, where the version string may be the only field disambiguating between releases. | [optional] [default to None] +**publisher** | **String** | Name, usually English, of the entity or institution responsible for publication of this release. Not necessarily the imprint/brand. See guide. | [optional] [default to None] +**language** | **String** | Primary language of the content of the full release. Two-letter RFC1766/ISO639-1 language code, with some custom extensions/additions. See guide. | [optional] [default to None] +**license_slug** | **String** | Short string (slug) name of license under which release is openly published (if applicable). | [optional] [default to None] +**contribs** | [**Vec<models::ReleaseContrib>**](release_contrib.md) | | [optional] [default to None] +**refs** | [**Vec<models::ReleaseRef>**](release_ref.md) | | [optional] [default to None] +**abstracts** | [**Vec<models::ReleaseAbstract>**](release_abstract.md) | | [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 new file mode 100644 index 0000000..416d595 --- /dev/null +++ b/fatcat-openapi/docs/ReleaseExtIds.md @@ -0,0 +1,22 @@ +# ReleaseExtIds + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**doi** | **String** | Digital Object Identifier (DOI), mostly for published papers and datasets. Should be registered and resolvable via https://doi.org/ | [optional] [default to None] +**wikidata_qid** | **String** | Wikidata entity QID | [optional] [default to None] +**isbn13** | **String** | ISBN-13, for books. Usually not set for chapters. ISBN-10 should be converted to ISBN-13. | [optional] [default to None] +**pmid** | **String** | PubMed Identifier | [optional] [default to None] +**pmcid** | **String** | PubMed Central Identifier | [optional] [default to None] +**core** | **String** | CORE (https://core.ac.uk) identifier | [optional] [default to None] +**arxiv** | **String** | arXiv (https://arxiv.org) identifier; must include version | [optional] [default to None] +**jstor** | **String** | JSTOR work identifier | [optional] [default to None] +**ark** | **String** | ARK identifier | [optional] [default to None] +**mag** | **String** | Microsoft Academic Graph identifier | [optional] [default to None] +**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] + +[[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/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) + + diff --git a/fatcat-openapi/docs/Success.md b/fatcat-openapi/docs/Success.md new file mode 100644 index 0000000..1264ddb --- /dev/null +++ b/fatcat-openapi/docs/Success.md @@ -0,0 +1,11 @@ +# Success + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | | +**message** | **String** | | + +[[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/WebcaptureAutoBatch.md b/fatcat-openapi/docs/WebcaptureAutoBatch.md new file mode 100644 index 0000000..94bfbb2 --- /dev/null +++ b/fatcat-openapi/docs/WebcaptureAutoBatch.md @@ -0,0 +1,11 @@ +# WebcaptureAutoBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**entity_list** | [**Vec<models::WebcaptureEntity>**](webcapture_entity.md) | | + +[[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/WebcaptureCdxLine.md b/fatcat-openapi/docs/WebcaptureCdxLine.md new file mode 100644 index 0000000..9f1ef49 --- /dev/null +++ b/fatcat-openapi/docs/WebcaptureCdxLine.md @@ -0,0 +1,17 @@ +# WebcaptureCdxLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**surt** | **String** | \"Sortable URL\" format. See guide for details. | +**timestamp** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | Date and time of capture, in ISO format. UTC, 'Z'-terminated, second (or better) precision. | +**url** | **String** | Full URL/URI of resource captured. | +**mimetype** | **String** | Mimetype of the resource at this URL. May be the Content-Type header, or the actually sniffed file type. | [optional] [default to None] +**status_code** | **i64** | HTTP status code. Should generally be 200, especially for the primary resource, but may be 3xx (redirect) or even error codes if embedded resources can not be fetched successfully. | [optional] [default to None] +**size** | **i64** | Resource (file) size in bytes | [optional] [default to None] +**sha1** | **String** | SHA-1 hash of data, in hex encoding | +**sha256** | **String** | SHA-256 hash of data, in hex encoding | [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/WebcaptureEntity.md b/fatcat-openapi/docs/WebcaptureEntity.md new file mode 100644 index 0000000..64558c9 --- /dev/null +++ b/fatcat-openapi/docs/WebcaptureEntity.md @@ -0,0 +1,21 @@ +# WebcaptureEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **String** | | [optional] [default to None] +**ident** | **String** | base32-encoded unique identifier | [optional] [default to None] +**revision** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**redirect** | **String** | base32-encoded unique identifier | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. | [optional] [default to None] +**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] +**cdx** | [**Vec<models::WebcaptureCdxLine>**](webcapture_cdx_line.md) | | [optional] [default to None] +**archive_urls** | [**Vec<models::WebcaptureUrl>**](webcapture_url.md) | | [optional] [default to None] +**original_url** | **String** | Base URL of the primary resource this is a capture of | [optional] [default to None] +**timestamp** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | Same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Should generally be the timestamp of capture of the primary resource URL. | [optional] [default to None] +**release_ids** | **Vec<String>** | Set of identifier of release entities this fileset represents a full manifestation of. Usually a single release. | [optional] [default to None] +**releases** | [**Vec<models::ReleaseEntity>**](release_entity.md) | Full release entities, included in GET responses when `releases` included in `expand` parameter. Ignored if included in PUT or POST requests. | [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/WebcaptureUrl.md b/fatcat-openapi/docs/WebcaptureUrl.md new file mode 100644 index 0000000..fd21e92 --- /dev/null +++ b/fatcat-openapi/docs/WebcaptureUrl.md @@ -0,0 +1,11 @@ +# WebcaptureUrl + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **String** | URL/URI pointing to archive of this web resource. | +**rel** | **String** | Type of archive endpoint. Usually `wayback` (WBM replay of primary resource), or `warc` (direct URL to a WARC file containing all resources of the capture). See guide for full list. | + +[[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/WorkAutoBatch.md b/fatcat-openapi/docs/WorkAutoBatch.md new file mode 100644 index 0000000..a508d1d --- /dev/null +++ b/fatcat-openapi/docs/WorkAutoBatch.md @@ -0,0 +1,11 @@ +# WorkAutoBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editgroup** | [***models::Editgroup**](editgroup.md) | | +**entity_list** | [**Vec<models::WorkEntity>**](work_entity.md) | | + +[[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/WorkEntity.md b/fatcat-openapi/docs/WorkEntity.md new file mode 100644 index 0000000..2b31d12 --- /dev/null +++ b/fatcat-openapi/docs/WorkEntity.md @@ -0,0 +1,15 @@ +# WorkEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **String** | | [optional] [default to None] +**ident** | **String** | base32-encoded unique identifier | [optional] [default to None] +**revision** | **String** | UUID (lower-case, dash-separated, hex-encoded 128-bit) | [optional] [default to None] +**redirect** | **String** | base32-encoded unique identifier | [optional] [default to None] +**extra** | [**std::collections::HashMap<String, serde_json::Value>**](AnyType.md) | Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. | [optional] [default to None] +**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] + +[[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 new file mode 100644 index 0000000..5308e84 --- /dev/null +++ b/fatcat-openapi/docs/default_api.md @@ -0,0 +1,3019 @@ +# default_api + +All URIs are relative to *https://api.fatcat.wiki/v0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +**accept_editgroup**](default_api.md#accept_editgroup) | **POST** /editgroup/{editgroup_id}/accept | +**auth_check**](default_api.md#auth_check) | **GET** /auth/check | +**auth_oidc**](default_api.md#auth_oidc) | **POST** /auth/oidc | +**create_auth_token**](default_api.md#create_auth_token) | **POST** /auth/token/{editor_id} | +**create_container**](default_api.md#create_container) | **POST** /editgroup/{editgroup_id}/container | +**create_container_auto_batch**](default_api.md#create_container_auto_batch) | **POST** /editgroup/auto/container/batch | +**create_creator**](default_api.md#create_creator) | **POST** /editgroup/{editgroup_id}/creator | +**create_creator_auto_batch**](default_api.md#create_creator_auto_batch) | **POST** /editgroup/auto/creator/batch | +**create_editgroup**](default_api.md#create_editgroup) | **POST** /editgroup | +**create_editgroup_annotation**](default_api.md#create_editgroup_annotation) | **POST** /editgroup/{editgroup_id}/annotation | +**create_file**](default_api.md#create_file) | **POST** /editgroup/{editgroup_id}/file | +**create_file_auto_batch**](default_api.md#create_file_auto_batch) | **POST** /editgroup/auto/file/batch | +**create_fileset**](default_api.md#create_fileset) | **POST** /editgroup/{editgroup_id}/fileset | +**create_fileset_auto_batch**](default_api.md#create_fileset_auto_batch) | **POST** /editgroup/auto/fileset/batch | +**create_release**](default_api.md#create_release) | **POST** /editgroup/{editgroup_id}/release | +**create_release_auto_batch**](default_api.md#create_release_auto_batch) | **POST** /editgroup/auto/release/batch | +**create_webcapture**](default_api.md#create_webcapture) | **POST** /editgroup/{editgroup_id}/webcapture | +**create_webcapture_auto_batch**](default_api.md#create_webcapture_auto_batch) | **POST** /editgroup/auto/webcapture/batch | +**create_work**](default_api.md#create_work) | **POST** /editgroup/{editgroup_id}/work | +**create_work_auto_batch**](default_api.md#create_work_auto_batch) | **POST** /editgroup/auto/work/batch | +**delete_container**](default_api.md#delete_container) | **DELETE** /editgroup/{editgroup_id}/container/{ident} | +**delete_container_edit**](default_api.md#delete_container_edit) | **DELETE** /editgroup/{editgroup_id}/container/edit/{edit_id} | +**delete_creator**](default_api.md#delete_creator) | **DELETE** /editgroup/{editgroup_id}/creator/{ident} | +**delete_creator_edit**](default_api.md#delete_creator_edit) | **DELETE** /editgroup/{editgroup_id}/creator/edit/{edit_id} | +**delete_file**](default_api.md#delete_file) | **DELETE** /editgroup/{editgroup_id}/file/{ident} | +**delete_file_edit**](default_api.md#delete_file_edit) | **DELETE** /editgroup/{editgroup_id}/file/edit/{edit_id} | +**delete_fileset**](default_api.md#delete_fileset) | **DELETE** /editgroup/{editgroup_id}/fileset/{ident} | +**delete_fileset_edit**](default_api.md#delete_fileset_edit) | **DELETE** /editgroup/{editgroup_id}/fileset/edit/{edit_id} | +**delete_release**](default_api.md#delete_release) | **DELETE** /editgroup/{editgroup_id}/release/{ident} | +**delete_release_edit**](default_api.md#delete_release_edit) | **DELETE** /editgroup/{editgroup_id}/release/edit/{edit_id} | +**delete_webcapture**](default_api.md#delete_webcapture) | **DELETE** /editgroup/{editgroup_id}/webcapture/{ident} | +**delete_webcapture_edit**](default_api.md#delete_webcapture_edit) | **DELETE** /editgroup/{editgroup_id}/webcapture/edit/{edit_id} | +**delete_work**](default_api.md#delete_work) | **DELETE** /editgroup/{editgroup_id}/work/{ident} | +**delete_work_edit**](default_api.md#delete_work_edit) | **DELETE** /editgroup/{editgroup_id}/work/edit/{edit_id} | +**get_changelog**](default_api.md#get_changelog) | **GET** /changelog | +**get_changelog_entry**](default_api.md#get_changelog_entry) | **GET** /changelog/{index} | +**get_container**](default_api.md#get_container) | **GET** /container/{ident} | +**get_container_edit**](default_api.md#get_container_edit) | **GET** /container/edit/{edit_id} | +**get_container_history**](default_api.md#get_container_history) | **GET** /container/{ident}/history | +**get_container_redirects**](default_api.md#get_container_redirects) | **GET** /container/{ident}/redirects | +**get_container_revision**](default_api.md#get_container_revision) | **GET** /container/rev/{rev_id} | +**get_creator**](default_api.md#get_creator) | **GET** /creator/{ident} | +**get_creator_edit**](default_api.md#get_creator_edit) | **GET** /creator/edit/{edit_id} | +**get_creator_history**](default_api.md#get_creator_history) | **GET** /creator/{ident}/history | +**get_creator_redirects**](default_api.md#get_creator_redirects) | **GET** /creator/{ident}/redirects | +**get_creator_releases**](default_api.md#get_creator_releases) | **GET** /creator/{ident}/releases | +**get_creator_revision**](default_api.md#get_creator_revision) | **GET** /creator/rev/{rev_id} | +**get_editgroup**](default_api.md#get_editgroup) | **GET** /editgroup/{editgroup_id} | +**get_editgroup_annotations**](default_api.md#get_editgroup_annotations) | **GET** /editgroup/{editgroup_id}/annotations | +**get_editgroups_reviewable**](default_api.md#get_editgroups_reviewable) | **GET** /editgroup/reviewable | +**get_editor**](default_api.md#get_editor) | **GET** /editor/{editor_id} | +**get_editor_annotations**](default_api.md#get_editor_annotations) | **GET** /editor/{editor_id}/annotations | +**get_editor_editgroups**](default_api.md#get_editor_editgroups) | **GET** /editor/{editor_id}/editgroups | +**get_file**](default_api.md#get_file) | **GET** /file/{ident} | +**get_file_edit**](default_api.md#get_file_edit) | **GET** /file/edit/{edit_id} | +**get_file_history**](default_api.md#get_file_history) | **GET** /file/{ident}/history | +**get_file_redirects**](default_api.md#get_file_redirects) | **GET** /file/{ident}/redirects | +**get_file_revision**](default_api.md#get_file_revision) | **GET** /file/rev/{rev_id} | +**get_fileset**](default_api.md#get_fileset) | **GET** /fileset/{ident} | +**get_fileset_edit**](default_api.md#get_fileset_edit) | **GET** /fileset/edit/{edit_id} | +**get_fileset_history**](default_api.md#get_fileset_history) | **GET** /fileset/{ident}/history | +**get_fileset_redirects**](default_api.md#get_fileset_redirects) | **GET** /fileset/{ident}/redirects | +**get_fileset_revision**](default_api.md#get_fileset_revision) | **GET** /fileset/rev/{rev_id} | +**get_release**](default_api.md#get_release) | **GET** /release/{ident} | +**get_release_edit**](default_api.md#get_release_edit) | **GET** /release/edit/{edit_id} | +**get_release_files**](default_api.md#get_release_files) | **GET** /release/{ident}/files | +**get_release_filesets**](default_api.md#get_release_filesets) | **GET** /release/{ident}/filesets | +**get_release_history**](default_api.md#get_release_history) | **GET** /release/{ident}/history | +**get_release_redirects**](default_api.md#get_release_redirects) | **GET** /release/{ident}/redirects | +**get_release_revision**](default_api.md#get_release_revision) | **GET** /release/rev/{rev_id} | +**get_release_webcaptures**](default_api.md#get_release_webcaptures) | **GET** /release/{ident}/webcaptures | +**get_webcapture**](default_api.md#get_webcapture) | **GET** /webcapture/{ident} | +**get_webcapture_edit**](default_api.md#get_webcapture_edit) | **GET** /webcapture/edit/{edit_id} | +**get_webcapture_history**](default_api.md#get_webcapture_history) | **GET** /webcapture/{ident}/history | +**get_webcapture_redirects**](default_api.md#get_webcapture_redirects) | **GET** /webcapture/{ident}/redirects | +**get_webcapture_revision**](default_api.md#get_webcapture_revision) | **GET** /webcapture/rev/{rev_id} | +**get_work**](default_api.md#get_work) | **GET** /work/{ident} | +**get_work_edit**](default_api.md#get_work_edit) | **GET** /work/edit/{edit_id} | +**get_work_history**](default_api.md#get_work_history) | **GET** /work/{ident}/history | +**get_work_redirects**](default_api.md#get_work_redirects) | **GET** /work/{ident}/redirects | +**get_work_releases**](default_api.md#get_work_releases) | **GET** /work/{ident}/releases | +**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_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} | +**update_creator**](default_api.md#update_creator) | **PUT** /editgroup/{editgroup_id}/creator/{ident} | +**update_editgroup**](default_api.md#update_editgroup) | **PUT** /editgroup/{editgroup_id} | +**update_editor**](default_api.md#update_editor) | **PUT** /editor/{editor_id} | +**update_file**](default_api.md#update_file) | **PUT** /editgroup/{editgroup_id}/file/{ident} | +**update_fileset**](default_api.md#update_fileset) | **PUT** /editgroup/{editgroup_id}/fileset/{ident} | +**update_release**](default_api.md#update_release) | **PUT** /editgroup/{editgroup_id}/release/{ident} | +**update_webcapture**](default_api.md#update_webcapture) | **PUT** /editgroup/{editgroup_id}/webcapture/{ident} | +**update_work**](default_api.md#update_work) | **PUT** /editgroup/{editgroup_id}/work/{ident} | + + +# **accept_editgroup** +> models::Success accept_editgroup(ctx, editgroup_id) + + +Accept (\"merge\") the given editgroup into the catalog. The editgroup must be open (not already accepted), and the editor making this request must have the `admin` role. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| base32-encoded unique identifier | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **auth_check** +> models::Success auth_check(ctx, optional) + + +Verify that authentication (API token) is working as expected. The optional `role` parameter can be used to verify that the current account (editor) has permissions for the given role. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **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 +------------- | ------------- | ------------- | ------------- + **role** | **String**| | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **auth_oidc** +> models::AuthOidcResult auth_oidc(ctx, auth_oidc) + + +Login or create editor account using OIDC metadata (internal method). This method is used by privileged front-end tools (like the web interface service) to process editor logins using OpenID Connect (OIDC) and/or OAuth. Most accounts (including tool and bot accounts) do not have sufficient privileges to call this method, which requires the `admin` role. The method returns an API token; the HTTP status code indicates whether an existing account was logged in, or a new account was created. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **auth_oidc** | [**AuthOidc**](AuthOidc.md)| | + +### Return type + +[**models::AuthOidcResult**](auth_oidc_result.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_auth_token** +> models::AuthTokenResult create_auth_token(ctx, editor_id, optional) + + +Generate a new auth token for a given editor (internal method). This method is used by the web interface to generate API tokens for users. It can not be called by editors (human or bot) to generate new tokens for themselves, at least at this time. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editor_id** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **editor_id** | **String**| | + **duration_seconds** | **i32**| How long API token should be valid for (in seconds) | + +### Return type + +[**models::AuthTokenResult**](auth_token_result.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **create_container** +> models::EntityEdit create_container(ctx, editgroup_id, container_entity) + + +Create a single Container entity as part of an existing editgroup. Editgroup must be mutable (aka, not accepted) and editor must have permission (aka, have created the editgroup or have `admin` role). + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **container_entity** | [**ContainerEntity**](ContainerEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_container_auto_batch** +> models::Editgroup create_container_auto_batch(ctx, container_auto_batch) + + +Create a set of Container entities as part of a new editgroup, and accept that editgroup in the same atomic request. This method is mostly useful for bulk import of new entities by carefully written bots. This method is more efficient than creating an editgroup, several entities, then accepting the editgroup, both in terms of API requests required and database load. Requires `admin` role. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **container_auto_batch** | [**ContainerAutoBatch**](ContainerAutoBatch.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_creator** +> models::EntityEdit create_creator(ctx, editgroup_id, creator_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **creator_entity** | [**CreatorEntity**](CreatorEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_creator_auto_batch** +> models::Editgroup create_creator_auto_batch(ctx, creator_auto_batch) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **creator_auto_batch** | [**CreatorAutoBatch**](CreatorAutoBatch.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_editgroup** +> models::Editgroup create_editgroup(ctx, editgroup) + + +Creates a new editgroup. By default the editor making this request will be the author of the editgroup. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup** | [**Editgroup**](Editgroup.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_editgroup_annotation** +> models::EditgroupAnnotation create_editgroup_annotation(ctx, editgroup_id, editgroup_annotation) + + +Submits a new annotation to the specified editgroup. The editgroup must be open (not already accepted). The annotation will automatically have authorship of the editor making this request. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| base32-encoded unique identifier | + **editgroup_annotation** | [**EditgroupAnnotation**](EditgroupAnnotation.md)| | + +### Return type + +[**models::EditgroupAnnotation**](editgroup_annotation.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_file** +> models::EntityEdit create_file(ctx, editgroup_id, file_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **file_entity** | [**FileEntity**](FileEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_file_auto_batch** +> models::Editgroup create_file_auto_batch(ctx, file_auto_batch) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **file_auto_batch** | [**FileAutoBatch**](FileAutoBatch.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_fileset** +> models::EntityEdit create_fileset(ctx, editgroup_id, fileset_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **fileset_entity** | [**FilesetEntity**](FilesetEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_fileset_auto_batch** +> models::Editgroup create_fileset_auto_batch(ctx, fileset_auto_batch) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **fileset_auto_batch** | [**FilesetAutoBatch**](FilesetAutoBatch.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_release** +> models::EntityEdit create_release(ctx, editgroup_id, release_entity) + + +Create a single Release entity as part of an existing editgroup. If the `work_id` field is not set, a work entity will be created automatically and this field set pointing to the new work. Editgroup must be mutable (aka, not accepted) and editor must have permission (aka, have created the editgrou p or have `admin` role). + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **release_entity** | [**ReleaseEntity**](ReleaseEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_release_auto_batch** +> models::Editgroup create_release_auto_batch(ctx, release_auto_batch) + + +Create a set of Release entities as part of a new editgroup, and accept that editgroup in the same atomic request. This method is mostly useful for bulk import of new entities by carefully written bots. This method is more efficient than creating an editgroup, several entities, then accepting the editgroup, both in terms of API requests required and database load. Requires `admin` role. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **release_auto_batch** | [**ReleaseAutoBatch**](ReleaseAutoBatch.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_webcapture** +> models::EntityEdit create_webcapture(ctx, editgroup_id, webcapture_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **webcapture_entity** | [**WebcaptureEntity**](WebcaptureEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_webcapture_auto_batch** +> models::Editgroup create_webcapture_auto_batch(ctx, webcapture_auto_batch) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **webcapture_auto_batch** | [**WebcaptureAutoBatch**](WebcaptureAutoBatch.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_work** +> models::EntityEdit create_work(ctx, editgroup_id, work_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **work_entity** | [**WorkEntity**](WorkEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **create_work_auto_batch** +> models::Editgroup create_work_auto_batch(ctx, work_auto_batch) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **work_auto_batch** | [**WorkAutoBatch**](WorkAutoBatch.md)| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **delete_container** +> models::EntityEdit delete_container(ctx, editgroup_id, ident) + + +Creates a new \"deletion\" edit for a specific entity as part of an existing editgroup. This is not the method to use to remove an edit from an editgroup; for that use `delete_container_edit`. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_container_edit** +> models::Success delete_container_edit(ctx, editgroup_id, edit_id) + + +Removes a single edit from the specified editgroup. The editgroup must be mutable (aka, not accepted/merged), and the editor making this request must have permission (aka, have created the editgroup or hold the `admin` role). Not to be confused with the `delete_container` method, which *creates* a new edit in the given editgroup. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_creator** +> models::EntityEdit delete_creator(ctx, editgroup_id, ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_creator_edit** +> models::Success delete_creator_edit(ctx, editgroup_id, edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_file** +> models::EntityEdit delete_file(ctx, editgroup_id, ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_file_edit** +> models::Success delete_file_edit(ctx, editgroup_id, edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_fileset** +> models::EntityEdit delete_fileset(ctx, editgroup_id, ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_fileset_edit** +> models::Success delete_fileset_edit(ctx, editgroup_id, edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_release** +> models::EntityEdit delete_release(ctx, editgroup_id, ident) + + +Creates a new \"deletion\" edit for a specific entity as part of an existing editgroup. This is not the method to use to remove an edit from an editgroup; for that use `delete_release_edit`. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_release_edit** +> models::Success delete_release_edit(ctx, editgroup_id, edit_id) + + +Removes a single edit from the specified editgroup. The editgroup must be mutable (aka, not accepted/merged), and the editor making this request must have permission (aka, have created the editgroup or hold the `admin` role). Not to be confused with the `delete_container` method, which *creates* a new edit in the given editgroup. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_webcapture** +> models::EntityEdit delete_webcapture(ctx, editgroup_id, ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_webcapture_edit** +> models::Success delete_webcapture_edit(ctx, editgroup_id, edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_work** +> models::EntityEdit delete_work(ctx, editgroup_id, ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **delete_work_edit** +> models::Success delete_work_edit(ctx, editgroup_id, edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::Success**](success.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### 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) + +# **get_changelog** +> Vec<models::ChangelogEntry> get_changelog(optional) + + +Returns a list of the most recent changelog entries accepted (merged) into the catalog. List is sorted by changelog index in descending order. Note that the accepted timestamp roughly corresponds to order, but not strictly; there exist out-of-order timestamps on the order of several seconds. As a known database issue, it is technically possible for there to be a gap in changelog index numbers (aka, a missing changelog entry). There are no currently known gaps and this is considered a bug that will be addressed. There are millions of entries; to paginate through all of them, use this method to discover the highest existing entry number, then request the entries using `get_changelog_entry` one at a time. + +### 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 +------------- | ------------- | ------------- | ------------- + **limit** | **i64**| Maximum count of changelog entries to return in response | + +### Return type + +[**Vec<models::ChangelogEntry>**](changelog_entry.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) + +# **get_changelog_entry** +> models::ChangelogEntry get_changelog_entry(index) + + +Returns a single changelog entry. As a known database issue, it is technically possible for there to be a gap in changelog index numbers (aka, a missing changelog entry). There are no currently known gaps and this is considered a bug that will be addressed. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index** | **i64**| Changelog index of entry to return | + +### Return type + +[**models::ChangelogEntry**](changelog_entry.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) + +# **get_container** +> models::ContainerEntity get_container(ident, optional) + + +Fetches a single container entity from the catalog. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. For containers, none accepted (yet). | + **hide** | **String**| List of entity fields to elide in response. For containers, none accepted (yet). | + +### Return type + +[**models::ContainerEntity**](container_entity.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) + +# **get_container_edit** +> models::EntityEdit get_container_edit(edit_id) + + +Returns the entity edit object with the given identifier. This method is expected to be used rarely. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::EntityEdit**](entity_edit.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) + +# **get_container_history** +> Vec<models::EntityHistoryEntry> get_container_history(ident, optional) + + +Fetches the history of accepted edits (changelog entries) for a specific entity fatcat identifier. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **limit** | **i64**| Maximum number of changelog entries to return | + +### Return type + +[**Vec<models::EntityHistoryEntry>**](entity_history_entry.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) + +# **get_container_redirects** +> Vec<String> get_container_redirects(ident) + + +Returns the set of entity identifiers which currently redirect to this identifier. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + +### Return type + +[**Vec<String>**](string.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) + +# **get_container_revision** +> models::ContainerEntity get_container_revision(rev_id, optional) + + +Fetches a specific entity revision. Note that the returned revision will not be associated with any particular fatcat identifier (even if one or more identifiers do currently point to this revision). The revision may even be part of an un-merged editgroup. Revisions are immutable and can not be deleted or updated. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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 +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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`. | + +### Return type + +[**models::ContainerEntity**](container_entity.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) + +# **get_creator** +> models::CreatorEntity get_creator(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. For creators, none accepted (yet). | + **hide** | **String**| List of entity fields to elide in response. For creators, none accepted (yet). | + +### Return type + +[**models::CreatorEntity**](creator_entity.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) + +# **get_creator_edit** +> models::EntityEdit get_creator_edit(edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::EntityEdit**](entity_edit.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) + +# **get_creator_history** +> Vec<models::EntityHistoryEntry> get_creator_history(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **limit** | **i64**| | + +### Return type + +[**Vec<models::EntityHistoryEntry>**](entity_history_entry.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) + +# **get_creator_redirects** +> Vec<String> get_creator_redirects(ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + +### Return type + +[**Vec<String>**](string.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) + +# **get_creator_releases** +> Vec<models::ReleaseEntity> get_creator_releases(ident, optional) + + +Returns the set of Release entities having a `contrib` entry pointing to the creator entity. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **hide** | **String**| List of entity fields to elide in response. See `get_release`. | + +### Return type + +[**Vec<models::ReleaseEntity>**](release_entity.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) + +# **get_creator_revision** +> models::CreatorEntity get_creator_revision(rev_id, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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 +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **expand** | **String**| List of sub-entities to expand in response. See `get_creator`, though note that identifier-based expansions (like `releases`) will always be empty for revisions. | + **hide** | **String**| List of entity fields to elide in response. See `get_creator`. | + +### Return type + +[**models::CreatorEntity**](creator_entity.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) + +# **get_editgroup** +> models::Editgroup get_editgroup(editgroup_id) + + +Returns a single editgroup object. Unlike some similar methods, this method will return a full/expanded editgroup object, which includes edit lists of each entity type (though will not include the complete entity objects). + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **editgroup_id** | **String**| base32-encoded unique identifier | + +### Return type + +[**models::Editgroup**](editgroup.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) + +# **get_editgroup_annotations** +> Vec<models::EditgroupAnnotation> get_editgroup_annotations(editgroup_id, optional) + + +Returns a list of annotations made to a specific editgroup. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **editgroup_id** | **String**| base32-encoded unique identifier | + **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 +------------- | ------------- | ------------- | ------------- + **editgroup_id** | **String**| base32-encoded unique identifier | + **expand** | **String**| List of sub-entities to expand in response. For editgroup annotations: 'editors' | + +### Return type + +[**Vec<models::EditgroupAnnotation>**](editgroup_annotation.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) + +# **get_editgroups_reviewable** +> Vec<models::Editgroup> get_editgroups_reviewable(optional) + + +Returns a set of editgroups which have been submitted but not yet accepted. Query parameters can be used to sort and paginate the list returned. + +### 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 +------------- | ------------- | ------------- | ------------- + **expand** | **String**| List of sub-entities to expand in response. For editgroups: 'editors' | + **limit** | **i64**| Maximum number of reviewable editgroups to return in response | + **before** | **chrono::DateTime::<chrono::Utc>**| Return only reviewable editgroups submitted *before* the given timestamp (not inclusive). Editgroups will be sorted by submission time in descending order (most recent first). For use in pagination. | + **since** | **chrono::DateTime::<chrono::Utc>**| Return only reviewable editgroups submitted *after* the given timestamp (not inclusive). Editgroups will be sorted by submission time in ascending order (most recent last). For use in pagination. | + +### Return type + +[**Vec<models::Editgroup>**](editgroup.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) + +# **get_editor** +> models::Editor get_editor(editor_id) + + +Returns an editor object, including metadata such as the username, type, and role of editor. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **editor_id** | **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) + +# **get_editor_annotations** +> Vec<models::EditgroupAnnotation> get_editor_annotations(editor_id, optional) + + +Fetches a list of annotations made by a particular editor. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **editor_id** | **String**| base32-encoded unique identifier | + **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 +------------- | ------------- | ------------- | ------------- + **editor_id** | **String**| base32-encoded unique identifier | + **limit** | **i64**| Maximum number (count) of annotations to return in response | + **before** | **chrono::DateTime::<chrono::Utc>**| Return only annotations made *before* the given timestamp (not inclusive). Annotations will be sorted by creation time in descending order (most recent first). For use in pagination. | + **since** | **chrono::DateTime::<chrono::Utc>**| Return only annotations made *after* the given timestamp (not inclusive). Annotations will be sorted by creation time in ascending order (most recent last). For use in pagination. | + +### Return type + +[**Vec<models::EditgroupAnnotation>**](editgroup_annotation.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) + +# **get_editor_editgroups** +> Vec<models::Editgroup> get_editor_editgroups(editor_id, optional) + + +Returns a set of editgroups created by the given editor, regardless of the status (accepted/submitted) of the editgroups. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **editor_id** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **editor_id** | **String**| | + **limit** | **i64**| | + **before** | **chrono::DateTime::<chrono::Utc>**| Return only editgroups created *before* the given timestamp (not inclusive). Editgroups will be sorted by creation time in descending order (most recent first). For use in pagination. | + **since** | **chrono::DateTime::<chrono::Utc>**| Return only editgroups created *after* the given timestamp (not inclusive). Editgroups will be sorted by creation time in ascending order (most recent last). For use in pagination. | + +### Return type + +[**Vec<models::Editgroup>**](editgroup.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) + +# **get_file** +> models::FileEntity get_file(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. For files, `releases` is accepted. | + **hide** | **String**| List of entity fields to elide in response. For files, none accepted (yet). | + +### Return type + +[**models::FileEntity**](file_entity.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) + +# **get_file_edit** +> models::EntityEdit get_file_edit(edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::EntityEdit**](entity_edit.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) + +# **get_file_history** +> Vec<models::EntityHistoryEntry> get_file_history(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **limit** | **i64**| | + +### Return type + +[**Vec<models::EntityHistoryEntry>**](entity_history_entry.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) + +# **get_file_redirects** +> Vec<String> get_file_redirects(ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + +### Return type + +[**Vec<String>**](string.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) + +# **get_file_revision** +> models::FileEntity get_file_revision(rev_id, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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 +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **expand** | **String**| List of sub-entities to expand in response. See `get_file`. | + **hide** | **String**| List of entity fields to elide in response. See `get_file`. | + +### Return type + +[**models::FileEntity**](file_entity.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) + +# **get_fileset** +> models::FilesetEntity get_fileset(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. For filesets, `releases` is accepted. | + **hide** | **String**| List of entity fields to elide in response. For filesets, 'manifest' is accepted. | + +### Return type + +[**models::FilesetEntity**](fileset_entity.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) + +# **get_fileset_edit** +> models::EntityEdit get_fileset_edit(edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::EntityEdit**](entity_edit.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) + +# **get_fileset_history** +> Vec<models::EntityHistoryEntry> get_fileset_history(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **limit** | **i64**| | + +### Return type + +[**Vec<models::EntityHistoryEntry>**](entity_history_entry.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) + +# **get_fileset_redirects** +> Vec<String> get_fileset_redirects(ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + +### Return type + +[**Vec<String>**](string.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) + +# **get_fileset_revision** +> models::FilesetEntity get_fileset_revision(rev_id, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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 +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **expand** | **String**| List of sub-entities to expand in response. See `get_fileset`. | + **hide** | **String**| List of entity fields to elide in response. See `get_fileset`. | + +### Return type + +[**models::FilesetEntity**](fileset_entity.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) + +# **get_release** +> models::ReleaseEntity get_release(ident, optional) + + +Fetches a single Release entity from the catalog. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. For releases, 'files', 'filesets, 'webcaptures', 'container', and 'creators' are valid. | + **hide** | **String**| List of entity fields to elide in response (for efficiency). For releases, 'abstracts', 'refs', and 'contribs' are valid. | + +### Return type + +[**models::ReleaseEntity**](release_entity.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) + +# **get_release_edit** +> models::EntityEdit get_release_edit(edit_id) + + +Returns the entity edit object with the given identifier. This method is expected to be used rarely. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::EntityEdit**](entity_edit.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) + +# **get_release_files** +> Vec<models::FileEntity> get_release_files(ident, optional) + + +Returns the set of File entities that have a `release_id` pointing to this release entity. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **hide** | **String**| List of entity fields to elide in response. See `get_file`. | + +### Return type + +[**Vec<models::FileEntity>**](file_entity.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) + +# **get_release_filesets** +> Vec<models::FilesetEntity> get_release_filesets(ident, optional) + + +Returns the set of Fileset entities that have a `release_id` pointing to this release entity. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **hide** | **String**| List of entity fields to elide in response. See `get_fileset`. | + +### Return type + +[**Vec<models::FilesetEntity>**](fileset_entity.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) + +# **get_release_history** +> Vec<models::EntityHistoryEntry> get_release_history(ident, optional) + + +Fetches the history of accepted edits (changelog entries) for a specific entity fatcat identifier. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **limit** | **i64**| | + +### Return type + +[**Vec<models::EntityHistoryEntry>**](entity_history_entry.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) + +# **get_release_redirects** +> Vec<String> get_release_redirects(ident) + + +Returns the set of entity identifiers which currently redirect to this identifier. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + +### Return type + +[**Vec<String>**](string.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) + +# **get_release_revision** +> models::ReleaseEntity get_release_revision(rev_id, optional) + + +Fetches a specific entity revision. Note that the returned revision will not be associated with any particular fatcat identifier (even if one or more identifiers do currently point to this revision). The revision may even be part of an un-merged editgroup. Revisions are immutable and can not be deleted or updated. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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 +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **expand** | **String**| List of sub-entities to expand in response. See `get_release`, though note that identifier-based exapansions like `file` will always be empty for revisions. | + **hide** | **String**| List of entity fields to elide in response. See `get_release`. | + +### Return type + +[**models::ReleaseEntity**](release_entity.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) + +# **get_release_webcaptures** +> Vec<models::WebcaptureEntity> get_release_webcaptures(ident, optional) + + +Returns the set of Web Capture entities that have a `release_id` pointing to this release entity. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **hide** | **String**| List of entity fields to elide in response. See `get_webcapture`. | + +### Return type + +[**Vec<models::WebcaptureEntity>**](webcapture_entity.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) + +# **get_webcapture** +> models::WebcaptureEntity get_webcapture(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. For webcaptures, `releases` is accepted. | + **hide** | **String**| List of entity fields to elide in response. For webcaptures, 'cdx' is accepted. | + +### Return type + +[**models::WebcaptureEntity**](webcapture_entity.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) + +# **get_webcapture_edit** +> models::EntityEdit get_webcapture_edit(edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::EntityEdit**](entity_edit.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) + +# **get_webcapture_history** +> Vec<models::EntityHistoryEntry> get_webcapture_history(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **limit** | **i64**| | + +### Return type + +[**Vec<models::EntityHistoryEntry>**](entity_history_entry.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) + +# **get_webcapture_redirects** +> Vec<String> get_webcapture_redirects(ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + +### Return type + +[**Vec<String>**](string.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) + +# **get_webcapture_revision** +> models::WebcaptureEntity get_webcapture_revision(rev_id, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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 +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **expand** | **String**| List of sub-entities to expand in response. See `get_webcapture`. | + **hide** | **String**| List of entity fields to elide in response. See `get_webcapture`. | + +### Return type + +[**models::WebcaptureEntity**](webcapture_entity.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) + +# **get_work** +> models::WorkEntity get_work(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. For works, none accepted (yet). | + **hide** | **String**| List of entity fields to elide in response. For works, none accepted (yet). | + +### Return type + +[**models::WorkEntity**](work_entity.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) + +# **get_work_edit** +> models::EntityEdit get_work_edit(edit_id) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edit_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + +### Return type + +[**models::EntityEdit**](entity_edit.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) + +# **get_work_history** +> Vec<models::EntityHistoryEntry> get_work_history(ident, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **limit** | **i64**| | + +### Return type + +[**Vec<models::EntityHistoryEntry>**](entity_history_entry.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) + +# **get_work_redirects** +> Vec<String> get_work_redirects(ident) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + +### Return type + +[**Vec<String>**](string.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) + +# **get_work_releases** +> Vec<models::ReleaseEntity> get_work_releases(ident, optional) + + +Returns the set of release entities that are part of this work (aka, have `work_id` pointing to this work entity). + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **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 +------------- | ------------- | ------------- | ------------- + **ident** | **String**| | + **hide** | **String**| List of entity fields to elide in response. See `get_release`. | + +### Return type + +[**Vec<models::ReleaseEntity>**](release_entity.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) + +# **get_work_revision** +> models::WorkEntity get_work_revision(rev_id, optional) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **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 +------------- | ------------- | ------------- | ------------- + **rev_id** | **String**| UUID (lower-case, dash-separated, hex-encoded 128-bit) | + **expand** | **String**| List of sub-entities to expand in response. See `get_work`, though note that identifier-based expansions like `releases` will always be empty for revisions. | + **hide** | **String**| List of entity fields to elide in response. See `get_work`. | + +### Return type + +[**models::WorkEntity**](work_entity.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_container** +> models::ContainerEntity lookup_container(optional) + + +Looks for an active entity with the given external identifier. If any such entity is found, returns a single complete entity. If multiple entities have the same external identifier, this is considered a soft catalog error, and the behavior of which entity is returned is undefined. One (and only one) external 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 +------------- | ------------- | ------------- | ------------- + **issnl** | **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`. | + +### Return type + +[**models::ContainerEntity**](container_entity.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_creator** +> models::CreatorEntity lookup_creator(optional) + + +### 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 +------------- | ------------- | ------------- | ------------- + **orcid** | **String**| ORCiD (https://orcid.org) identifier | + **wikidata_qid** | **String**| | + **expand** | **String**| List of sub-entities to expand in response. See `get_creator`. | + **hide** | **String**| List of entity fields to elide in response. See `get_creator`. | + +### Return type + +[**models::CreatorEntity**](creator_entity.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) + + +### 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 +------------- | ------------- | ------------- | ------------- + **md5** | **String**| MD5 hash of data, in hex encoding | + **sha1** | **String**| SHA-1 hash of data, in hex encoding | + **sha256** | **String**| SHA-256 hash of data, in hex encoding | + **expand** | **String**| List of sub-entities to expand in response. See `get_file`. | + **hide** | **String**| List of entity fields to elide in response. See `get_file`. | + +### Return type + +[**models::FileEntity**](file_entity.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_release** +> models::ReleaseEntity lookup_release(optional) + + +Looks for an active entity with the given external identifier. If any such entity is found, returns a single complete entity. If multiple entities have the same external identifier, this is considered a soft catalog error, and the behavior of which entity is returned is undefined. One (and only one) external 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 +------------- | ------------- | ------------- | ------------- + **doi** | **String**| | + **wikidata_qid** | **String**| | + **isbn13** | **String**| | + **pmid** | **String**| | + **pmcid** | **String**| | + **core** | **String**| | + **arxiv** | **String**| | + **jstor** | **String**| | + **ark** | **String**| | + **mag** | **String**| | + **doaj** | **String**| | + **dblp** | **String**| | + **oai** | **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`. | + +### Return type + +[**models::ReleaseEntity**](release_entity.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) + +# **update_container** +> models::EntityEdit update_container(ctx, editgroup_id, ident, container_entity) + + +Updates an existing entity as part of a specific (existing) editgroup. The editgroup must be open for updates (aka, not accepted/merged), and the editor making the request must have permissions (aka, must have created the editgroup or have `admin` role). This method can also be used to update an existing entity edit as part of an editgroup. For example, if an entity was created in this editgroup, an editor could make changes to the new entity's metadata before merging. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + **container_entity** | [**ContainerEntity**](ContainerEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_creator** +> models::EntityEdit update_creator(ctx, editgroup_id, ident, creator_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + **creator_entity** | [**CreatorEntity**](CreatorEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_editgroup** +> models::Editgroup update_editgroup(ctx, editgroup_id, editgroup, optional) + + +Updates metadata for a single editgroup object. Note that only metadata fields such as the `description` or `extra` metadata can be changed with this method; it does not allow adding or removing edits to the editgroup (for that use the individual entity create/update/delete methods). + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| base32-encoded unique identifier | + **editgroup** | [**Editgroup**](Editgroup.md)| | + **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 +------------- | ------------- | ------------- | ------------- + **editgroup_id** | **String**| base32-encoded unique identifier | + **editgroup** | [**Editgroup**](Editgroup.md)| | + **submit** | **bool**| | + +### Return type + +[**models::Editgroup**](editgroup.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_editor** +> models::Editor update_editor(ctx, editor_id, editor) + + +Allows metadata changes to some editor fields, such as the username. Changes require authentication and permissions. An editor can change their own username; changes to role flags require the `admin` role by the editor making the request. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editor_id** | **String**| | + **editor** | [**Editor**](Editor.md)| | + +### Return type + +[**models::Editor**](editor.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_file** +> models::EntityEdit update_file(ctx, editgroup_id, ident, file_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + **file_entity** | [**FileEntity**](FileEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_fileset** +> models::EntityEdit update_fileset(ctx, editgroup_id, ident, fileset_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + **fileset_entity** | [**FilesetEntity**](FilesetEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_release** +> models::EntityEdit update_release(ctx, editgroup_id, ident, release_entity) + + +Updates an existing entity as part of a specific (existing) editgroup. The editgroup must be open for updates (aka, not accepted/merged), and the editor making the requiest must have permissions (aka, must have created the editgroup or have `admin` role). This method can also be used to update an existing entity edit as part of an editgroup. For example, if an entity was created in this editgroup, an editor could make changes to the new entity's metadata before merging. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + **release_entity** | [**ReleaseEntity**](ReleaseEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_webcapture** +> models::EntityEdit update_webcapture(ctx, editgroup_id, ident, webcapture_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + **webcapture_entity** | [**WebcaptureEntity**](WebcaptureEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **update_work** +> models::EntityEdit update_work(ctx, editgroup_id, ident, work_entity) + + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context containing the authentication | nil if no authentication + **editgroup_id** | **String**| | + **ident** | **String**| | + **work_entity** | [**WorkEntity**](WorkEntity.md)| | + +### Return type + +[**models::EntityEdit**](entity_edit.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + |