Sign in
resources

Update an existing resource (editor only)

Changed on
put/api/books/{slug}/resources/{id}

Request

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

Path parameters

slugstring required

Book slug

idstring required

Resource ID

Request body

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

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'

Stored as the Postgres enum sentence_kind.

sentence_startinteger nullable
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 updated

Changes

  • 1f567b50f90cRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • 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

      the request property type changed from string null to no type

    • breaking

      the request property type changed from string null to no type

    • info

      added subschema #1 to the request property oneOf list

    • info

      added subschema #1 to the request property oneOf list

    • info

      added subschema #1 to the request property oneOf list

    • info

      added subschema #1 to the request property oneOf list

  • 9938a61f3fbfRevision changes
    • info

      added the new optional request property