api-document

  • description
    Type: string
    required
  • isPrivate
    Type: boolean
    required
  • namespace
    Type: string · namespace
    min length:  
    3
    max length:  
    50     Pattern: ^[a-zA-Z0-9-_]+$
    required
  • slug
    Type: string · slug
    min length:  
    3
    max length:  
    60     Pattern: ^[a-z](?:[a-z0-9-]*[a-z0-9])?$
    required
  • tags
    required
  • title
    Type: string
    max length:  
    100
    required
  • uid
    Type: string · nanoid
    min length:  
    5
    required
  • version
    Type: string · version
    min length:  
    1
    required
  • versions
    Type: array object[] · managed-doc-version[]
    required
    • createdAt
      Type: number
      required
    • embedStatus
      Type: stringenum nullable
      required
      values
      • complete
      • failed
    • tags
      Type: array string[]
      required
    • uid
      Type: string · nanoid
      min length:  
      5
      required
    • upgraded
      Type: boolean
      required
    • version
      Type: string · version
      min length:  
      1
      required
    • jsonSha
      Type: string
    • tools
      Type: array object[]
    • yamlSha
      Type: string