Sign in
Library Documents

Upsert a document.

Changed on

Creates or replaces a markdown document in the route library.

put/api/v1/orgs/{orgId}/libraries/{name}/documents

Request

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

Path parameters

orgIdstring required
namestring required

Request body

pathstring required

Caller-supplied document path before normalization.

contentstring required

Full markdown source to parse and persist.

Response

OK

idstring required

Stable document identifier.

pathstring required

Normalized document path.

titlestring required

Display title resolved from the markdown source.

keywordsstring[] required

Normalized keywords derived from front matter.

headingsstring[] required

Plain heading text as authored.

processingStatusstring required

Secondary indexing state.

originstring required

Document source origin: "local" (owned) or "remote" (ingested).

excludedFromCodeReviewsboolean required

True when the document is hidden from list/search results on the code-review execution path (operational/informational content reviewers must not consult). Always false for remote documents — v1 scopes exclusion to hand-authored documents.

asScopedSkill'None' | 'Organization' | 'Library' | 'Repository' | 'User' required

Scope at which a library document is available as a skill.

createdAtstring date-time required

Timestamp when the document was created.

updatedAtstring date-time required

Timestamp when the document was last updated.

Changes

  • 913f7e8a4b30Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status