--- swagger: "2.0" info: description: "Fatcat is a scalable, versioned, API-oriented catalog of bibliographic\n\ entities and file metadata.\n\n\nThese API reference\ \ documents, along with client software libraries, are\ngenerated automatically\ \ from an OpenAPI 2.0 (\"Swagger\") definition file.\n\n## Introduction\n\n\n\ A higher-level introduction to the API, as well as a description of the\nfatcat\ \ data model, are available in [\"The Fatcat Guide\"](https://guide.fatcat.wiki/).\n\ The guide also includes a [Cookbook](https://guide.fatcat.wiki/cookbook.html)\n\ section demonstrating end-to-end tasks like creating entities as part of\neditgroups,\ \ or safely merging duplicate entities.\n\n### Expectations and Best Practices\n\ \nA test/staging QA API instance of fatcat is available at\n.\ \ The database backing this instance is\nseparate from the production interface,\ \ and is periodically rebuilt from\nsnapshots of the full production database,\ \ meaning that edits on the QA\nserver will *NOT* persist, and that semantics\ \ like the changelog index\nmonotonically increasing *MAY* be broken. Developers\ \ are expexcted to test\ntheir scripts and tools against the QA instance before\ \ running against\nproduction.\n\nFatcat is made available as a gratis (no cost)\ \ and libre (freedom\npreserving) service to the public, with limited funding\ \ and resources. We\nwelcome new and unforseen uses and contributions, but may\ \ need to impose\nrestrictions (like rate-limits) to keep the service functional\ \ for other\nusers, and in extreme cases reserve the option to block accounts\ \ and IP\nranges if necessary to keep the service operational.\n\nThe Internet\ \ Archive owns and operates it's own server equipment and data\ncenters, and operations\ \ are optimized for low-cost, not high-availability.\nUsers and partners should\ \ expect some downtime on the fatcat API, on the\norder of hours a month.\n\n\ Periodic metadata exports are available for batch processing, and database\nsnapshots\ \ can be used to create locally-hosted mirrors of the service for\nmore intensive\ \ and reliable querying.\n\n### Other Nitty Gritties\n\nCross-origin requests\ \ are allowed for the API service, to enable third\nparties to bulid in-browser\ \ applications.\n\nA metadata search service is available at \ \ (and\n). The API is currently the raw\nelasticsearch\ \ API, with only GET (read) requests allowed. This public\nservice is experimental\ \ and may be removed or limited in the future.\n\n## Authentication\n\nThe API\ \ allows basic read-only \"GET\" HTTP requests with no authentication.\nProposing\ \ changes to the metadata, or other mutating requests (\"PUT\",\n\"POST\", \"\ DELETE\") all require authentication, and some operations require\nadditional\ \ account permissions.\n\nEnd-user account creation and login happens through\ \ the web interface. From\na logged-in editor profile page, you can generate a\ \ API token. Tokens are\n\"macaroons\", similar to JWT tokens, and are used for\ \ all API\nauthentication. The web interface includes macaroons in browser cookies\ \ and\npasses them through to the API to authenticate editor actions.\n\n\n\n" version: "0.3.1" title: "fatcat" termsOfService: "https://guide.fatcat.wiki/policies.html" contact: name: "Internet Archive Web Group" url: "https://fatcat.wiki" email: "webservices@archive.org" x-logo: url: "https://fatcat.wiki/static/paper_man_confused.gif" altText: "Confused Papers Man (Logo)" backgroundColor: "#FFFFFF" host: "api.fatcat.wiki" basePath: "/v0" tags: - name: "containers" description: "**Container** entities represent publication venues like journals,\ \ # TAGLINE\nconference proceedings, book series, or blogs. They group publications\ \ # TAGLINE\n(\"releases\"). # TAGLINE\n\nSee the \"Catalog Style Guide\" section\ \ of the guide for details and # TAGLINE\nsemantics of what should be included\ \ in specific entity fields. # TAGLINE\nSpecifically, the # TAGLINE\n[Container\ \ Entity Reference](https://guide.fatcat.wiki/entity_container.html). # TAGLINE\n" x-displayName: "Containers" - name: "creators" description: "**Creator** entities represent individuals (or organizations, or other\ \ # TAGLINE\nagents) who contribute to the creation of specific releases # TAGLINE\n\ (publications). # TAGLINE\n\nSee the \"Catalog Style Guide\" section of the guide\ \ for details and # TAGLINE\nsemantics of what should be included in specific\ \ entity fields. # TAGLINE\nSpecifically, the # TAGLINE\n[Creator Entity Reference](https://guide.fatcat.wiki/entity_creator.html).\ \ # TAGLINE\n" x-displayName: "Creators" - name: "files" description: "**File** entities represent unique digital files which are full #\ \ TAGLINE\nmanifestations of specific releases (publications), such as fulltext\ \ PDF # TAGLINE\nfiles, JATS XML documents, or video files. File entities also\ \ include a # TAGLINE\nset of locations where they can be found on the public\ \ web. # TAGLINE\n\nSee the \"Catalog Style Guide\" section of the guide for\ \ details and # TAGLINE\nsemantics of what should be included in specific entity\ \ fields. # TAGLINE\nSpecifically, the # TAGLINE\n[File Entity Reference](https://guide.fatcat.wiki/entity_file.html).\ \ # TAGLINE\n" x-displayName: "Files" - name: "filesets" description: "**Fileset** entities represent sets of digital files, as well as locations\ \ # TAGLINE\nwhere they can be found on the public web. Filesets most commonly\ \ # TAGLINE\nrepresent datasets consisting of serveral data and metadata files.\ \ # TAGLINE\n\nSee the \"Catalog Style Guide\" section of the guide for details\ \ and # TAGLINE\nsemantics of what should be included in specific entity fields.\ \ # TAGLINE\nSpecifically, the # TAGLINE\n[Fileset Entity Reference](https://guide.fatcat.wiki/entity_fileset.html).\ \ # TAGLINE\n" x-displayName: "Filesets" - name: "webcaptures" description: "**Web Capture** entities represent archival snapshots of web pages\ \ (or # TAGLINE\nother web resources), which are usually complete manifestations\ \ of a # TAGLINE\nspecific release entity. Web Captures also include a set of\ \ locations # TAGLINE\n(wayback replay instances or WARC files) where the capture\ \ can be found. # TAGLINE\n\nSee the \"Catalog Style Guide\" section of the guide\ \ for details and # TAGLINE\nsemantics of what should be included in specific\ \ entity fields. # TAGLINE\nSpecifically, the # TAGLINE\n[Web Capture Entity\ \ Reference](https://guide.fatcat.wiki/entity_webcapture.html). # TAGLINE\n" x-displayName: "Webcaptures" - name: "releases" description: "**Release** entities represent specific published versions of a research\ \ # TAGLINE\nwork, such as a pre-print, a journal article, a book (or chapter),\ \ or a # TAGLINE\nscholarly blog post. Releases are always grouped together under\ \ Works; # TAGLINE\nthey may be published in a specific Container; they may have\ \ known # TAGLINE\nCreators; and there may exist known File/Fileset/WebCapture\ \ digital copies # TAGLINE\nof the release. # TAGLINE\n\nSee the \"Catalog Style\ \ Guide\" section of the guide for details and # TAGLINE\nsemantics of what should\ \ be included in specific entity fields. # TAGLINE\nSpecifically, the # TAGLINE\n\ [Release Entity Reference](https://guide.fatcat.wiki/entity_release.html). #\ \ TAGLINE\n" x-displayName: "Releases" - name: "works" description: "**Work** entities group several Release entities which are different\ \ # TAGLINE\nversions of the same abstract piece of research. For example, three\ \ # TAGLINE\nrelease entities representing the pre-print, published article,\ \ and # TAGLINE\nretraction stages of the same journal paper would be grouped\ \ under a # TAGLINE\nsingle work. # TAGLINE\n\nSee the \"Catalog Style Guide\"\ \ section of the guide for details and # TAGLINE\nsemantics of what should be\ \ included in specific entity fields. # TAGLINE\nSpecifically, the # TAGLINE\n\ [Work Entity Reference](https://guide.fatcat.wiki/entity_work.html). # TAGLINE\n" x-displayName: "Works" - name: "editgroups" description: "**Editgroups** are sets of changes, each to individual entities in\ \ the # TAGLINE\ncatalog. Every edit must be part of an editgroup which is reviewed\ \ and # TAGLINE\naccepted (merged) as a whole. # TAGLINE\n" x-displayName: "Editgroups" - name: "editors" description: "**Editors** are human user accounts and bots that make changes to\ \ the # TAGLINE\nFatcat catalog. # TAGLINE\n\nThe API allows fetching (and updating)\ \ metadata about individual editors, # TAGLINE\nas well as fetching editor's\ \ annotation and edit history. # TAGLINE\n" x-displayName: "Editors" - name: "changelog" description: "The **Changelog** is the ordered feed of editgroups which have been\ \ # TAGLINE\naccepted into the catalog. # TAGLINE\n" x-displayName: "Changelog" - name: "auth" description: "Helper methods and internal APIs for editor authentication. # TAGLINE\n" x-displayName: "Auth Methods" schemes: - "https" consumes: - "application/json" produces: - "application/json" paths: /editgroup/{editgroup_id}/container: post: tags: - "containers" description: "Create a single Container entity as part of an existing editgroup.\n\ \nEditgroup must be mutable (aka, not accepted) and editor must have\npermission\ \ (aka, have created the editgrou p or have `admin` role).\n" operationId: "create_container" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/container_entity" uppercase_data_type: "CONTAINERENTITY" refName: "container_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_CONTAINER" consumesJson: true responses: 201: description: "Created Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "CreatedEntity" x-uppercaseResponseId: "CREATED_ENTITY" uppercase_operation_id: "CREATE_CONTAINER" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_container" uppercase_operation_id: "CREATE_CONTAINER" path: "/editgroup/:editgroup_id/container" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/auto/container/batch: post: tags: - "containers" description: "Create a set of Container entities as part of a new editgroup,\ \ and\naccept that editgroup in the same atomic request.\n\nThis method is\ \ mostly useful for bulk import of new entities by\ncarefully written bots.\ \ This method is more efficient than creating an\neditgroup, several entities,\ \ then accepting the editgroup, both in\nterms of API requests required and\ \ database load. Requires `admin`\nrole.\n" operationId: "create_container_auto_batch" parameters: - in: "body" name: "auto_batch" required: true schema: $ref: "#/definitions/container_auto_batch" uppercase_data_type: "CONTAINERAUTOBATCH" refName: "container_auto_batch" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" consumesJson: true responses: 201: description: "Created Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "CreatedEditgroup" x-uppercaseResponseId: "CREATED_EDITGROUP" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_container_auto_batch" uppercase_operation_id: "CREATE_CONTAINER_AUTO_BATCH" path: "/editgroup/auto/container/batch" HttpMethod: "Post" httpmethod: "post" noClientExample: true /container/{ident}: get: tags: - "containers" description: "Fetches a single container entity from the catalog.\n" operationId: "get_container" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For containers,\ \ none accepted (yet)." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. For containers,\ \ none accepted (yet)." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/container_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "GET_CONTAINER" uppercase_data_type: "CONTAINERENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_container" uppercase_operation_id: "GET_CONTAINER" path: "/container/:ident" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/container/{ident}: put: tags: - "containers" description: "Updates an existing entity as part of a specific (existing) editgroup.\n\ The editgroup must be open for updates (aka, not accepted/merged), and\nthe\ \ editor making the requiest must have permissions (aka, must have\ncreated\ \ the editgroup or have `admin` role).\n\nThis method can also be used to\ \ update an existing entity edit as part\nof an editgroup. For example, if\ \ an entity was created in this\neditgroup, an editor could make changes to\ \ the new entity's metadata\nbefore merging.\n" operationId: "update_container" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/container_entity" uppercase_data_type: "CONTAINERENTITY" refName: "container_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_CONTAINER" consumesJson: true responses: 200: description: "Updated Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "UpdatedEntity" x-uppercaseResponseId: "UPDATED_ENTITY" uppercase_operation_id: "UPDATE_CONTAINER" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_container" uppercase_operation_id: "UPDATE_CONTAINER" path: "/editgroup/:editgroup_id/container/:ident" HttpMethod: "Put" httpmethod: "put" noClientExample: true delete: tags: - "containers" description: "Creates a new \"deletion\" edit for a specific entity as part\ \ of an\nexisting editgroup.\n\nThis is not the method to use to remove an\ \ edit from an editgroup; for\nthat use `delete_container_edit`.\n" operationId: "delete_container" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Deleted Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "DeletedEntity" x-uppercaseResponseId: "DELETED_ENTITY" uppercase_operation_id: "DELETE_CONTAINER" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_container" uppercase_operation_id: "DELETE_CONTAINER" path: "/editgroup/:editgroup_id/container/:ident" HttpMethod: "Delete" httpmethod: "delete" /container/rev/{rev_id}: get: tags: - "containers" description: "Fetches a specific entity revision. Note that the returned revision\n\ will not be associated with any particular fatcat identifier (even if\none\ \ or more identifiers do currently point to this revision). The\nrevision\ \ may even be part of an un-merged editgroup.\n\nRevisions are immutable and\ \ can not be deleted or updated.\n" operationId: "get_container_revision" parameters: - name: "rev_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"rev_id_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_container`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_container`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity Revision" schema: $ref: "#/definitions/container_entity" x-responseId: "FoundEntityRevision" x-uppercaseResponseId: "FOUND_ENTITY_REVISION" uppercase_operation_id: "GET_CONTAINER_REVISION" uppercase_data_type: "CONTAINERENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CONTAINER_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CONTAINER_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CONTAINER_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_container_revision" uppercase_operation_id: "GET_CONTAINER_REVISION" path: "/container/rev/:rev_id" HttpMethod: "Get" httpmethod: "get" /container/{ident}/history: get: tags: - "containers" description: "Fetches the history of accepted edits (changelog entries) for\ \ a\nspecific entity fatcat identifier.\n" operationId: "get_container_history" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "limit" in: "query" description: "Maximum number of changelog entries to return" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Found Entity History" schema: type: "array" items: $ref: "#/definitions/entity_history_entry" x-responseId: "FoundEntityHistory" x-uppercaseResponseId: "FOUND_ENTITY_HISTORY" uppercase_operation_id: "GET_CONTAINER_HISTORY" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CONTAINER_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CONTAINER_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CONTAINER_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_container_history" uppercase_operation_id: "GET_CONTAINER_HISTORY" path: "/container/:ident/history" HttpMethod: "Get" httpmethod: "get" /container/{ident}/redirects: get: tags: - "containers" description: "Returns the set of entity identifiers which currently redirect\ \ to this\nidentifier.\n" operationId: "get_container_redirects" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Found Entity Redirects" schema: type: "array" items: type: "string" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" x-responseId: "FoundEntityRedirects" x-uppercaseResponseId: "FOUND_ENTITY_REDIRECTS" uppercase_operation_id: "GET_CONTAINER_REDIRECTS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CONTAINER_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CONTAINER_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CONTAINER_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_container_redirects" uppercase_operation_id: "GET_CONTAINER_REDIRECTS" path: "/container/:ident/redirects" HttpMethod: "Get" httpmethod: "get" /container/lookup: get: tags: - "containers" description: "Looks for an active entity with the given external identifier.\ \ If any\nsuch entity is found, returns a single complete entity. If multiple\n\ entities have the same external identifier, this is considered a soft\ncatalog\ \ error, and the behavior of which entity is returned is\nundefined.\n\nOne\ \ (and only one) external identifier should be specified per request.\n" operationId: "lookup_container" parameters: - name: "issnl" in: "query" required: false type: "string" maxLength: 9 minLength: 9 pattern: "\\d{4}-\\d{3}[0-9X]" formatString: "{:?}" example: "Some(\"issnl_example\".to_string())" - name: "wikidata_qid" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"wikidata_qid_example\".to_string())" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_container`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_container`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/container_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "LOOKUP_CONTAINER" uppercase_data_type: "CONTAINERENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "LOOKUP_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "LOOKUP_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "LOOKUP_CONTAINER" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "lookup_container" uppercase_operation_id: "LOOKUP_CONTAINER" path: "/container/lookup" HttpMethod: "Get" httpmethod: "get" /container/edit/{edit_id}: get: tags: - "containers" description: "Returns the entity edit object with the given identifier. This\ \ method\nis expected to be used rarely.\n" operationId: "get_container_edit" parameters: - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Found Edit" schema: $ref: "#/definitions/entity_edit" x-responseId: "FoundEdit" x-uppercaseResponseId: "FOUND_EDIT" uppercase_operation_id: "GET_CONTAINER_EDIT" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_container_edit" uppercase_operation_id: "GET_CONTAINER_EDIT" path: "/container/edit/:edit_id" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/container/edit/{edit_id}: delete: tags: - "containers" description: "Removes a single edit from the specified editgroup. The editgroup\ \ must\nbe mutable (aka, not accepted/merged), and the editor making this\n\ request must have permission (aka, have created the editgroup or hold\nthe\ \ `admin` role).\n\nNot to be confused with the `delete_container` method,\ \ which *creates*\na new edit in the given editgroup.\n" operationId: "delete_container_edit" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Deleted Edit" schema: $ref: "#/definitions/success" x-responseId: "DeletedEdit" x-uppercaseResponseId: "DELETED_EDIT" uppercase_operation_id: "DELETE_CONTAINER_EDIT" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_CONTAINER_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_container_edit" uppercase_operation_id: "DELETE_CONTAINER_EDIT" path: "/editgroup/:editgroup_id/container/edit/:edit_id" HttpMethod: "Delete" httpmethod: "delete" /editgroup/{editgroup_id}/creator: post: tags: - "creators" operationId: "create_creator" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/creator_entity" uppercase_data_type: "CREATORENTITY" refName: "creator_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_CREATOR" consumesJson: true responses: 201: description: "Created Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "CreatedEntity" x-uppercaseResponseId: "CREATED_ENTITY" uppercase_operation_id: "CREATE_CREATOR" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_creator" uppercase_operation_id: "CREATE_CREATOR" path: "/editgroup/:editgroup_id/creator" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/auto/creator/batch: post: tags: - "creators" operationId: "create_creator_auto_batch" parameters: - in: "body" name: "auto_batch" required: true schema: $ref: "#/definitions/creator_auto_batch" uppercase_data_type: "CREATORAUTOBATCH" refName: "creator_auto_batch" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" consumesJson: true responses: 201: description: "Created Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "CreatedEditgroup" x-uppercaseResponseId: "CREATED_EDITGROUP" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_creator_auto_batch" uppercase_operation_id: "CREATE_CREATOR_AUTO_BATCH" path: "/editgroup/auto/creator/batch" HttpMethod: "Post" httpmethod: "post" noClientExample: true /creator/{ident}: get: tags: - "creators" operationId: "get_creator" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For creators, none\ \ accepted (yet)." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. For creators, none\ \ accepted (yet)." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/creator_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "GET_CREATOR" uppercase_data_type: "CREATORENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_creator" uppercase_operation_id: "GET_CREATOR" path: "/creator/:ident" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/creator/{ident}: put: tags: - "creators" operationId: "update_creator" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/creator_entity" uppercase_data_type: "CREATORENTITY" refName: "creator_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_CREATOR" consumesJson: true responses: 200: description: "Updated Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "UpdatedEntity" x-uppercaseResponseId: "UPDATED_ENTITY" uppercase_operation_id: "UPDATE_CREATOR" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_creator" uppercase_operation_id: "UPDATE_CREATOR" path: "/editgroup/:editgroup_id/creator/:ident" HttpMethod: "Put" httpmethod: "put" noClientExample: true delete: tags: - "creators" operationId: "delete_creator" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Deleted Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "DeletedEntity" x-uppercaseResponseId: "DELETED_ENTITY" uppercase_operation_id: "DELETE_CREATOR" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_creator" uppercase_operation_id: "DELETE_CREATOR" path: "/editgroup/:editgroup_id/creator/:ident" HttpMethod: "Delete" httpmethod: "delete" /creator/rev/{rev_id}: get: tags: - "creators" operationId: "get_creator_revision" parameters: - name: "rev_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"rev_id_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_creator`,\n\ though note that identifier-based expansions (like `releases`) will\nalways\ \ be empty for revisions.\n" required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_creator`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity Revision" schema: $ref: "#/definitions/creator_entity" x-responseId: "FoundEntityRevision" x-uppercaseResponseId: "FOUND_ENTITY_REVISION" uppercase_operation_id: "GET_CREATOR_REVISION" uppercase_data_type: "CREATORENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CREATOR_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CREATOR_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CREATOR_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_creator_revision" uppercase_operation_id: "GET_CREATOR_REVISION" path: "/creator/rev/:rev_id" HttpMethod: "Get" httpmethod: "get" /creator/{ident}/history: get: tags: - "creators" operationId: "get_creator_history" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "limit" in: "query" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Found Entity History" schema: type: "array" items: $ref: "#/definitions/entity_history_entry" x-responseId: "FoundEntityHistory" x-uppercaseResponseId: "FOUND_ENTITY_HISTORY" uppercase_operation_id: "GET_CREATOR_HISTORY" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CREATOR_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CREATOR_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CREATOR_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_creator_history" uppercase_operation_id: "GET_CREATOR_HISTORY" path: "/creator/:ident/history" HttpMethod: "Get" httpmethod: "get" /creator/{ident}/releases: get: tags: - "creators" description: "Returns the set of Release entities having a `contrib` entry pointing\n\ to the creator entity.\n" operationId: "get_creator_releases" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_release`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found" schema: type: "array" items: $ref: "#/definitions/release_entity" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_CREATOR_RELEASES" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CREATOR_RELEASES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CREATOR_RELEASES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CREATOR_RELEASES" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_creator_releases" uppercase_operation_id: "GET_CREATOR_RELEASES" path: "/creator/:ident/releases" HttpMethod: "Get" httpmethod: "get" /creator/{ident}/redirects: get: tags: - "creators" operationId: "get_creator_redirects" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Found Entity Redirects" schema: type: "array" items: type: "string" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" x-responseId: "FoundEntityRedirects" x-uppercaseResponseId: "FOUND_ENTITY_REDIRECTS" uppercase_operation_id: "GET_CREATOR_REDIRECTS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CREATOR_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CREATOR_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CREATOR_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_creator_redirects" uppercase_operation_id: "GET_CREATOR_REDIRECTS" path: "/creator/:ident/redirects" HttpMethod: "Get" httpmethod: "get" /creator/lookup: get: tags: - "creators" operationId: "lookup_creator" parameters: - name: "orcid" in: "query" description: "ORCiD (https://orcid.org) identifier" required: false type: "string" maxLength: 19 minLength: 19 pattern: "\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dX]" formatString: "{:?}" example: "Some(\"orcid_example\".to_string())" - name: "wikidata_qid" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"wikidata_qid_example\".to_string())" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_creator`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_creator`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/creator_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "LOOKUP_CREATOR" uppercase_data_type: "CREATORENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "LOOKUP_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "LOOKUP_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "LOOKUP_CREATOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "lookup_creator" uppercase_operation_id: "LOOKUP_CREATOR" path: "/creator/lookup" HttpMethod: "Get" httpmethod: "get" /creator/edit/{edit_id}: get: tags: - "creators" operationId: "get_creator_edit" parameters: - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Found Edit" schema: $ref: "#/definitions/entity_edit" x-responseId: "FoundEdit" x-uppercaseResponseId: "FOUND_EDIT" uppercase_operation_id: "GET_CREATOR_EDIT" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_creator_edit" uppercase_operation_id: "GET_CREATOR_EDIT" path: "/creator/edit/:edit_id" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/creator/edit/{edit_id}: delete: tags: - "creators" operationId: "delete_creator_edit" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Deleted Edit" schema: $ref: "#/definitions/success" x-responseId: "DeletedEdit" x-uppercaseResponseId: "DELETED_EDIT" uppercase_operation_id: "DELETE_CREATOR_EDIT" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_CREATOR_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_creator_edit" uppercase_operation_id: "DELETE_CREATOR_EDIT" path: "/editgroup/:editgroup_id/creator/edit/:edit_id" HttpMethod: "Delete" httpmethod: "delete" /editgroup/{editgroup_id}/file: post: tags: - "files" operationId: "create_file" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/file_entity" uppercase_data_type: "FILEENTITY" refName: "file_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_FILE" consumesJson: true responses: 201: description: "Created Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "CreatedEntity" x-uppercaseResponseId: "CREATED_ENTITY" uppercase_operation_id: "CREATE_FILE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_file" uppercase_operation_id: "CREATE_FILE" path: "/editgroup/:editgroup_id/file" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/auto/file/batch: post: tags: - "files" operationId: "create_file_auto_batch" parameters: - in: "body" name: "auto_batch" required: true schema: $ref: "#/definitions/file_auto_batch" uppercase_data_type: "FILEAUTOBATCH" refName: "file_auto_batch" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" consumesJson: true responses: 201: description: "Created Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "CreatedEditgroup" x-uppercaseResponseId: "CREATED_EDITGROUP" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_file_auto_batch" uppercase_operation_id: "CREATE_FILE_AUTO_BATCH" path: "/editgroup/auto/file/batch" HttpMethod: "Post" httpmethod: "post" noClientExample: true /file/{ident}: get: tags: - "files" operationId: "get_file" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For files, `releases`\ \ is accepted." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. For files, none\ \ accepted (yet)." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/file_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "GET_FILE" uppercase_data_type: "FILEENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_file" uppercase_operation_id: "GET_FILE" path: "/file/:ident" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/file/{ident}: put: tags: - "files" operationId: "update_file" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/file_entity" uppercase_data_type: "FILEENTITY" refName: "file_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_FILE" consumesJson: true responses: 200: description: "Updated Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "UpdatedEntity" x-uppercaseResponseId: "UPDATED_ENTITY" uppercase_operation_id: "UPDATE_FILE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_file" uppercase_operation_id: "UPDATE_FILE" path: "/editgroup/:editgroup_id/file/:ident" HttpMethod: "Put" httpmethod: "put" noClientExample: true delete: tags: - "files" operationId: "delete_file" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Deleted Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "DeletedEntity" x-uppercaseResponseId: "DELETED_ENTITY" uppercase_operation_id: "DELETE_FILE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_file" uppercase_operation_id: "DELETE_FILE" path: "/editgroup/:editgroup_id/file/:ident" HttpMethod: "Delete" httpmethod: "delete" /file/rev/{rev_id}: get: tags: - "files" operationId: "get_file_revision" parameters: - name: "rev_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"rev_id_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_file`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_file`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity Revision" schema: $ref: "#/definitions/file_entity" x-responseId: "FoundEntityRevision" x-uppercaseResponseId: "FOUND_ENTITY_REVISION" uppercase_operation_id: "GET_FILE_REVISION" uppercase_data_type: "FILEENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_file_revision" uppercase_operation_id: "GET_FILE_REVISION" path: "/file/rev/:rev_id" HttpMethod: "Get" httpmethod: "get" /file/{ident}/history: get: tags: - "files" operationId: "get_file_history" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "limit" in: "query" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Found Entity History" schema: type: "array" items: $ref: "#/definitions/entity_history_entry" x-responseId: "FoundEntityHistory" x-uppercaseResponseId: "FOUND_ENTITY_HISTORY" uppercase_operation_id: "GET_FILE_HISTORY" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_file_history" uppercase_operation_id: "GET_FILE_HISTORY" path: "/file/:ident/history" HttpMethod: "Get" httpmethod: "get" /file/{ident}/redirects: get: tags: - "files" operationId: "get_file_redirects" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Found Entity Redirects" schema: type: "array" items: type: "string" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" x-responseId: "FoundEntityRedirects" x-uppercaseResponseId: "FOUND_ENTITY_REDIRECTS" uppercase_operation_id: "GET_FILE_REDIRECTS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_file_redirects" uppercase_operation_id: "GET_FILE_REDIRECTS" path: "/file/:ident/redirects" HttpMethod: "Get" httpmethod: "get" /file/lookup: get: tags: - "files" operationId: "lookup_file" parameters: - name: "md5" in: "query" description: "MD5 hash of data, in hex encoding" required: false type: "string" maxLength: 32 minLength: 32 pattern: "[a-f0-9]{32}" formatString: "{:?}" example: "Some(\"md5_example\".to_string())" - name: "sha1" in: "query" description: "SHA-1 hash of data, in hex encoding" required: false type: "string" maxLength: 40 minLength: 40 pattern: "[a-f0-9]{40}" formatString: "{:?}" example: "Some(\"sha1_example\".to_string())" - name: "sha256" in: "query" description: "SHA-256 hash of data, in hex encoding" required: false type: "string" maxLength: 64 minLength: 64 pattern: "[a-f0-9]{64}" formatString: "{:?}" example: "Some(\"sha256_example\".to_string())" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_file`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_file`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/file_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "LOOKUP_FILE" uppercase_data_type: "FILEENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "LOOKUP_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "LOOKUP_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "LOOKUP_FILE" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "lookup_file" uppercase_operation_id: "LOOKUP_FILE" path: "/file/lookup" HttpMethod: "Get" httpmethod: "get" /file/edit/{edit_id}: get: tags: - "files" operationId: "get_file_edit" parameters: - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Found Edit" schema: $ref: "#/definitions/entity_edit" x-responseId: "FoundEdit" x-uppercaseResponseId: "FOUND_EDIT" uppercase_operation_id: "GET_FILE_EDIT" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_file_edit" uppercase_operation_id: "GET_FILE_EDIT" path: "/file/edit/:edit_id" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/file/edit/{edit_id}: delete: tags: - "files" operationId: "delete_file_edit" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Deleted Edit" schema: $ref: "#/definitions/success" x-responseId: "DeletedEdit" x-uppercaseResponseId: "DELETED_EDIT" uppercase_operation_id: "DELETE_FILE_EDIT" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_FILE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_file_edit" uppercase_operation_id: "DELETE_FILE_EDIT" path: "/editgroup/:editgroup_id/file/edit/:edit_id" HttpMethod: "Delete" httpmethod: "delete" /editgroup/{editgroup_id}/fileset: post: tags: - "filesets" operationId: "create_fileset" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/fileset_entity" uppercase_data_type: "FILESETENTITY" refName: "fileset_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_FILESET" consumesJson: true responses: 201: description: "Created Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "CreatedEntity" x-uppercaseResponseId: "CREATED_ENTITY" uppercase_operation_id: "CREATE_FILESET" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_fileset" uppercase_operation_id: "CREATE_FILESET" path: "/editgroup/:editgroup_id/fileset" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/auto/fileset/batch: post: tags: - "filesets" operationId: "create_fileset_auto_batch" parameters: - in: "body" name: "auto_batch" required: true schema: $ref: "#/definitions/fileset_auto_batch" uppercase_data_type: "FILESETAUTOBATCH" refName: "fileset_auto_batch" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" consumesJson: true responses: 201: description: "Created Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "CreatedEditgroup" x-uppercaseResponseId: "CREATED_EDITGROUP" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_fileset_auto_batch" uppercase_operation_id: "CREATE_FILESET_AUTO_BATCH" path: "/editgroup/auto/fileset/batch" HttpMethod: "Post" httpmethod: "post" noClientExample: true /fileset/{ident}: get: tags: - "filesets" operationId: "get_fileset" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For filesets, `releases`\ \ is accepted." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. For filesets, 'manifest'\ \ is accepted." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/fileset_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "GET_FILESET" uppercase_data_type: "FILESETENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_fileset" uppercase_operation_id: "GET_FILESET" path: "/fileset/:ident" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/fileset/{ident}: put: tags: - "filesets" operationId: "update_fileset" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/fileset_entity" uppercase_data_type: "FILESETENTITY" refName: "fileset_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_FILESET" consumesJson: true responses: 200: description: "Updated Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "UpdatedEntity" x-uppercaseResponseId: "UPDATED_ENTITY" uppercase_operation_id: "UPDATE_FILESET" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_fileset" uppercase_operation_id: "UPDATE_FILESET" path: "/editgroup/:editgroup_id/fileset/:ident" HttpMethod: "Put" httpmethod: "put" noClientExample: true delete: tags: - "filesets" operationId: "delete_fileset" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Deleted Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "DeletedEntity" x-uppercaseResponseId: "DELETED_ENTITY" uppercase_operation_id: "DELETE_FILESET" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_FILESET" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_fileset" uppercase_operation_id: "DELETE_FILESET" path: "/editgroup/:editgroup_id/fileset/:ident" HttpMethod: "Delete" httpmethod: "delete" /fileset/rev/{rev_id}: get: tags: - "filesets" operationId: "get_fileset_revision" parameters: - name: "rev_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"rev_id_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_fileset`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_fileset`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity Revision" schema: $ref: "#/definitions/fileset_entity" x-responseId: "FoundEntityRevision" x-uppercaseResponseId: "FOUND_ENTITY_REVISION" uppercase_operation_id: "GET_FILESET_REVISION" uppercase_data_type: "FILESETENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILESET_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILESET_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILESET_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_fileset_revision" uppercase_operation_id: "GET_FILESET_REVISION" path: "/fileset/rev/:rev_id" HttpMethod: "Get" httpmethod: "get" /fileset/{ident}/history: get: tags: - "filesets" operationId: "get_fileset_history" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "limit" in: "query" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Found Entity History" schema: type: "array" items: $ref: "#/definitions/entity_history_entry" x-responseId: "FoundEntityHistory" x-uppercaseResponseId: "FOUND_ENTITY_HISTORY" uppercase_operation_id: "GET_FILESET_HISTORY" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILESET_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILESET_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILESET_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_fileset_history" uppercase_operation_id: "GET_FILESET_HISTORY" path: "/fileset/:ident/history" HttpMethod: "Get" httpmethod: "get" /fileset/{ident}/redirects: get: tags: - "filesets" operationId: "get_fileset_redirects" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Found Entity Redirects" schema: type: "array" items: type: "string" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" x-responseId: "FoundEntityRedirects" x-uppercaseResponseId: "FOUND_ENTITY_REDIRECTS" uppercase_operation_id: "GET_FILESET_REDIRECTS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILESET_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILESET_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILESET_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_fileset_redirects" uppercase_operation_id: "GET_FILESET_REDIRECTS" path: "/fileset/:ident/redirects" HttpMethod: "Get" httpmethod: "get" /fileset/edit/{edit_id}: get: tags: - "filesets" operationId: "get_fileset_edit" parameters: - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Found Edit" schema: $ref: "#/definitions/entity_edit" x-responseId: "FoundEdit" x-uppercaseResponseId: "FOUND_EDIT" uppercase_operation_id: "GET_FILESET_EDIT" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_fileset_edit" uppercase_operation_id: "GET_FILESET_EDIT" path: "/fileset/edit/:edit_id" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/fileset/edit/{edit_id}: delete: tags: - "filesets" operationId: "delete_fileset_edit" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Deleted Edit" schema: $ref: "#/definitions/success" x-responseId: "DeletedEdit" x-uppercaseResponseId: "DELETED_EDIT" uppercase_operation_id: "DELETE_FILESET_EDIT" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_FILESET_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_fileset_edit" uppercase_operation_id: "DELETE_FILESET_EDIT" path: "/editgroup/:editgroup_id/fileset/edit/:edit_id" HttpMethod: "Delete" httpmethod: "delete" /editgroup/{editgroup_id}/webcapture: post: tags: - "webcaptures" operationId: "create_webcapture" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/webcapture_entity" uppercase_data_type: "WEBCAPTUREENTITY" refName: "webcapture_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_WEBCAPTURE" consumesJson: true responses: 201: description: "Created Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "CreatedEntity" x-uppercaseResponseId: "CREATED_ENTITY" uppercase_operation_id: "CREATE_WEBCAPTURE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_webcapture" uppercase_operation_id: "CREATE_WEBCAPTURE" path: "/editgroup/:editgroup_id/webcapture" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/auto/webcapture/batch: post: tags: - "webcaptures" operationId: "create_webcapture_auto_batch" parameters: - in: "body" name: "auto_batch" required: true schema: $ref: "#/definitions/webcapture_auto_batch" uppercase_data_type: "WEBCAPTUREAUTOBATCH" refName: "webcapture_auto_batch" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" consumesJson: true responses: 201: description: "Created Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "CreatedEditgroup" x-uppercaseResponseId: "CREATED_EDITGROUP" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_webcapture_auto_batch" uppercase_operation_id: "CREATE_WEBCAPTURE_AUTO_BATCH" path: "/editgroup/auto/webcapture/batch" HttpMethod: "Post" httpmethod: "post" noClientExample: true /webcapture/{ident}: get: tags: - "webcaptures" operationId: "get_webcapture" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For webcaptures,\ \ `releases` is accepted." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. For webcaptures,\ \ 'cdx' is accepted." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/webcapture_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "GET_WEBCAPTURE" uppercase_data_type: "WEBCAPTUREENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_webcapture" uppercase_operation_id: "GET_WEBCAPTURE" path: "/webcapture/:ident" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/webcapture/{ident}: put: tags: - "webcaptures" operationId: "update_webcapture" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/webcapture_entity" uppercase_data_type: "WEBCAPTUREENTITY" refName: "webcapture_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_WEBCAPTURE" consumesJson: true responses: 200: description: "Updated Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "UpdatedEntity" x-uppercaseResponseId: "UPDATED_ENTITY" uppercase_operation_id: "UPDATE_WEBCAPTURE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_webcapture" uppercase_operation_id: "UPDATE_WEBCAPTURE" path: "/editgroup/:editgroup_id/webcapture/:ident" HttpMethod: "Put" httpmethod: "put" noClientExample: true delete: tags: - "webcaptures" operationId: "delete_webcapture" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Deleted Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "DeletedEntity" x-uppercaseResponseId: "DELETED_ENTITY" uppercase_operation_id: "DELETE_WEBCAPTURE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_WEBCAPTURE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_webcapture" uppercase_operation_id: "DELETE_WEBCAPTURE" path: "/editgroup/:editgroup_id/webcapture/:ident" HttpMethod: "Delete" httpmethod: "delete" /webcapture/rev/{rev_id}: get: tags: - "webcaptures" operationId: "get_webcapture_revision" parameters: - name: "rev_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"rev_id_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_webcapture`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_webcapture`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity Revision" schema: $ref: "#/definitions/webcapture_entity" x-responseId: "FoundEntityRevision" x-uppercaseResponseId: "FOUND_ENTITY_REVISION" uppercase_operation_id: "GET_WEBCAPTURE_REVISION" uppercase_data_type: "WEBCAPTUREENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WEBCAPTURE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WEBCAPTURE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WEBCAPTURE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_webcapture_revision" uppercase_operation_id: "GET_WEBCAPTURE_REVISION" path: "/webcapture/rev/:rev_id" HttpMethod: "Get" httpmethod: "get" /webcapture/{ident}/history: get: tags: - "webcaptures" operationId: "get_webcapture_history" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "limit" in: "query" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Found Entity History" schema: type: "array" items: $ref: "#/definitions/entity_history_entry" x-responseId: "FoundEntityHistory" x-uppercaseResponseId: "FOUND_ENTITY_HISTORY" uppercase_operation_id: "GET_WEBCAPTURE_HISTORY" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WEBCAPTURE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WEBCAPTURE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WEBCAPTURE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_webcapture_history" uppercase_operation_id: "GET_WEBCAPTURE_HISTORY" path: "/webcapture/:ident/history" HttpMethod: "Get" httpmethod: "get" /webcapture/{ident}/redirects: get: tags: - "webcaptures" operationId: "get_webcapture_redirects" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Found Entity Redirects" schema: type: "array" items: type: "string" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" x-responseId: "FoundEntityRedirects" x-uppercaseResponseId: "FOUND_ENTITY_REDIRECTS" uppercase_operation_id: "GET_WEBCAPTURE_REDIRECTS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WEBCAPTURE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WEBCAPTURE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WEBCAPTURE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_webcapture_redirects" uppercase_operation_id: "GET_WEBCAPTURE_REDIRECTS" path: "/webcapture/:ident/redirects" HttpMethod: "Get" httpmethod: "get" /webcapture/edit/{edit_id}: get: tags: - "webcaptures" operationId: "get_webcapture_edit" parameters: - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Found Edit" schema: $ref: "#/definitions/entity_edit" x-responseId: "FoundEdit" x-uppercaseResponseId: "FOUND_EDIT" uppercase_operation_id: "GET_WEBCAPTURE_EDIT" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_webcapture_edit" uppercase_operation_id: "GET_WEBCAPTURE_EDIT" path: "/webcapture/edit/:edit_id" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/webcapture/edit/{edit_id}: delete: tags: - "webcaptures" operationId: "delete_webcapture_edit" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Deleted Edit" schema: $ref: "#/definitions/success" x-responseId: "DeletedEdit" x-uppercaseResponseId: "DELETED_EDIT" uppercase_operation_id: "DELETE_WEBCAPTURE_EDIT" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_WEBCAPTURE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_webcapture_edit" uppercase_operation_id: "DELETE_WEBCAPTURE_EDIT" path: "/editgroup/:editgroup_id/webcapture/edit/:edit_id" HttpMethod: "Delete" httpmethod: "delete" /editgroup/{editgroup_id}/release: post: tags: - "releases" description: "Create a single Release entity as part of an existing editgroup.\ \ If the\n`work_id` field is not set, a work entity will be created automatically\n\ and this field set pointing to the new work.\n\nEditgroup must be mutable\ \ (aka, not accepted) and editor must have\npermission (aka, have created\ \ the editgrou p or have `admin` role).\n" operationId: "create_release" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/release_entity" uppercase_data_type: "RELEASEENTITY" refName: "release_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_RELEASE" consumesJson: true responses: 201: description: "Created Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "CreatedEntity" x-uppercaseResponseId: "CREATED_ENTITY" uppercase_operation_id: "CREATE_RELEASE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_release" uppercase_operation_id: "CREATE_RELEASE" path: "/editgroup/:editgroup_id/release" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/auto/release/batch: post: tags: - "releases" description: "Create a set of Release entities as part of a new editgroup, and\n\ accept that editgroup in the same atomic request.\n\nThis method is mostly\ \ useful for bulk import of new entities by\ncarefully written bots. This\ \ method is more efficient than creating an\neditgroup, several entities,\ \ then accepting the editgroup, both in\nterms of API requests required and\ \ database load. Requires `admin`\nrole.\n" operationId: "create_release_auto_batch" parameters: - in: "body" name: "auto_batch" required: true schema: $ref: "#/definitions/release_auto_batch" uppercase_data_type: "RELEASEAUTOBATCH" refName: "release_auto_batch" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" consumesJson: true responses: 201: description: "Created Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "CreatedEditgroup" x-uppercaseResponseId: "CREATED_EDITGROUP" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_release_auto_batch" uppercase_operation_id: "CREATE_RELEASE_AUTO_BATCH" path: "/editgroup/auto/release/batch" HttpMethod: "Post" httpmethod: "post" noClientExample: true /release/{ident}: get: tags: - "releases" description: "Fetches a single Release entity from the catalog.\n" operationId: "get_release" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For releases, 'files',\n\ 'filesets, 'webcaptures', 'container', and 'creators' are valid.\n" required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response (for efficiency).\ \ For\nreleases, 'abstracts', 'refs', and 'contribs' are valid.\n" required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/release_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "GET_RELEASE" uppercase_data_type: "RELEASEENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release" uppercase_operation_id: "GET_RELEASE" path: "/release/:ident" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/release/{ident}: put: tags: - "releases" description: "Updates an existing entity as part of a specific (existing) editgroup.\n\ The editgroup must be open for updates (aka, not accepted/merged), and\nthe\ \ editor making the requiest must have permissions (aka, must have\ncreated\ \ the editgroup or have `admin` role).\n\nThis method can also be used to\ \ update an existing entity edit as part\nof an editgroup. For example, if\ \ an entity was created in this\neditgroup, an editor could make changes to\ \ the new entity's metadata\nbefore merging.\n" operationId: "update_release" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/release_entity" uppercase_data_type: "RELEASEENTITY" refName: "release_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_RELEASE" consumesJson: true responses: 200: description: "Updated Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "UpdatedEntity" x-uppercaseResponseId: "UPDATED_ENTITY" uppercase_operation_id: "UPDATE_RELEASE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_release" uppercase_operation_id: "UPDATE_RELEASE" path: "/editgroup/:editgroup_id/release/:ident" HttpMethod: "Put" httpmethod: "put" noClientExample: true delete: tags: - "releases" description: "Creates a new \"deletion\" edit for a specific entity as part\ \ of an\nexisting editgroup.\n\nThis is not the method to use to remove an\ \ edit from an editgroup; for\nthat use `delete_release_edit`.\n" operationId: "delete_release" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Deleted Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "DeletedEntity" x-uppercaseResponseId: "DELETED_ENTITY" uppercase_operation_id: "DELETE_RELEASE" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_release" uppercase_operation_id: "DELETE_RELEASE" path: "/editgroup/:editgroup_id/release/:ident" HttpMethod: "Delete" httpmethod: "delete" /release/rev/{rev_id}: get: tags: - "releases" description: "Fetches a specific entity revision. Note that the returned revision\n\ will not be associated with any particular fatcat identifier (even if\none\ \ or more identifiers do currently point to this revision). The\nrevision\ \ may even be part of an un-merged editgroup.\n\nRevisions are immutable and\ \ can not be deleted or updated.\n" operationId: "get_release_revision" parameters: - name: "rev_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"rev_id_example\".to_string()" - name: "expand" in: "query" description: "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." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_release`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity Revision" schema: $ref: "#/definitions/release_entity" x-responseId: "FoundEntityRevision" x-uppercaseResponseId: "FOUND_ENTITY_REVISION" uppercase_operation_id: "GET_RELEASE_REVISION" uppercase_data_type: "RELEASEENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release_revision" uppercase_operation_id: "GET_RELEASE_REVISION" path: "/release/rev/:rev_id" HttpMethod: "Get" httpmethod: "get" /release/{ident}/history: get: tags: - "releases" description: "Fetches the history of accepted edits (changelog entries) for\ \ a\nspecific entity fatcat identifier.\n" operationId: "get_release_history" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "limit" in: "query" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Found Entity History" schema: type: "array" items: $ref: "#/definitions/entity_history_entry" x-responseId: "FoundEntityHistory" x-uppercaseResponseId: "FOUND_ENTITY_HISTORY" uppercase_operation_id: "GET_RELEASE_HISTORY" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release_history" uppercase_operation_id: "GET_RELEASE_HISTORY" path: "/release/:ident/history" HttpMethod: "Get" httpmethod: "get" /release/{ident}/files: get: tags: - "releases" description: "Returns the set of File entities that have a `release_id` pointing\ \ to\nthis release entity.\n" operationId: "get_release_files" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_file`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found" schema: type: "array" items: $ref: "#/definitions/file_entity" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_RELEASE_FILES" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE_FILES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE_FILES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE_FILES" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release_files" uppercase_operation_id: "GET_RELEASE_FILES" path: "/release/:ident/files" HttpMethod: "Get" httpmethod: "get" /release/{ident}/filesets: get: tags: - "releases" description: "Returns the set of Fileset entities that have a `release_id` pointing\ \ to\nthis release entity.\n" operationId: "get_release_filesets" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_fileset`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found" schema: type: "array" items: $ref: "#/definitions/fileset_entity" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_RELEASE_FILESETS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE_FILESETS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE_FILESETS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE_FILESETS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release_filesets" uppercase_operation_id: "GET_RELEASE_FILESETS" path: "/release/:ident/filesets" HttpMethod: "Get" httpmethod: "get" /release/{ident}/webcaptures: get: tags: - "releases" description: "Returns the set of Web Capture entities that have a `release_id`\n\ pointing to this release entity.\n" operationId: "get_release_webcaptures" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_webcapture`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found" schema: type: "array" items: $ref: "#/definitions/webcapture_entity" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_RELEASE_WEBCAPTURES" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE_WEBCAPTURES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE_WEBCAPTURES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE_WEBCAPTURES" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release_webcaptures" uppercase_operation_id: "GET_RELEASE_WEBCAPTURES" path: "/release/:ident/webcaptures" HttpMethod: "Get" httpmethod: "get" /release/{ident}/redirects: get: tags: - "releases" description: "Returns the set of entity identifiers which currently redirect\ \ to this\nidentifier.\n" operationId: "get_release_redirects" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Found Entity Redirects" schema: type: "array" items: type: "string" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" x-responseId: "FoundEntityRedirects" x-uppercaseResponseId: "FOUND_ENTITY_REDIRECTS" uppercase_operation_id: "GET_RELEASE_REDIRECTS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release_redirects" uppercase_operation_id: "GET_RELEASE_REDIRECTS" path: "/release/:ident/redirects" HttpMethod: "Get" httpmethod: "get" /release/lookup: get: tags: - "releases" description: "Looks for an active entity with the given external identifier.\ \ If any\nsuch entity is found, returns a single complete entity. If multiple\n\ entities have the same external identifier, this is considered a soft\ncatalog\ \ error, and the behavior of which entity is returned is\nundefined.\n\nOne\ \ (and only one) external identifier should be specified per request.\n" operationId: "lookup_release" parameters: - name: "doi" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"doi_example\".to_string())" - name: "wikidata_qid" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"wikidata_qid_example\".to_string())" - name: "isbn13" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"isbn13_example\".to_string())" - name: "pmid" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"pmid_example\".to_string())" - name: "pmcid" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"pmcid_example\".to_string())" - name: "core" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"core_example\".to_string())" - name: "arxiv" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"arxiv_example\".to_string())" - name: "jstor" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"jstor_example\".to_string())" - name: "ark" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"ark_example\".to_string())" - name: "mag" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"mag_example\".to_string())" - name: "expand" in: "query" description: "List of sub-entities to expand in response. See `get_release`." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of sub-entities to elide in response. See `get_release`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/release_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "LOOKUP_RELEASE" uppercase_data_type: "RELEASEENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "LOOKUP_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "LOOKUP_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "LOOKUP_RELEASE" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "lookup_release" uppercase_operation_id: "LOOKUP_RELEASE" path: "/release/lookup" HttpMethod: "Get" httpmethod: "get" /release/edit/{edit_id}: get: tags: - "releases" description: "Returns the entity edit object with the given identifier. This\ \ method\nis expected to be used rarely.\n" operationId: "get_release_edit" parameters: - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Found Edit" schema: $ref: "#/definitions/entity_edit" x-responseId: "FoundEdit" x-uppercaseResponseId: "FOUND_EDIT" uppercase_operation_id: "GET_RELEASE_EDIT" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_release_edit" uppercase_operation_id: "GET_RELEASE_EDIT" path: "/release/edit/:edit_id" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/release/edit/{edit_id}: delete: tags: - "releases" description: "Removes a single edit from the specified editgroup. The editgroup\ \ must\nbe mutable (aka, not accepted/merged), and the editor making this\n\ request must have permission (aka, have created the editgroup or hold\nthe\ \ `admin` role).\n\nNot to be confused with the `delete_container` method,\ \ which *creates*\na new edit in the given editgroup.\n" operationId: "delete_release_edit" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Deleted Edit" schema: $ref: "#/definitions/success" x-responseId: "DeletedEdit" x-uppercaseResponseId: "DELETED_EDIT" uppercase_operation_id: "DELETE_RELEASE_EDIT" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_RELEASE_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_release_edit" uppercase_operation_id: "DELETE_RELEASE_EDIT" path: "/editgroup/:editgroup_id/release/edit/:edit_id" HttpMethod: "Delete" httpmethod: "delete" /editgroup/{editgroup_id}/work: post: tags: - "works" operationId: "create_work" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/work_entity" uppercase_data_type: "WORKENTITY" refName: "work_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_WORK" consumesJson: true responses: 201: description: "Created Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "CreatedEntity" x-uppercaseResponseId: "CREATED_ENTITY" uppercase_operation_id: "CREATE_WORK" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_work" uppercase_operation_id: "CREATE_WORK" path: "/editgroup/:editgroup_id/work" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/auto/work/batch: post: tags: - "works" operationId: "create_work_auto_batch" parameters: - in: "body" name: "auto_batch" required: true schema: $ref: "#/definitions/work_auto_batch" uppercase_data_type: "WORKAUTOBATCH" refName: "work_auto_batch" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" consumesJson: true responses: 201: description: "Created Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "CreatedEditgroup" x-uppercaseResponseId: "CREATED_EDITGROUP" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_work_auto_batch" uppercase_operation_id: "CREATE_WORK_AUTO_BATCH" path: "/editgroup/auto/work/batch" HttpMethod: "Post" httpmethod: "post" noClientExample: true /work/{ident}: get: tags: - "works" operationId: "get_work" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For works, none\ \ accepted (yet)." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. For works, none\ \ accepted (yet)." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity" schema: $ref: "#/definitions/work_entity" x-responseId: "FoundEntity" x-uppercaseResponseId: "FOUND_ENTITY" uppercase_operation_id: "GET_WORK" uppercase_data_type: "WORKENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_work" uppercase_operation_id: "GET_WORK" path: "/work/:ident" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/work/{ident}: put: tags: - "works" operationId: "update_work" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - in: "body" name: "entity" required: true schema: $ref: "#/definitions/work_entity" uppercase_data_type: "WORKENTITY" refName: "work_entity" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_WORK" consumesJson: true responses: 200: description: "Updated Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "UpdatedEntity" x-uppercaseResponseId: "UPDATED_ENTITY" uppercase_operation_id: "UPDATE_WORK" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_work" uppercase_operation_id: "UPDATE_WORK" path: "/editgroup/:editgroup_id/work/:ident" HttpMethod: "Put" httpmethod: "put" noClientExample: true delete: tags: - "works" operationId: "delete_work" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Deleted Entity" schema: $ref: "#/definitions/entity_edit" x-responseId: "DeletedEntity" x-uppercaseResponseId: "DELETED_ENTITY" uppercase_operation_id: "DELETE_WORK" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_WORK" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_work" uppercase_operation_id: "DELETE_WORK" path: "/editgroup/:editgroup_id/work/:ident" HttpMethod: "Delete" httpmethod: "delete" /work/rev/{rev_id}: get: tags: - "works" operationId: "get_work_revision" parameters: - name: "rev_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"rev_id_example\".to_string()" - name: "expand" in: "query" description: "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." required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_work`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found Entity Revision" schema: $ref: "#/definitions/work_entity" x-responseId: "FoundEntityRevision" x-uppercaseResponseId: "FOUND_ENTITY_REVISION" uppercase_operation_id: "GET_WORK_REVISION" uppercase_data_type: "WORKENTITY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WORK_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WORK_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WORK_REVISION" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_work_revision" uppercase_operation_id: "GET_WORK_REVISION" path: "/work/rev/:rev_id" HttpMethod: "Get" httpmethod: "get" /work/{ident}/history: get: tags: - "works" operationId: "get_work_history" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "limit" in: "query" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Found Entity History" schema: type: "array" items: $ref: "#/definitions/entity_history_entry" x-responseId: "FoundEntityHistory" x-uppercaseResponseId: "FOUND_ENTITY_HISTORY" uppercase_operation_id: "GET_WORK_HISTORY" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WORK_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WORK_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WORK_HISTORY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_work_history" uppercase_operation_id: "GET_WORK_HISTORY" path: "/work/:ident/history" HttpMethod: "Get" httpmethod: "get" /work/{ident}/redirects: get: tags: - "works" operationId: "get_work_redirects" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" responses: 200: description: "Found Entity Redirects" schema: type: "array" items: type: "string" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" x-responseId: "FoundEntityRedirects" x-uppercaseResponseId: "FOUND_ENTITY_REDIRECTS" uppercase_operation_id: "GET_WORK_REDIRECTS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WORK_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WORK_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WORK_REDIRECTS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_work_redirects" uppercase_operation_id: "GET_WORK_REDIRECTS" path: "/work/:ident/redirects" HttpMethod: "Get" httpmethod: "get" /work/{ident}/releases: get: tags: - "works" description: "Returns the set of release entities that are part of this work\ \ (aka,\nhave `work_id` pointing to this work entity).\n" operationId: "get_work_releases" parameters: - name: "ident" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"ident_example\".to_string()" - name: "hide" in: "query" description: "List of entity fields to elide in response. See `get_release`." required: false type: "string" formatString: "{:?}" example: "Some(\"hide_example\".to_string())" responses: 200: description: "Found" schema: type: "array" items: $ref: "#/definitions/release_entity" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_WORK_RELEASES" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WORK_RELEASES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WORK_RELEASES" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WORK_RELEASES" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_work_releases" uppercase_operation_id: "GET_WORK_RELEASES" path: "/work/:ident/releases" HttpMethod: "Get" httpmethod: "get" /work/edit/{edit_id}: get: tags: - "works" operationId: "get_work_edit" parameters: - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Found Edit" schema: $ref: "#/definitions/entity_edit" x-responseId: "FoundEdit" x-uppercaseResponseId: "FOUND_EDIT" uppercase_operation_id: "GET_WORK_EDIT" uppercase_data_type: "ENTITYEDIT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_work_edit" uppercase_operation_id: "GET_WORK_EDIT" path: "/work/edit/:edit_id" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/work/edit/{edit_id}: delete: tags: - "works" operationId: "delete_work_edit" parameters: - name: "editgroup_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "edit_id" in: "path" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" required: true type: "string" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" formatString: "\\\"{}\\\"" example: "\"edit_id_example\".to_string()" responses: 200: description: "Deleted Edit" schema: $ref: "#/definitions/success" x-responseId: "DeletedEdit" x-uppercaseResponseId: "DELETED_EDIT" uppercase_operation_id: "DELETE_WORK_EDIT" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "DELETE_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "DELETE_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "DELETE_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "DELETE_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "DELETE_WORK_EDIT" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "delete_work_edit" uppercase_operation_id: "DELETE_WORK_EDIT" path: "/editgroup/:editgroup_id/work/edit/:edit_id" HttpMethod: "Delete" httpmethod: "delete" /editor/{editor_id}: get: tags: - "editors" description: "Returns an editor object, including metadata such as the username,\n\ type, and role of editor.\n" operationId: "get_editor" parameters: - name: "editor_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editor_id_example\".to_string()" responses: 200: description: "Found" schema: $ref: "#/definitions/editor" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_EDITOR" uppercase_data_type: "EDITOR" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_editor" uppercase_operation_id: "GET_EDITOR" path: "/editor/:editor_id" HttpMethod: "Get" httpmethod: "get" put: tags: - "editors" description: "Allows metadata changes to some editor fields, such as the username.\n\ \nChanges require authentication and permissions. An editor can change\ntheir\ \ own username; changes to role flags require the `admin` role by\nthe editor\ \ making the request.\n" operationId: "update_editor" parameters: - name: "editor_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editor_id_example\".to_string()" - in: "body" name: "editor" required: true schema: $ref: "#/definitions/editor" uppercase_data_type: "EDITOR" refName: "editor" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_EDITOR" consumesJson: true responses: 200: description: "Updated Editor" schema: $ref: "#/definitions/editor" x-responseId: "UpdatedEditor" x-uppercaseResponseId: "UPDATED_EDITOR" uppercase_operation_id: "UPDATE_EDITOR" uppercase_data_type: "EDITOR" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_EDITOR" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_editor" uppercase_operation_id: "UPDATE_EDITOR" path: "/editor/:editor_id" HttpMethod: "Put" httpmethod: "put" noClientExample: true /editor/{editor_id}/editgroups: get: tags: - "editors" description: "Returns a set of editgroups created by the given editor, regardless\ \ of\nthe status (accepted/submitted) of the editgroups.\n" operationId: "get_editor_editgroups" parameters: - name: "editor_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editor_id_example\".to_string()" - name: "limit" in: "query" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" - name: "before" in: "query" description: "Return only editgroups created *before* the given timestamp\ \ (not\ninclusive). Editgroups will be sorted by creation time in\ndescending\ \ order (most recent first). For use in pagination.\n" required: false type: "string" format: "date-time" formatString: "{:?}" example: "None" - name: "since" in: "query" description: "Return only editgroups created *after* the given timestamp (not\n\ inclusive). Editgroups will be sorted by creation time in ascending\norder\ \ (most recent last). For use in pagination.\n" required: false type: "string" format: "date-time" formatString: "{:?}" example: "None" responses: 200: description: "Found" schema: type: "array" items: $ref: "#/definitions/editgroup" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_EDITOR_EDITGROUPS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_EDITOR_EDITGROUPS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_EDITOR_EDITGROUPS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_EDITOR_EDITGROUPS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_editor_editgroups" uppercase_operation_id: "GET_EDITOR_EDITGROUPS" path: "/editor/:editor_id/editgroups" HttpMethod: "Get" httpmethod: "get" /editor/{editor_id}/annotations: get: tags: - "editors" description: "Fetches a list of annotations made by a particular editor.\n" operationId: "get_editor_annotations" parameters: - name: "editor_id" in: "path" description: "base32-encoded unique identifier" required: true type: "string" maxLength: 26 minLength: 26 pattern: "[a-zA-Z2-7]{26}" formatString: "\\\"{}\\\"" example: "\"editor_id_example\".to_string()" - name: "limit" in: "query" description: "Maximum number (count) of annotations to return in response" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" - name: "before" in: "query" description: "Return only annotations made *before* the given timestamp (not\n\ inclusive). Annotations will be sorted by creation time in\ndescending order\ \ (most recent first). For use in pagination.\n" required: false type: "string" format: "date-time" formatString: "{:?}" example: "None" - name: "since" in: "query" description: "Return only annotations made *after* the given timestamp (not\n\ inclusive). Annotations will be sorted by creation time in\nascending order\ \ (most recent last). For use in pagination.\n" required: false type: "string" format: "date-time" formatString: "{:?}" example: "None" responses: 200: description: "Success" schema: type: "array" items: $ref: "#/definitions/editgroup_annotation" x-responseId: "Success" x-uppercaseResponseId: "SUCCESS" uppercase_operation_id: "GET_EDITOR_ANNOTATIONS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_EDITOR_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "GET_EDITOR_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "GET_EDITOR_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_EDITOR_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_EDITOR_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_editor_annotations" uppercase_operation_id: "GET_EDITOR_ANNOTATIONS" path: "/editor/:editor_id/annotations" HttpMethod: "Get" httpmethod: "get" /editgroup: post: tags: - "editgroups" description: "Creates a new editgroup. By default the editor making this request\ \ will\nbe the author of the editgroup.\n" operationId: "create_editgroup" parameters: - in: "body" name: "editgroup" required: true schema: $ref: "#/definitions/editgroup" uppercase_data_type: "EDITGROUP" refName: "editgroup" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_EDITGROUP" consumesJson: true responses: 201: description: "Successfully Created" schema: $ref: "#/definitions/editgroup" x-responseId: "SuccessfullyCreated" x-uppercaseResponseId: "SUCCESSFULLY_CREATED" uppercase_operation_id: "CREATE_EDITGROUP" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_editgroup" uppercase_operation_id: "CREATE_EDITGROUP" path: "/editgroup" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/{editgroup_id}: get: tags: - "editgroups" description: "Returns a single editgroup object.\n\nUnlike some similar methods,\ \ this method will return a full/expanded\neditgroup object, which includes\ \ edit lists of each entity type (though\nwill not include the complete entity\ \ objects).\n" operationId: "get_editgroup" parameters: - name: "editgroup_id" in: "path" description: "base32-encoded unique identifier" required: true type: "string" maxLength: 26 minLength: 26 pattern: "[a-zA-Z2-7]{26}" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" responses: 200: description: "Found" schema: $ref: "#/definitions/editgroup" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_EDITGROUP" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_editgroup" uppercase_operation_id: "GET_EDITGROUP" path: "/editgroup/:editgroup_id" HttpMethod: "Get" httpmethod: "get" put: tags: - "editgroups" description: "Updates metadata for a single editgroup object. Note that only\ \ metadata\nfields such as the `description` or `extra` metadata can be changed\n\ with this method; it does not allow adding or removing edits to the\neditgroup\ \ (for that use the individual entity create/update/delete\nmethods).\n" operationId: "update_editgroup" parameters: - name: "editgroup_id" in: "path" description: "base32-encoded unique identifier" required: true type: "string" maxLength: 26 minLength: 26 pattern: "[a-zA-Z2-7]{26}" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "editgroup" required: true schema: $ref: "#/definitions/editgroup" uppercase_data_type: "EDITGROUP" refName: "editgroup" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "UPDATE_EDITGROUP" consumesJson: true - name: "submit" in: "query" required: false type: "boolean" formatString: "{:?}" example: "Some(true)" responses: 200: description: "Updated Editgroup" schema: $ref: "#/definitions/editgroup" x-responseId: "UpdatedEditgroup" x-uppercaseResponseId: "UPDATED_EDITGROUP" uppercase_operation_id: "UPDATE_EDITGROUP" uppercase_data_type: "EDITGROUP" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "UPDATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "UPDATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "UPDATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "UPDATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "UPDATE_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "update_editgroup" uppercase_operation_id: "UPDATE_EDITGROUP" path: "/editgroup/:editgroup_id" HttpMethod: "Put" httpmethod: "put" noClientExample: true /editgroup/{editgroup_id}/accept: post: tags: - "editgroups" description: "Accept (\"merge\") the given editgroup into the catalog. The editgroup\n\ must be open (not already accepted), and the editor making this request\n\ must have the `admin` role.\n" operationId: "accept_editgroup" parameters: - name: "editgroup_id" in: "path" description: "base32-encoded unique identifier" required: true type: "string" maxLength: 26 minLength: 26 pattern: "[a-zA-Z2-7]{26}" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" responses: 200: description: "Merged Successfully" schema: $ref: "#/definitions/success" x-responseId: "MergedSuccessfully" x-uppercaseResponseId: "MERGED_SUCCESSFULLY" uppercase_operation_id: "ACCEPT_EDITGROUP" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "ACCEPT_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "ACCEPT_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "ACCEPT_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "ACCEPT_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 409: description: "Edit Conflict" schema: $ref: "#/definitions/error_response" x-responseId: "EditConflict" x-uppercaseResponseId: "EDIT_CONFLICT" uppercase_operation_id: "ACCEPT_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "ACCEPT_EDITGROUP" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "accept_editgroup" uppercase_operation_id: "ACCEPT_EDITGROUP" path: "/editgroup/:editgroup_id/accept" HttpMethod: "Post" httpmethod: "post" /editgroup/{editgroup_id}/annotations: get: tags: - "editgroups" description: "Returns a list of annotations made to a specific editgroup." operationId: "get_editgroup_annotations" parameters: - name: "editgroup_id" in: "path" description: "base32-encoded unique identifier" required: true type: "string" maxLength: 26 minLength: 26 pattern: "[a-zA-Z2-7]{26}" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - name: "expand" in: "query" description: "List of sub-entities to expand in response. For editgroup annotations:\ \ 'editors'" required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" responses: 200: description: "Success" schema: type: "array" items: $ref: "#/definitions/editgroup_annotation" x-responseId: "Success" x-uppercaseResponseId: "SUCCESS" uppercase_operation_id: "GET_EDITGROUP_ANNOTATIONS" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_EDITGROUP_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "GET_EDITGROUP_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "GET_EDITGROUP_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_EDITGROUP_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_EDITGROUP_ANNOTATIONS" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_editgroup_annotations" uppercase_operation_id: "GET_EDITGROUP_ANNOTATIONS" path: "/editgroup/:editgroup_id/annotations" HttpMethod: "Get" httpmethod: "get" /editgroup/{editgroup_id}/annotation: post: tags: - "editgroups" description: "Submits a new annotation to the specified editgroup.\n\nThe editgroup\ \ must be open (not already accepted). The annotation will\nautomatically\ \ have authorship of the editor making this request.\n" operationId: "create_editgroup_annotation" parameters: - name: "editgroup_id" in: "path" description: "base32-encoded unique identifier" required: true type: "string" maxLength: 26 minLength: 26 pattern: "[a-zA-Z2-7]{26}" formatString: "\\\"{}\\\"" example: "\"editgroup_id_example\".to_string()" - in: "body" name: "annotation" required: true schema: $ref: "#/definitions/editgroup_annotation" uppercase_data_type: "EDITGROUPANNOTATION" refName: "editgroup_annotation" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" consumesJson: true responses: 201: description: "Created" schema: $ref: "#/definitions/editgroup_annotation" x-responseId: "Created" x-uppercaseResponseId: "CREATED" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" uppercase_data_type: "EDITGROUPANNOTATION" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_editgroup_annotation" uppercase_operation_id: "CREATE_EDITGROUP_ANNOTATION" path: "/editgroup/:editgroup_id/annotation" HttpMethod: "Post" httpmethod: "post" noClientExample: true /editgroup/reviewable: get: tags: - "editgroups" description: "Returns a set of editgroups which have been submitted but not\ \ yet accepted.\n\nQuery parameters can be used to sort and paginate the list\ \ returned.\n" operationId: "get_editgroups_reviewable" parameters: - name: "expand" in: "query" description: "List of sub-entities to expand in response. For editgroups:\ \ 'editors'" required: false type: "string" formatString: "{:?}" example: "Some(\"expand_example\".to_string())" - name: "limit" in: "query" description: "Maximum number of reviewable editgroups to return in response" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" - name: "before" in: "query" description: "Return only reviewable editgroups submitted *before* the given\n\ timestamp (not inclusive). Editgroups will be sorted by submission\ntime\ \ in descending order (most recent first). For use in pagination.\n" required: false type: "string" format: "date-time" formatString: "{:?}" example: "None" - name: "since" in: "query" description: "Return only reviewable editgroups submitted *after* the given\n\ timestamp (not inclusive). Editgroups will be sorted by submission\ntime\ \ in ascending order (most recent last). For use in pagination.\n" required: false type: "string" format: "date-time" formatString: "{:?}" example: "None" responses: 200: description: "Found" schema: type: "array" items: $ref: "#/definitions/editgroup" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "GET_EDITGROUPS_REVIEWABLE" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_EDITGROUPS_REVIEWABLE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_EDITGROUPS_REVIEWABLE" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_EDITGROUPS_REVIEWABLE" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_editgroups_reviewable" uppercase_operation_id: "GET_EDITGROUPS_REVIEWABLE" path: "/editgroup/reviewable" HttpMethod: "Get" httpmethod: "get" /changelog: get: tags: - "changelog" description: "Returns a list of the most recent changelog entries accepted (merged)\n\ into the catalog.\n\nList is sorted by changelog index in descending order.\ \ Note that the\naccepted timestamp roughly corresponds to order, but not\ \ strictly;\nthere exist out-of-order timestamps on the order of several seconds.\n\ \nAs a known database issue, it is technically possible for there to be a\n\ gap in changelog index numbers (aka, a missing changelog entry). There\nare\ \ no currently known gaps and this is considered a bug that will be\naddressed.\n\ \nThere are millions of entries; to paginate through all of them, use\nthis\ \ method to discover the highest existing entry number, then request\nthe\ \ entries using `get_changelog_entry` one at a time.\n" operationId: "get_changelog" parameters: - name: "limit" in: "query" description: "Maximum count of changelog entries to return in response" required: false type: "integer" format: "int64" formatString: "{:?}" example: "Some(789)" responses: 200: description: "Success" schema: type: "array" items: $ref: "#/definitions/changelog_entry" x-responseId: "Success" x-uppercaseResponseId: "SUCCESS" uppercase_operation_id: "GET_CHANGELOG" uppercase_data_type: "VEC" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CHANGELOG" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CHANGELOG" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_changelog" uppercase_operation_id: "GET_CHANGELOG" path: "/changelog" HttpMethod: "Get" httpmethod: "get" /changelog/{index}: get: tags: - "changelog" description: "Returns a single changelog entry.\n\nAs a known database issue,\ \ it is technically possible for there to be a\ngap in changelog index numbers\ \ (aka, a missing changelog entry). There\nare no currently known gaps and\ \ this is considered a bug that will be\naddressed.\n" operationId: "get_changelog_entry" parameters: - name: "index" in: "path" description: "Changelog index of entry to return" required: true type: "integer" format: "int64" formatString: "{}" example: "789" responses: 200: description: "Found Changelog Entry" schema: $ref: "#/definitions/changelog_entry" x-responseId: "FoundChangelogEntry" x-uppercaseResponseId: "FOUND_CHANGELOG_ENTRY" uppercase_operation_id: "GET_CHANGELOG_ENTRY" uppercase_data_type: "CHANGELOGENTRY" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "GET_CHANGELOG_ENTRY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 404: description: "Not Found" schema: $ref: "#/definitions/error_response" x-responseId: "NotFound" x-uppercaseResponseId: "NOT_FOUND" uppercase_operation_id: "GET_CHANGELOG_ENTRY" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "GET_CHANGELOG_ENTRY" uppercase_data_type: "ERRORRESPONSE" producesJson: true operation_id: "get_changelog_entry" uppercase_operation_id: "GET_CHANGELOG_ENTRY" path: "/changelog/:index" HttpMethod: "Get" httpmethod: "get" /auth/oidc: post: tags: - "auth" description: "Login or create editor account using OIDC metadata (internal method).\n\ \nThis method is used by privileged front-end tools (like the web\ninterface\ \ service) to process editor logins using OpenID Connect (OIDC)\nand/or OAuth.\ \ Most accounts (including tool and bot accounts) do not\nhave sufficient\ \ privileges to call this method, which requires the\n`admin` role.\n\nThe\ \ method returns an API token; the HTTP status code indicates whether\nan\ \ existing account was logged in, or a new account was created.\n" operationId: "auth_oidc" parameters: - in: "body" name: "oidc_params" required: true schema: $ref: "#/definitions/auth_oidc" uppercase_data_type: "AUTHOIDC" refName: "auth_oidc" formatString: "{:?}" example: "???" model_key: "editgroup_edits" uppercase_operation_id: "AUTH_OIDC" consumesJson: true responses: 200: description: "Found" schema: $ref: "#/definitions/auth_oidc_result" x-responseId: "Found" x-uppercaseResponseId: "FOUND" uppercase_operation_id: "AUTH_OIDC" uppercase_data_type: "AUTHOIDCRESULT" producesJson: true 201: description: "Created" schema: $ref: "#/definitions/auth_oidc_result" x-responseId: "Created" x-uppercaseResponseId: "CREATED" uppercase_operation_id: "AUTH_OIDC" uppercase_data_type: "AUTHOIDCRESULT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "AUTH_OIDC" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "AUTH_OIDC" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "AUTH_OIDC" uppercase_data_type: "ERRORRESPONSE" producesJson: true 409: description: "Conflict" schema: $ref: "#/definitions/error_response" x-responseId: "Conflict" x-uppercaseResponseId: "CONFLICT" uppercase_operation_id: "AUTH_OIDC" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "AUTH_OIDC" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "auth_oidc" uppercase_operation_id: "AUTH_OIDC" path: "/auth/oidc" HttpMethod: "Post" httpmethod: "post" noClientExample: true /auth/check: get: tags: - "auth" description: "Verify that authentication (API token) is working as expected.\ \ The\noptional `role` parameter can be used to verify that the current\n\ account (editor) has permissions for the given role.\n" operationId: "auth_check" parameters: - name: "role" in: "query" required: false type: "string" formatString: "{:?}" example: "Some(\"role_example\".to_string())" responses: 200: description: "Success" schema: $ref: "#/definitions/success" x-responseId: "Success" x-uppercaseResponseId: "SUCCESS" uppercase_operation_id: "AUTH_CHECK" uppercase_data_type: "SUCCESS" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "AUTH_CHECK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "AUTH_CHECK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "AUTH_CHECK" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "AUTH_CHECK" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "auth_check" uppercase_operation_id: "AUTH_CHECK" path: "/auth/check" HttpMethod: "Get" httpmethod: "get" /auth/token/{editor_id}: post: tags: - "auth" description: "Generate a new auth token for a given editor (internal method).\n\ \nThis method is used by the web interface to generate API tokens for\nusers.\ \ It can not be called by editors (human or bot) to generate new\ntokens for\ \ themselves, at least at this time.\n" operationId: "create_auth_token" parameters: - name: "editor_id" in: "path" required: true type: "string" formatString: "\\\"{}\\\"" example: "\"editor_id_example\".to_string()" - name: "duration_seconds" in: "query" description: "How long API token should be valid for (in seconds)" required: false type: "integer" formatString: "{:?}" example: "Some(56)" responses: 200: description: "Success" schema: $ref: "#/definitions/auth_token_result" x-responseId: "Success" x-uppercaseResponseId: "SUCCESS" uppercase_operation_id: "CREATE_AUTH_TOKEN" uppercase_data_type: "AUTHTOKENRESULT" producesJson: true 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" x-responseId: "BadRequest" x-uppercaseResponseId: "BAD_REQUEST" uppercase_operation_id: "CREATE_AUTH_TOKEN" uppercase_data_type: "ERRORRESPONSE" producesJson: true 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" x-responseId: "NotAuthorized" x-uppercaseResponseId: "NOT_AUTHORIZED" uppercase_operation_id: "CREATE_AUTH_TOKEN" uppercase_data_type: "ERRORRESPONSE" producesJson: true 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-responseId: "Forbidden" x-uppercaseResponseId: "FORBIDDEN" uppercase_operation_id: "CREATE_AUTH_TOKEN" uppercase_data_type: "ERRORRESPONSE" producesJson: true 500: description: "Generic Error" schema: $ref: "#/definitions/error_response" x-responseId: "GenericError" x-uppercaseResponseId: "GENERIC_ERROR" uppercase_operation_id: "CREATE_AUTH_TOKEN" uppercase_data_type: "ERRORRESPONSE" producesJson: true security: - Bearer: [] operation_id: "create_auth_token" uppercase_operation_id: "CREATE_AUTH_TOKEN" path: "/auth/token/:editor_id" HttpMethod: "Post" httpmethod: "post" securityDefinitions: Bearer: description: "The only current API authentication mechanism is HTTP bearer\nauthentication\ \ using the `Authorization` HTTP header. The header should\nbe formatted as\ \ the string \"Bearer\", then a space, then API token (in the\nusual base64\ \ string encoding).\n\nAn example HTTP request would look on the wire like:\n\ \n GET /v0/auth/check HTTP/1.1\n Accept: */*\n Accept-Encoding: gzip,\ \ deflate\n Authorization: Bearer AgEPZGV2LmZhdGNhdC53aWtpAhYyMDE5MDEwMS1kZXYtZHVtbXkta2V5AAImZWRpdG9yX2lkID0gYWFhYWFhYWFhYWFhYmt2a2FhYWFhYWFhYWkAAht0aW1lID4gMjAxOS0wMS0wOVQwMDo1Nzo1MloAAAYgnroNha1hSftChtxHGTnLEmM/pY8MeQS/jBSV0UNvXug=\n\ \ Connection: keep-alive\n Host: api.qa.fatcat.wiki\n User-Agent: HTTPie/0.9.8\n\ \nHeaders can be passed on the command line using `http` (HTTPie) like:\n\n\ \ http get https://api.qa.fatcat.wiki/v0/auth/check Authorization:\"Bearer\ \ AgEPZGV2LmZhdGNhdC53aWtpAhYyMDE5MDEwMS1kZXYtZHVtbXkta2V5AAImZWRpdG9yX2lkID0gYWFhYWFhYWFhYWFhYmt2a2FhYWFhYWFhYWkAAht0aW1lID4gMjAxOS0wMS0wOVQwMDo1Nzo1MloAAAYgnroNha1hSftChtxHGTnLEmM/pY8MeQS/jBSV0UNvXug=\"\ \n\nOr with `curl`:\n\n curl -H \"Authorization: Bearer AgEPZGV2LmZhdGNhdC53aWtpAhYyMDE5MDEwMS1kZXYtZHVtbXkta2V5AAImZWRpdG9yX2lkID0gYWFhYWFhYWFhYWFhYmt2a2FhYWFhYWFhYWkAAht0aW1lID4gMjAxOS0wMS0wOVQwMDo1Nzo1MloAAAYgnroNha1hSftChtxHGTnLEmM/pY8MeQS/jBSV0UNvXug=\"\ \ https://qa.fatcat.wiki/v0/auth/check\n" type: "apiKey" name: "Authorization" in: "header" definitions: error_response: type: "object" required: - "error" - "message" - "success" properties: success: type: "boolean" example: false error: type: "string" example: "unexpected-thing" message: type: "string" example: "A really confusing, totally unexpected thing happened" upperCaseName: "ERROR_RESPONSE" success: type: "object" required: - "message" - "success" properties: success: type: "boolean" example: true message: type: "string" example: "The computers did the thing successfully!" example: success: true message: "The computers did the thing successfully!" upperCaseName: "SUCCESS" container_entity: type: "object" properties: wikidata_qid: type: "string" example: "Q42812" issnl: type: "string" example: "1234-5678" description: "Linking ISSN number (ISSN-L). Should be valid and registered\ \ with issn.org" minLength: 9 maxLength: 9 pattern: "\\d{4}-\\d{3}[0-9X]" publisher: type: "string" example: "Society of Curious Students" description: "Name of the organization or entity responsible for publication.\ \ Not\nthe complete imprint/brand.\n" container_type: type: "string" example: "journal" description: "Type of container, eg 'journal' or 'proceedings'. See Guide\ \ for list of valid types." name: type: "string" example: "Journal of Important Results" description: "Name of the container (eg, Journal title). Required for entity\ \ creation." edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" redirect: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" state: type: "string" example: "active" enum: - "wip" - "active" - "redirect" - "deleted" example: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" container_type: "journal" name: "Journal of Important Results" publisher: "Society of Curious Students" issnl: "1234-5678" wikidata_qid: "Q42812" state: "active" edit_extra: "{}" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" upperCaseName: "CONTAINER_ENTITY" creator_entity: type: "object" properties: wikidata_qid: type: "string" example: "Q42812" description: "Wikidata entity QID" orcid: type: "string" example: "0000-0002-1825-0097" description: "ORCiD (https://orcid.org) identifier" minLength: 19 maxLength: 19 pattern: "\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dX]" surname: type: "string" description: "In English commonly the last, or family name, but ordering is\ \ context\nand culture specific.\n" given_name: type: "string" description: "In English commonly the first name, but ordering is context\ \ and\nculture specific.\n" display_name: type: "string" example: "Grace Hopper" description: "Name as should be displayed in web interface or in author lists\ \ (not\nindex/sorted). Required for valid entities.\n" state: type: "string" example: "active" enum: - "wip" - "active" - "redirect" - "deleted" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" redirect: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" example: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" surname: "surname" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" orcid: "0000-0002-1825-0097" wikidata_qid: "Q42812" state: "active" given_name: "given_name" display_name: "Grace Hopper" edit_extra: "{}" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" upperCaseName: "CREATOR_ENTITY" file_entity: type: "object" properties: releases: type: "array" description: "Full release entities, included in GET responses when `releases`\n\ included in `expand` parameter. Ignored if included in PUT or POST\nrequests.\n" items: $ref: "#/definitions/release_entity" release_ids: type: "array" description: "Set of identifier of release entities this file represents a\ \ full\nmanifestation of. Usually a single release, but some files contain\n\ content of multiple full releases (eg, an issue of a journal).\n" items: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" mimetype: type: "string" example: "application/pdf" urls: type: "array" items: $ref: "#/definitions/file_url" sha256: type: "string" example: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" description: "SHA-256 hash of data, in hex encoding" minLength: 64 maxLength: 64 pattern: "[a-f0-9]{64}" sha1: type: "string" example: "e9dd75237c94b209dc3ccd52722de6931a310ba3" description: "SHA-1 hash of data, in hex encoding" minLength: 40 maxLength: 40 pattern: "[a-f0-9]{40}" md5: type: "string" example: "1b39813549077b2347c0f370c3864b40" description: "MD5 hash of data, in hex encoding" minLength: 32 maxLength: 32 pattern: "[a-f0-9]{32}" size: type: "integer" format: "int64" example: 1048576 description: "Size of file in bytes. Non-zero." edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" redirect: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" state: type: "string" example: "active" enum: - "wip" - "active" - "redirect" - "deleted" example: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" releases: - null - null revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" urls: - rel: "web" url: "https://example.edu/~frau/prcding.pdf" - rel: "web" url: "https://example.edu/~frau/prcding.pdf" size: 1048576 extra: "{}" mimetype: "application/pdf" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" upperCaseName: "FILE_ENTITY" file_url: type: "object" required: - "rel" - "url" properties: url: type: "string" format: "url" example: "https://example.edu/~frau/prcding.pdf" description: "URL/URI pointing directly to a machine retrievable copy of this\ \ exact\nfile.\n" rel: type: "string" example: "web" description: "Indicates type of host this URL points to. Eg, \"publisher\"\ ,\n\"repository\", \"webarchive\". See guide for list of acceptable values.\n" example: rel: "web" url: "https://example.edu/~frau/prcding.pdf" upperCaseName: "FILE_URL" fileset_entity: type: "object" properties: releases: type: "array" description: "Full release entities, included in GET responses when `releases`\n\ included in `expand` parameter. Ignored if included in PUT or POST\nrequests.\n" items: $ref: "#/definitions/release_entity" release_ids: type: "array" description: "Set of identifier of release entities this fileset represents\ \ a full\nmanifestation of. Usually a single release.\n" items: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" urls: type: "array" items: $ref: "#/definitions/fileset_url" manifest: type: "array" items: $ref: "#/definitions/fileset_file" state: type: "string" example: "active" enum: - "wip" - "active" - "redirect" - "deleted" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" redirect: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" example: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" urls: - rel: "webarchive" url: "https://example.edu/~frau/prcding.pdf" - rel: "webarchive" url: "https://example.edu/~frau/prcding.pdf" manifest: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" path: "img/cat.png" size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" path: "img/cat.png" size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" releases: - null - null revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" upperCaseName: "FILESET_ENTITY" fileset_url: type: "object" required: - "rel" - "url" properties: url: type: "string" format: "url" example: "https://example.edu/~frau/prcding.pdf" rel: type: "string" example: "webarchive" description: "Indicates type of host this URL points to. See guide for list\ \ of\nacceptable values.\n" example: rel: "webarchive" url: "https://example.edu/~frau/prcding.pdf" upperCaseName: "FILESET_URL" fileset_file: type: "object" required: - "path" - "size" properties: path: type: "string" example: "img/cat.png" description: "Path name of file within this fileset (eg, directory)\n" size: type: "integer" format: "int64" example: 1048576 description: "File size in bytes" md5: type: "string" example: "1b39813549077b2347c0f370c3864b40" description: "MD5 hash of data, in hex encoding" minLength: 32 maxLength: 32 pattern: "[a-f0-9]{32}" sha1: type: "string" example: "e9dd75237c94b209dc3ccd52722de6931a310ba3" description: "SHA-1 hash of data, in hex encoding" minLength: 40 maxLength: 40 pattern: "[a-f0-9]{40}" sha256: type: "string" example: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" description: "SHA-256 hash of data, in hex encoding" minLength: 64 maxLength: 64 pattern: "[a-f0-9]{64}" extra: type: "object" description: "Free-form additional metadata about this specific file in the\ \ set.\nEg, `mimetype`. See guide for nomative (but unenforced) schema\n\ fields.\n" example: sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" path: "img/cat.png" size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" upperCaseName: "FILESET_FILE" webcapture_entity: type: "object" properties: releases: type: "array" description: "Full release entities, included in GET responses when `releases`\n\ included in `expand` parameter. Ignored if included in PUT or POST\nrequests.\n" items: $ref: "#/definitions/release_entity" release_ids: type: "array" description: "Set of identifier of release entities this fileset represents\ \ a full\nmanifestation of. Usually a single release.\n" items: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" timestamp: type: "string" format: "date-time" description: "Same format as CDX line timestamp (UTC, etc). Corresponds to\ \ the\noverall capture timestamp. Should generally be the timestamp of\n\ capture of the primary resource URL.\n" original_url: type: "string" format: "url" example: "http://asheesh.org" description: "Base URL of the primary resource this is a capture of" archive_urls: type: "array" items: $ref: "#/definitions/webcapture_url" cdx: type: "array" items: $ref: "#/definitions/webcapture_cdx_line" edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" redirect: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" state: type: "string" example: "active" enum: - "wip" - "active" - "redirect" - "deleted" example: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" archive_urls: - rel: "wayback" url: "https://web.archive.org/web/" - rel: "wayback" url: "https://web.archive.org/web/" original_url: "http://asheesh.org" cdx: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" timestamp: "2016-09-19T17:20:24Z" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" timestamp: "2016-09-19T17:20:24Z" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" releases: - null - null timestamp: "2000-01-23T04:56:07.000+00:00" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" upperCaseName: "WEBCAPTURE_ENTITY" webcapture_cdx_line: type: "object" required: - "sha1" - "surt" - "timestamp" - "url" properties: surt: type: "string" example: "org,asheesh)/apus/ch1/node15.html" description: "\"Sortable URL\" format. See guide for details.\n" timestamp: type: "string" format: "date-time" example: "2016-09-19T17:20:24Z" description: "Date and time of capture, in ISO format. UTC, 'Z'-terminated,\ \ second\n(or better) precision.\n" url: type: "string" example: "http://www.asheesh.org:80/APUS/ch1/node15.html" description: "Full URL/URI of resource captured.\n" mimetype: type: "string" example: "text/html" description: "Mimetype of the resource at this URL. May be the Content-Type\ \ header,\nor the actually sniffed file type.\n" status_code: type: "integer" format: "int64" example: 200 description: "HTTP status code. Should generally be 200, especially for the\ \ primary\nresource, but may be 3xx (redirect) or even error codes if embedded\n\ resources can not be fetched successfully.\n" size: type: "integer" format: "int64" example: 1048576 description: "Resource (file) size in bytes" sha1: type: "string" example: "e9dd75237c94b209dc3ccd52722de6931a310ba3" description: "SHA-1 hash of data, in hex encoding" minLength: 40 maxLength: 40 pattern: "[a-f0-9]{40}" sha256: type: "string" example: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" description: "SHA-256 hash of data, in hex encoding" minLength: 64 maxLength: 64 pattern: "[a-f0-9]{64}" example: sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" timestamp: "2016-09-19T17:20:24Z" upperCaseName: "WEBCAPTURE_CDX_LINE" webcapture_url: type: "object" required: - "rel" - "url" properties: url: type: "string" format: "url" example: "https://web.archive.org/web/" description: "URL/URI pointing to archive of this web resource.\n" rel: type: "string" example: "wayback" description: "Type of archive endpoint. Usually `wayback` (WBM replay of primary\n\ resource), or `warc` (direct URL to a WARC file containing all\nresources\ \ of the capture). See guide for full list.\n" example: rel: "wayback" url: "https://web.archive.org/web/" upperCaseName: "WEBCAPTURE_URL" release_entity: type: "object" required: - "ext_ids" properties: abstracts: type: "array" items: $ref: "#/definitions/release_abstract" refs: type: "array" items: $ref: "#/definitions/release_ref" contribs: type: "array" items: $ref: "#/definitions/release_contrib" license_slug: type: "string" example: "CC-BY" description: "Short string (slug) name of license under which release is openly\n\ published (if applicable).\n" language: type: "string" example: "en" description: "Primary language of the content of the full release. Two-letter\n\ RFC1766/ISO639-1 language code, with some custom\nextensions/additions.\ \ See guide.\n" publisher: type: "string" example: "Elsevier" description: "Name, usually English, of the entity or institution responsible\ \ for\npublication of this release. Not necessarily the imprint/brand. See\n\ guide.\n" version: type: "string" example: "3" description: "For, eg, updated technical reports or software packages, where\n\ the version string may be the only field disambiguating between\nreleases.\n" number: type: "string" example: "RFC1337" description: "For, eg, technical reports, which are published in series or\n\ assigned some other institutional or container-specific identifier.\n" pages: type: "string" example: "340-345" description: "Either a single page number (\"first page\") or a range of pages\n\ separated by a dash (\"-\"). See guide for details.\n" issue: type: "string" example: "12" description: "Issue number of volume/container that this release was published\ \ in.\nSometimes coresponds to a month number in the year, but can be any\n\ string. See guide.\n" volume: type: "string" example: "3" description: "Volume number of container that this release was published in.\ \ Often\ncorresponds to the \"Nth\" year of publication, but can be any\ \ string.\nSee guide.\n" ext_ids: description: "Set of external identifiers for this release.\n" $ref: "#/definitions/release_ext_ids" withdrawn_year: type: "integer" format: "int64" example: 2014 description: "Year corresponding with `withdrawn_date` like\n`release_year`/`release_date`.\n" withdrawn_date: type: "string" format: "date" description: "Full date when this release was formally withdrawn (if applicable).\n\ ISO format, like `release_date`.\n" withdrawn_status: type: "string" example: "retracted" description: "Type of withdrawl or retraction of this release, if applicable.\ \ If\nrelease has not been withdrawn, should be `null` (aka, not set, not\n\ the string \"null\" or an empty string).\n" release_year: type: "integer" format: "int64" example: 2014 description: "Year when this release was formally published. Must match\n\ `release_date` if that field is set; this field exists because\nsometimes\ \ only the year is known.\n" release_date: type: "string" format: "date" description: "Full date when this release was formally published. ISO format,\ \ like\n`2019-03-05`. See guide for semantics.\n" release_stage: type: "string" example: "preprint" description: "The stage of publication of this specific release. See guide\ \ for\nvalid values and semantics.\n" release_type: type: "string" example: "book" description: "\"Type\" or \"medium\" that this release is published as. See\ \ guide for\nvalid values.\n" container_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Used to link this release to a container entity that the release\ \ was\npublished as part of.\n" webcaptures: type: "array" description: "Complete webcapture entities identified by `webcapture_ids`\ \ field.\nOnly included in GET responses when `webcaptures` included in\ \ `expand`\nparameter; ignored in PUT or POST requests.\n" items: $ref: "#/definitions/webcapture_entity" filesets: type: "array" description: "Complete file entities identified by `filesets_ids` field. Only\n\ included in GET responses when `filesets` included in `expand`\nparameter;\ \ ignored in PUT or POST requests.\n" items: $ref: "#/definitions/fileset_entity" files: type: "array" description: "Complete file entities identified by `file_ids` field. Only\n\ included in GET responses when `files` included in `expand` parameter;\n\ ignored in PUT or POST requests.\n" items: $ref: "#/definitions/file_entity" container: description: "Complete container entity identified by `container_id` field.\ \ Only\nincluded in GET reponses when `container` included in `expand`\n\ parameter; ignored in PUT or POST requests.\n" $ref: "#/definitions/container_entity" work_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Identifier of work this release is part of. In creation (POST)\n\ requests, a work entity will be created automatically if this field\nis\ \ not set.\n" original_title: type: "string" description: "Title in original language if `title` field has been translated.\ \ See\nguide for details.\n" subtitle: type: "string" description: "Subtitle of release. In many cases, better to merge with title\ \ than\ninclude as separate field (unless combined title would be very long).\n\ See guide for details.\n" title: type: "string" description: "Required for valid entities. The title used in citations and\ \ for\ndisplay. Sometimes the English translation of title e even if release\n\ content is not English.\n" state: type: "string" example: "active" enum: - "wip" - "active" - "redirect" - "deleted" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" redirect: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" example: container: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" container_type: "journal" name: "Journal of Important Results" publisher: "Society of Curious Students" issnl: "1234-5678" wikidata_qid: "Q42812" state: "active" edit_extra: "{}" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" webcaptures: - redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" archive_urls: - rel: "wayback" url: "https://web.archive.org/web/" - rel: "wayback" url: "https://web.archive.org/web/" original_url: "http://asheesh.org" cdx: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" timestamp: "2016-09-19T17:20:24Z" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" timestamp: "2016-09-19T17:20:24Z" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" releases: - null - null timestamp: "2000-01-23T04:56:07.000+00:00" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" archive_urls: - rel: "wayback" url: "https://web.archive.org/web/" - rel: "wayback" url: "https://web.archive.org/web/" original_url: "http://asheesh.org" cdx: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" timestamp: "2016-09-19T17:20:24Z" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" timestamp: "2016-09-19T17:20:24Z" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" releases: - null - null timestamp: "2000-01-23T04:56:07.000+00:00" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" withdrawn_status: "retracted" language: "en" title: "title" contribs: - raw_affiliation: "raw_affiliation" creator: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" surname: "surname" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" orcid: "0000-0002-1825-0097" wikidata_qid: "Q42812" state: "active" given_name: "given_name" display_name: "Grace Hopper" edit_extra: "{}" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" raw_name: "Jane K. Doe" role: "author" surname: "Doe" extra: "{}" creator_id: "q3nouwy3nnbsvo3h5klxsx4a7y" index: 0 given_name: "Jane" - raw_affiliation: "raw_affiliation" creator: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" surname: "surname" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" orcid: "0000-0002-1825-0097" wikidata_qid: "Q42812" state: "active" given_name: "given_name" display_name: "Grace Hopper" edit_extra: "{}" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" raw_name: "Jane K. Doe" role: "author" surname: "Doe" extra: "{}" creator_id: "q3nouwy3nnbsvo3h5klxsx4a7y" index: 0 given_name: "Jane" number: "RFC1337" pages: "340-345" extra: "{}" state: "active" edit_extra: "{}" withdrawn_year: 2014 redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" work_id: "q3nouwy3nnbsvo3h5klxsx4a7y" issue: "12" original_title: "original_title" abstracts: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" mimetype: "application/xml+jats" lang: "en" content: "Some abstract thing goes here" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" mimetype: "application/xml+jats" lang: "en" content: "Some abstract thing goes here" release_year: 2014 release_type: "book" version: "3" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" volume: "3" ext_ids: core: "core" mag: "mag" jstor: "jstor" isbn13: "isbn13" arxiv: "arxiv" wikidata_qid: "Q42812" ark: "ark" pmid: "482132" pmcid: "PMC7391" doi: "10.1234/abcde.789" release_stage: "preprint" license_slug: "CC-BY" withdrawn_date: "2000-01-23" refs: - target_release_id: "q3nouwy3nnbsvo3h5klxsx4a7y" container_name: "container_name" year: 1972 extra: "{}" index: 0 title: "title" locator: "p123" key: "SMITH2016" - target_release_id: "q3nouwy3nnbsvo3h5klxsx4a7y" container_name: "container_name" year: 1972 extra: "{}" index: 0 title: "title" locator: "p123" key: "SMITH2016" release_date: "2000-01-23" subtitle: "subtitle" publisher: "Elsevier" files: - redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" releases: - null - null revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" urls: - rel: "web" url: "https://example.edu/~frau/prcding.pdf" - rel: "web" url: "https://example.edu/~frau/prcding.pdf" size: 1048576 extra: "{}" mimetype: "application/pdf" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" - redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" releases: - null - null revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" urls: - rel: "web" url: "https://example.edu/~frau/prcding.pdf" - rel: "web" url: "https://example.edu/~frau/prcding.pdf" size: 1048576 extra: "{}" mimetype: "application/pdf" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" filesets: - redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" urls: - rel: "webarchive" url: "https://example.edu/~frau/prcding.pdf" - rel: "webarchive" url: "https://example.edu/~frau/prcding.pdf" manifest: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" path: "img/cat.png" size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" path: "img/cat.png" size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" releases: - null - null revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" urls: - rel: "webarchive" url: "https://example.edu/~frau/prcding.pdf" - rel: "webarchive" url: "https://example.edu/~frau/prcding.pdf" manifest: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" path: "img/cat.png" size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" path: "img/cat.png" size: 1048576 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "active" release_ids: - "q3nouwy3nnbsvo3h5klxsx4a7y" - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" releases: - null - null revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" container_id: "q3nouwy3nnbsvo3h5klxsx4a7y" upperCaseName: "RELEASE_ENTITY" release_ext_ids: type: "object" properties: doi: type: "string" example: "10.1234/abcde.789" description: "Digital Object Identifier (DOI), mostly for published papers\ \ and\ndatasets. Should be registered and resolvable via https://doi.org/\n" wikidata_qid: type: "string" example: "Q42812" description: "Wikidata entity QID" isbn13: type: "string" description: "ISBN-13, for books. Usually not set for chapters. ISBN-10 should\ \ be\nconverted to ISBN-13.\n" pmid: type: "string" example: "482132" description: "PubMed Identifier" pmcid: type: "string" example: "PMC7391" description: "PubMed Central Identifier" core: type: "string" description: "CORE (https://core.ac.uk) identifier" arxiv: type: "string" description: "arXiv (https://arxiv.org) identifier; must include version" jstor: type: "string" description: "JSTOR work identifier" ark: type: "string" description: "ARK identifier" mag: type: "string" description: "Microsoft Academic Graph identifier" example: core: "core" mag: "mag" jstor: "jstor" isbn13: "isbn13" arxiv: "arxiv" wikidata_qid: "Q42812" ark: "ark" pmid: "482132" pmcid: "PMC7391" doi: "10.1234/abcde.789" upperCaseName: "RELEASE_EXT_IDS" release_abstract: type: "object" properties: sha1: type: "string" example: "e9dd75237c94b209dc3ccd52722de6931a310ba3" description: "SHA-1 hash of data, in hex encoding" minLength: 40 maxLength: 40 pattern: "[a-f0-9]{40}" content: type: "string" example: "Some abstract thing goes here" description: "Abstract content. May be encoded, as per `mimetype` field, but\ \ only\nstring/text content may be included.\n" mimetype: type: "string" example: "application/xml+jats" description: "Mimetype of abstract contents. `text/plain` is the default if\ \ content\nisn't encoded.\n" lang: type: "string" example: "en" description: "ISO language code of the abstract. Same semantics as release\ \ `language` field.\n" example: sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" mimetype: "application/xml+jats" lang: "en" content: "Some abstract thing goes here" upperCaseName: "RELEASE_ABSTRACT" work_entity: type: "object" properties: edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" redirect: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" state: type: "string" example: "active" enum: - "wip" - "active" - "redirect" - "deleted" example: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "active" edit_extra: "{}" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" upperCaseName: "WORK_ENTITY" entity_history_entry: type: "object" required: - "changelog_entry" - "edit" - "editgroup" properties: edit: $ref: "#/definitions/entity_edit" editgroup: $ref: "#/definitions/editgroup" changelog_entry: $ref: "#/definitions/changelog_entry" example: editgroup: editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" changelog_index: 1048576 submitted: "2000-01-23T04:56:07.000+00:00" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" edits: works: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" webcaptures: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" creators: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" files: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" containers: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" filesets: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" releases: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "description" annotations: - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" edit: ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" changelog_entry: editgroup: editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" changelog_index: 1048576 submitted: "2000-01-23T04:56:07.000+00:00" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" edits: works: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" webcaptures: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" creators: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" files: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" containers: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" filesets: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" releases: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "description" annotations: - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" index: 0 editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" timestamp: "2000-01-23T04:56:07.000+00:00" upperCaseName: "ENTITY_HISTORY_ENTRY" entity_edit: type: "object" required: - "edit_id" - "editgroup_id" - "ident" properties: edit_id: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "Unique UUID for this specific edit object.\n" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Fatcat identifier of the entity this edit is mutating.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "Entity revision that this edit will set the entity to. May be\n\ `null` in the case of deletions.\n" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" prev_revision: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "Revision of entity just before this edit. May be used in the\ \ future\nto prevent edit race conditions.\n" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" redirect_ident: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "When an edit is to merge entities (redirect one to another),\ \ this\nis the entity fatcat identifier for the target entity.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" editgroup_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Editgroup identifier that this edit is part of.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" extra: type: "object" example: ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" upperCaseName: "ENTITY_EDIT" editor: type: "object" required: - "username" properties: editor_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Fatcat identifier for the editor. Can not be changed.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" username: type: "string" example: "zerocool93" description: "Username/handle (short slug-like string) to identify this editor.\ \ May\nbe changed at any time by the editor; use the `editor_id` as a\n\ persistend identifer.\n" is_admin: type: "boolean" example: false description: "Whether this editor has the `admin` role.\n" is_bot: type: "boolean" example: false description: "Whether this editor is a bot (as opposed to a human making manual\n\ edits)\n" is_active: type: "boolean" example: true description: "Whether this editor's account is enabled (if not API tokens\ \ and web\nlogins will not work).\n" example: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" upperCaseName: "EDITOR" editgroup: type: "object" properties: editgroup_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Fatcat identifier for this editgroup. Assigned on creation.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" editor_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Fatcat identifer of editor that created this editgroup.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" editor: description: "Complete editor object identified by `container_id` field. Only\n\ included in GET responses.\n" $ref: "#/definitions/editor" changelog_index: type: "integer" format: "int64" example: 1048576 description: "For accepted/merged editgroups, the changelog index that the\ \ accept\noccured at. WARNING: not populated in all contexts that an editgroup\n\ could be included in a response.\n" created: type: "string" format: "date-time" description: "Timestamp when this editgroup was first created.\n" submitted: type: "string" format: "date-time" description: "Timestamp when this editgroup was most recently submitted for\ \ review.\nIf withdrawn, or never submitted, will be `null`.\n" description: type: "string" description: "Comment describing the changes in this editgroup. Can be updated\ \ with\nPUT request.\n" extra: type: "object" description: "Free-form JSON metadata attached to this editgroup. Eg, metadata\n\ provenance, or script user-agent details. See guide for (unenforced)\nschema\ \ norms.\n" annotations: type: "array" description: "Only included in GET responses, and not in all contexts. Do\ \ not\ninclude this field in PUT or POST requests.\n" items: $ref: "#/definitions/editgroup_annotation" edits: $ref: "#/definitions/editgroup_edits" example: editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" changelog_index: 1048576 submitted: "2000-01-23T04:56:07.000+00:00" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" edits: works: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" webcaptures: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" creators: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" files: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" containers: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" filesets: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" releases: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "description" annotations: - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" upperCaseName: "EDITGROUP" editgroup_annotation: type: "object" properties: annotation_id: type: "string" example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" minLength: 36 maxLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" editgroup_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Editgroup that this annotation applies to. Set automatically\ \ in\ncreations based on URL parameter.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" editor_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Defaults to editor created the annotation via POST request.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" editor: description: "Only included in GET responses; ignored in PUT or POST requests.\n" $ref: "#/definitions/editor" created: type: "string" format: "date-time" description: "Timestamp when annotation was first created.\n" comment_markdown: type: "string" extra: type: "object" description: "Additional free-form JSON metadata that can be included as part\ \ of\nthe annotation (or even as the primary annotation itself). See guide\n\ for details.\n" example: annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" upperCaseName: "EDITGROUP_ANNOTATION" changelog_entry: type: "object" required: - "editgroup_id" - "index" - "timestamp" properties: index: type: "integer" format: "int64" description: "Monotonically increasing sequence number of this changelog entry.\n" editgroup_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Identifier of editgroup accepted/merged in this changelog entry.\n" timestamp: type: "string" format: "date-time" description: "Date and time when the editgroup was accpeted.\n" editgroup: $ref: "#/definitions/editgroup" example: editgroup: editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" changelog_index: 1048576 submitted: "2000-01-23T04:56:07.000+00:00" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" edits: works: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" webcaptures: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" creators: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" files: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" containers: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" filesets: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" releases: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "description" annotations: - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" - annotation_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" created: "2000-01-23T04:56:07.000+00:00" extra: "{}" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" comment_markdown: "comment_markdown" editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" index: 0 editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" timestamp: "2000-01-23T04:56:07.000+00:00" upperCaseName: "CHANGELOG_ENTRY" release_ref: type: "object" properties: index: type: "integer" format: "int64" description: "Zero-indexed sequence number of this reference in the list of\n\ references. Assigned automatically and used internally; don't confuse\n\ with `key`.\n" target_release_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "Optional, fatcat identifier of release entity that this reference\ \ is\nciting.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" extra: type: "object" description: "Additional free-form JSON metadata about this citation. Generally\n\ follows Citation Style Language (CSL) JSON schema. See guide for\ndetails.\n" key: type: "string" example: "SMITH2016" description: "Short string used to indicate this reference from within the\ \ release\ntext; or numbering of references as typeset in the release itself.\n\ Optional; don't confuse with `index` field.\n" year: type: "integer" format: "int64" example: 1972 description: "Year that the cited work was published in.\n" container_name: type: "string" description: "Name of the container (eg, journal) that the citation work was\n\ published as part of. May be an acronym or full name.\n" title: type: "string" description: "Name of the work being cited." locator: type: "string" example: "p123" description: "Page number or other indicator of the specific subset of a work\ \ being\ncited. Not to be confused with the first page (or page range) of\ \ an\nentire paper or chapter being cited.\n" example: target_release_id: "q3nouwy3nnbsvo3h5klxsx4a7y" container_name: "container_name" year: 1972 extra: "{}" index: 0 title: "title" locator: "p123" key: "SMITH2016" upperCaseName: "RELEASE_REF" release_contrib: type: "object" properties: index: type: "integer" format: "int64" example: 0 description: "Internally assigned zero-indexed sequence number of contribution.\n\ Authors should come first; this encodes the order of attriubtion.\n" creator_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "If known, indicates the creator entity this contribution was\ \ made by.\n" minLength: 26 maxLength: 26 pattern: "[a-zA-Z2-7]{26}" creator: description: "Complete creator entity. Only returned in GET responses, and\ \ only if\n`contribs` included in the `expand` query parameter.\n" $ref: "#/definitions/creator_entity" raw_name: type: "string" example: "Jane K. Doe" description: "Full name of the contributor as typeset in the release.\n" given_name: type: "string" example: "Jane" description: "In English commonly the first name, but ordering is context\ \ and\nculture specific.\n" surname: type: "string" example: "Doe" description: "In English commonly the last, or family name, but ordering is\ \ context\nand culture specific.\n" role: type: "string" example: "author" description: "Short string (slug) indicating type of contribution (eg, \"\ author\",\n\"translator\"). See guide for list of accpeted values.\n" raw_affiliation: type: "string" description: "Raw affiliation string as displayed in text" extra: type: "object" description: "Additional free-form JSON metadata about this\ncontributor/contribution.\ \ See guide for normative schema.\n" example: raw_affiliation: "raw_affiliation" creator: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" surname: "surname" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" orcid: "0000-0002-1825-0097" wikidata_qid: "Q42812" state: "active" given_name: "given_name" display_name: "Grace Hopper" edit_extra: "{}" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" raw_name: "Jane K. Doe" role: "author" surname: "Doe" extra: "{}" creator_id: "q3nouwy3nnbsvo3h5klxsx4a7y" index: 0 given_name: "Jane" upperCaseName: "RELEASE_CONTRIB" container_auto_batch: type: "object" required: - "editgroup" - "entity_list" properties: editgroup: $ref: "#/definitions/editgroup" entity_list: type: "array" items: $ref: "#/definitions/container_entity" upperCaseName: "CONTAINER_AUTO_BATCH" creator_auto_batch: type: "object" required: - "editgroup" - "entity_list" properties: editgroup: $ref: "#/definitions/editgroup" entity_list: type: "array" items: $ref: "#/definitions/creator_entity" upperCaseName: "CREATOR_AUTO_BATCH" file_auto_batch: type: "object" required: - "editgroup" - "entity_list" properties: editgroup: $ref: "#/definitions/editgroup" entity_list: type: "array" items: $ref: "#/definitions/file_entity" upperCaseName: "FILE_AUTO_BATCH" fileset_auto_batch: type: "object" required: - "editgroup" - "entity_list" properties: editgroup: $ref: "#/definitions/editgroup" entity_list: type: "array" items: $ref: "#/definitions/fileset_entity" upperCaseName: "FILESET_AUTO_BATCH" webcapture_auto_batch: type: "object" required: - "editgroup" - "entity_list" properties: editgroup: $ref: "#/definitions/editgroup" entity_list: type: "array" items: $ref: "#/definitions/webcapture_entity" upperCaseName: "WEBCAPTURE_AUTO_BATCH" release_auto_batch: type: "object" required: - "editgroup" - "entity_list" properties: editgroup: $ref: "#/definitions/editgroup" entity_list: type: "array" items: $ref: "#/definitions/release_entity" upperCaseName: "RELEASE_AUTO_BATCH" work_auto_batch: type: "object" required: - "editgroup" - "entity_list" properties: editgroup: $ref: "#/definitions/editgroup" entity_list: type: "array" items: $ref: "#/definitions/work_entity" upperCaseName: "WORK_AUTO_BATCH" auth_oidc: type: "object" required: - "iss" - "preferred_username" - "provider" - "sub" properties: provider: type: "string" example: "orcid" description: "Fatcat-specific short name (slug) for remote service being used\ \ for\nauthentication.\n" sub: type: "string" example: "https://orcid.org" description: "`SUB` from OIDC protocol. Usually a URL." iss: type: "string" example: "0000-0002-8593-9468" description: "`ISS` from OIDC protocol. Usually a stable account username,\ \ number, or identifier." preferred_username: type: "string" example: "bnewbold" description: "What it sounds like; returned by OIDC, and used as a hint when\n\ creating new editor accounts. Fatcat usernames are usually this\nstring\ \ with the `provider` slug as a suffix, though some munging may\noccur.\n" upperCaseName: "AUTH_OIDC" auth_oidc_result: type: "object" required: - "editor" - "token" properties: editor: $ref: "#/definitions/editor" token: type: "string" example: "AgEPZGV2LmZhdGNhdC53aWtpAhYyMDE5MDEwMS1kZXYtZHVtbXkta2V5AAImZWRpdG9yX2lkID0gYWFhYWFhYWFhYWFhYmt2a2FhYWFhYWFhYWkAAht0aW1lID4gMjAxOS0wMS0wOVQwMDo1Nzo1MloAAAYgnroNha1hSftChtxHGTnLEmM/pY8MeQS/jBSV0UNvXug=" example: editor: is_admin: false is_active: true editor_id: "q3nouwy3nnbsvo3h5klxsx4a7y" is_bot: false username: "zerocool93" token: "AgEPZGV2LmZhdGNhdC53aWtpAhYyMDE5MDEwMS1kZXYtZHVtbXkta2V5AAImZWRpdG9yX2lkID0gYWFhYWFhYWFhYWFhYmt2a2FhYWFhYWFhYWkAAht0aW1lID4gMjAxOS0wMS0wOVQwMDo1Nzo1MloAAAYgnroNha1hSftChtxHGTnLEmM/pY8MeQS/jBSV0UNvXug=" upperCaseName: "AUTH_OIDC_RESULT" auth_token_result: type: "object" required: - "token" properties: token: type: "string" example: "AgEPZGV2LmZhdGNhdC53aWtpAhYyMDE5MDEwMS1kZXYtZHVtbXkta2V5AAImZWRpdG9yX2lkID0gYWFhYWFhYWFhYWFhYmt2a2FhYWFhYWFhYWkAAht0aW1lID4gMjAxOS0wMS0wOVQwMDo1Nzo1MloAAAYgnroNha1hSftChtxHGTnLEmM/pY8MeQS/jBSV0UNvXug=" example: token: "AgEPZGV2LmZhdGNhdC53aWtpAhYyMDE5MDEwMS1kZXYtZHVtbXkta2V5AAImZWRpdG9yX2lkID0gYWFhYWFhYWFhYWFhYmt2a2FhYWFhYWFhYWkAAht0aW1lID4gMjAxOS0wMS0wOVQwMDo1Nzo1MloAAAYgnroNha1hSftChtxHGTnLEmM/pY8MeQS/jBSV0UNvXug=" upperCaseName: "AUTH_TOKEN_RESULT" editgroup_edits: properties: containers: type: "array" items: $ref: "#/definitions/entity_edit" creators: type: "array" items: $ref: "#/definitions/entity_edit" files: type: "array" items: $ref: "#/definitions/entity_edit" filesets: type: "array" items: $ref: "#/definitions/entity_edit" webcaptures: type: "array" items: $ref: "#/definitions/entity_edit" releases: type: "array" items: $ref: "#/definitions/entity_edit" works: type: "array" items: $ref: "#/definitions/entity_edit" description: "Only included in GET responses, and not in all contexts. Do not\n\ include this field in PUT or POST requests.\n" example: works: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" webcaptures: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" creators: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" files: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" containers: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" filesets: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" releases: - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" - ident: "q3nouwy3nnbsvo3h5klxsx4a7y" edit_id: "86daea5b-1b6b-432a-bb67-ea97795f80fe" extra: "{}" redirect_ident: "q3nouwy3nnbsvo3h5klxsx4a7y" editgroup_id: "q3nouwy3nnbsvo3h5klxsx4a7y" prev_revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" upperCaseName: "EDITGROUP_EDITS" x-servers: - url: "https://api.fatcat.wiki/v0" description: "Production Server" - url: "https://api.qa.fatcat.wiki/v0" description: "QA Server" x-tagGroups: - name: "Entities" tags: - "containers" - "creators" - "files" - "filesets" - "webcaptures" - "releases" - "works" - name: "Editing" tags: - "editors" - "editgroups" - "changelog" - name: "Other" tags: - "auth" x-fatcat-ident: type: "string" pattern: "[a-zA-Z2-7]{26}" minLength: 26 maxLength: 26 description: "base32-encoded unique identifier" x-fatcat-ident-example: example: "q3nouwy3nnbsvo3h5klxsx4a7y" x-fatcat-uuid: type: "string" pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" minLength: 36 maxLength: 36 description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" x-fatcat-uuid-example: example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" x-issn: type: "string" pattern: "\\d{4}-\\d{3}[0-9X]" minLength: 9 maxLength: 9 x-issn-example: example: "1234-5678" x-orcid: type: "string" pattern: "\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dX]" minLength: 19 maxLength: 19 description: "ORCiD (https://orcid.org) identifier" x-orcid-example: example: "0000-0002-1825-0097" x-md5: type: "string" pattern: "[a-f0-9]{32}" minLength: 32 maxLength: 32 description: "MD5 hash of data, in hex encoding" x-md5-example: example: "1b39813549077b2347c0f370c3864b40" x-sha1: type: "string" pattern: "[a-f0-9]{40}" minLength: 40 maxLength: 40 description: "SHA-1 hash of data, in hex encoding" x-sha1-example: example: "e9dd75237c94b209dc3ccd52722de6931a310ba3" x-sha256: type: "string" pattern: "[a-f0-9]{64}" minLength: 64 maxLength: 64 description: "SHA-256 hash of data, in hex encoding" x-sha256-example: example: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" x-entity-props: state: type: "string" enum: - "wip" - "active" - "redirect" - "deleted" example: "active" ident: example: "q3nouwy3nnbsvo3h5klxsx4a7y" description: "base32-encoded unique identifier" maxLength: 26 minLength: 26 pattern: "[a-zA-Z2-7]{26}" type: "string" revision: example: "86daea5b-1b6b-432a-bb67-ea97795f80fe" description: "UUID (lower-case, dash-separated, hex-encoded 128-bit)" maxLength: 36 minLength: 36 pattern: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" type: "string" redirect: example: "q3nouwy3nnbsvo3h5klxsx4a7y" type: "string" pattern: "[a-zA-Z2-7]{26}" minLength: 26 maxLength: 26 description: "base32-encoded unique identifier" extra: type: "object" description: "Free-form JSON metadata that will be stored with the other entity\n\ metadata. See guide for (unenforced) schema conventions.\n" additionalProperties: {} edit_extra: type: "object" description: "Free-form JSON metadata that will be stored with specific entity\ \ edits\n(eg, creation/update/delete).\n" additionalProperties: {} x-auth-responses: 401: description: "Not Authorized" schema: $ref: "#/definitions/error_response" headers: WWW_Authenticate: type: "string" 403: description: "Forbidden" schema: $ref: "#/definitions/error_response" x-entity-responses: 400: description: "Bad Request" schema: $ref: "#/definitions/error_response" 404: description: "Not Found" schema: $ref: "#/definitions/error_response" 500: description: "Generic Error" schema: $ref: "#/definitions/error_response"