openapi: 3.2.0
info:
  title: Online Store Pages API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Pages
paths:
  /pages:
    get:
      summary: Get Pages
      tags:
      - Pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  pages:
                    type: array
                    items:
                      $ref: '#/components/schemas/pages'
              examples: {}
      operationId: get-pages
      description: Gets an array of content pages.
    post:
      summary: Create a Page
      operationId: post-pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages'
      tags:
      - Pages
      description: Creates a content page.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  title: My Content Page
                  keywords: ''
                  description: ''
                  content: ''
                  is_hidden: false
                  store_id: 19
                  external_url: ''
                  is_content_only: false
                  url_rewrite: /mycontentpage.aspx
                  is_secure: false
                  is_login_required: false
                  head_tags: ''
              properties:
                title:
                  type: string
                keywords:
                  type: string
                description:
                  type: string
                content:
                  type: string
                is_hidden:
                  type: boolean
                store_id:
                  type: integer
                external_url:
                  type: string
                is_content_only:
                  type: boolean
                url_rewrite:
                  type: string
                is_secure:
                  type: boolean
                is_login_required:
                  type: boolean
                head_tags:
                  type: string
              required:
              - store_id
            examples:
              Example:
                value:
                  title: My Content Page
                  keywords: ''
                  description: ''
                  content: ''
                  is_hidden: false
                  store_id: 19
                  external_url: ''
                  is_content_only: false
                  url_rewrite: /mycontentpage.aspx
                  is_secure: false
                  is_login_required: false
                  head_tags: ''
  /pages/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: The ID of the `page`
    put:
      summary: Update a Page
      operationId: put-pages-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages'
      tags:
      - Pages
      description: Updates a content page.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages'
    delete:
      summary: Delete a Page
      operationId: delete-pages-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Pages
      description: Deletes a content page.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    pages:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string
        keywords:
          type: string
        description:
          type: string
        content:
          type: string
        is_hidden:
          type: boolean
        store_id:
          type: integer
        external_url:
          type: string
        is_content_only:
          type: boolean
        url_rewrite:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        is_secure:
          type: boolean
        is_login_required:
          type: boolean
        head_tags:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header