---
title: "PortalSnippetInfo"
url: "https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99/schemas/PortalSnippetInfo"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99.md

# PortalSnippetInfo

A single snippet for the portal

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal
  version: 3.3.1
components:
  schemas:
    SnippetId:
      description: The unique identifier of the snippet
      type: string
      format: uuid
      example: 582b9327-3eba-4bfe-9438-6066840dbbcb
      title: SnippetId
    SnippetName:
      description: The name of the snippet (no leading slash)
      type: string
      example: my-snippet
      title: SnippetName
    SnippetTitle:
      description: The title of the snippet
      type: string
      example: My Snippet
      title: SnippetTitle
    Visibility:
      description: Whether the page or snippet is public or private. Private pages and
        snippets are only accessible to authenticated users.
      type: string
      example: public
      enum:
        - public
        - private
      title: Resource Public Visibility
    Description:
      type: string
      example: A custom page about developer portals
      title: ResourceDescription
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    PortalSnippetInfo:
      description: A single snippet for the portal
      type: object
      properties:
        id:
          $ref: "#/components/schemas/SnippetId"
        name:
          $ref: "#/components/schemas/SnippetName"
        title:
          $ref: "#/components/schemas/SnippetTitle"
        visibility:
          $ref: "#/components/schemas/Visibility"
        description:
          $ref: "#/components/schemas/Description"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - title
        - visibility
        - created_at
        - updated_at
      title: PortalSnippetInfo
```
