Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionSupports queries on projectdoc documents, patching projectdoc documents, and creating new documents. 
Doctypeaddon-componenthide
NameDocuments 
Parent
Parent Property
property-nameName
 
Audience
Name List
render-no-hits-as-blanktrue
addon-componentrole
propertyAudience
 
Type
Name List
doctypeaddon-component-type
render-no-hits-as-blanktrue
propertyType
 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
propertyTags
 
Iteration
Iteration
valuefilled
hide
Since1.0hide
Path
Display Property Reference
property-nameParent
referred-property-namePath
 
Deprecatedhide
Removedhide
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription

The documents service allows to run queries to fetch document identifiers and information from projectdoc documents.

Since version 1.1 of the Web API this service also allows to create new documents based on a doctype and to patch projectdoc documents.

projectdoc-transclusion-macro
documentSupplier Support for Web API Extension
ids-Summary, !*

projectdoc-section
idSubordinate Components
titleHTTP Methods
Display Table
doctypeaddon-component
render-no-hits-as-blanktrue
selectShort Name+|, Since|, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
header-translationsShort Name=HTTP Method

...