Sign in
resources

Create a resource. Any authenticated user may submit; editors (`ResourcesManage`) publish immediately, everyone else's suggestion enters the review queue as `pending` until an editor approves it.

Changed on
post/api/books/{slug}/resources

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

slugstring required

Book slug

Request body

admin_notesstring nullable
editor_notestring nullable
is_featuredboolean nullable
quoted_textstring nullable
resource_type'verbatim' | 'paraphrase' | 'allusion' required

Stored as the Postgres enum resource_type.

scope'work' | 'language' | 'edition'

Stored as the Postgres enum resource_scope (ADR 0008).

sentence_endinteger nullable
sentence_kind'body' | 'footnote' | 'figure' required

Stored as the Postgres enum sentence_kind.

sentence_startinteger required
source_idstring nullable
source_location_freeformstring nullable
source_page_endinteger nullable
source_page_startinteger nullable
verbatim_kind'entirety' | 'fragmentary'

Stored as the Postgres enum verbatim_kind.

Response

Resource created or submitted for review

Changes

  • 95fbdb1b2a1cRevision changes
    • info

      added the optional property /////// to the response with the status

  • 1f567b50f90cRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property type changed from string null to no type

    • breaking

      the request property type changed from string null to no type

    • breaking

      added subschema #1 to the // response property oneOf list for the response status

    • breaking

      the // response's property type changed from string null to no type for status

    • warning

      added the new allusion enum value to the // response property for the response status

    • warning

      added the new approved enum value to the // response property for the response status

    • warning

      added the new article enum value to the //////////// response property for the response status

    • warning

      added the new article enum value to the /////// response property for the response status

    • warning

      added the new author enum value to the ////////////// response property for the response status

    • warning

      added the new author enum value to the ///////// response property for the response status

    • warning

      added the new body enum value to the // response property for the response status

    • warning

      added the new book enum value to the //////////// response property for the response status

    • warning

      added the new book enum value to the /////// response property for the response status

    • warning

      added the new chapter enum value to the //////////// response property for the response status

    • warning

      added the new chapter enum value to the /////// response property for the response status

    • warning

      added the new contributor enum value to the ////////////// response property for the response status

    • warning

      added the new contributor enum value to the ///////// response property for the response status

    • warning

      added the new edition enum value to the // response property for the response status

    • warning

      added the new editor enum value to the ////////////// response property for the response status

    • warning

      added the new editor enum value to the ///////// response property for the response status

    • warning

      added the new figure enum value to the // response property for the response status

    • warning

      added the new footnote enum value to the // response property for the response status

    • warning

      added the new journal enum value to the //////////// response property for the response status

    • warning

      added the new journal enum value to the /////// response property for the response status

    • warning

      added the new language enum value to the // response property for the response status

    • warning

      added the new paraphrase enum value to the // response property for the response status

    • warning

      added the new pending enum value to the // response property for the response status

    • warning

      added the new rejected enum value to the // response property for the response status

    • warning

      added the new translator enum value to the ////////////// response property for the response status

    • warning

      added the new translator enum value to the ///////// response property for the response status

    • warning

      added the new verbatim enum value to the // response property for the response status

    • warning

      added the new web enum value to the //////////// response property for the response status

    • warning

      added the new web enum value to the /////// response property for the response status

    • warning

      added the new work enum value to the // response property for the response status

    • info

      added the new allusion enum value to the request property

    • info

      added the new body enum value to the request property

    • info

      added the new figure enum value to the request property

    • info

      added the new footnote enum value to the request property

    • info

      added the new paraphrase enum value to the request property

    • info

      added the new verbatim enum value to the request property

    • info

      added subschema #1 to the request property oneOf list

    • info

      added subschema #1 to the request property oneOf list