---
title: "Api"
url: "https://nov18-dev.movespot.fyi/apis/portal-api-catalog-dev-3/versions/861ffb03-94d9-4545-a275-2893d1e5641b/schemas/Api"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-api-catalog-dev-3/versions/861ffb03-94d9-4545-a275-2893d1e5641b.md

# Api

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal API Catalog
  version: 3.0.11
components:
  schemas:
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    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
    AuthStrategy:
      type: object
      discriminator:
        propertyName: credential_type
      oneOf:
        - $ref: "#/components/schemas/AuthStrategyKeyAuth"
        - $ref: "#/components/schemas/AuthStrategyClientCredentials"
    ApiSpecType:
      description: >
        The type of specification being stored. This allows us to render the
        specification correctly.
      type: string
      example: oas3
      enum:
        - oas2
        - oas3
        - asyncapi
      title: API Spec Type
    AuthStrategyKeyAuth:
      description: KeyAuth Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - key_auth
        key_names:
          type: array
          items:
            type: string
        ttl:
          description: Default maximum Time-To-Live for keys created under this strategy.
          type: object
          properties:
            value:
              type: integer
              minimum: 1
            unit:
              type: string
              enum:
                - days
                - weeks
                - years
          required:
            - value
            - unit
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - key_names
    AuthStrategyClientCredentials:
      description: Client Credential Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - client_credentials
            - self_managed_client_credentials
        auth_methods:
          $ref: "#/components/schemas/AuthMethods"
        available_scopes:
          $ref: "#/components/schemas/AvailableScopes"
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - auth_methods
    AuthMethods:
      type: array
      items:
        description: Auth Methods enabled for this strategy
        type: string
      example:
        - bearer
    AvailableScopes:
      description: Possible developer selectable scopes for an application. Only
        present when using DCR Provider that supports it.
      type: array
      items:
        type: string
      example:
        - scope1
        - scope2
    Api:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        name:
          description: Name of API.
          type: string
          example: Billing
        version:
          description: Version of API.
          type: string
          example: v1
          nullable: true
        description:
          type: string
          example: V1 API for billing functions
          nullable: true
        visibility:
          description: >
            Visibility of the API listing.

            Public APIs are visible to anyone and do not require authentication
            to view and retrieve information about them.

            Private APIs are only visible to authenticated developers who have
            been granted access.
          type: string
          enum:
            - public
            - private
        slug:
          description: >
            The API `slug` is used in generated URLs to provide human readable
            paths.


            Defaults to `slugify(name + version)`
          type: string
          example: my-api-v1
          nullable: false
          pattern: ^[\w-]+$
        auth_strategies:
          description: Configurations for how the API is able to be registered for by
            applications.
          type: array
          items:
            $ref: "#/components/schemas/AuthStrategy"
        specifications:
          description: >
            Returns a list of specifications for an API.

            **Note:** This Beta property is deprecated and will be removed in a
            GA release.
          type: array
          items:
            type: object
            required:
              - id
              - type
            properties:
              id:
                description: The API specification identifier.
                type: string
                format: uuid
                example: 7710d5c4-d902-410b-992f-18b814155b53
                readOnly: true
              type:
                $ref: "#/components/schemas/ApiSpecType"
          deprecated: true
        current_version_summary:
          description: >
            Summary of the current version (version string of api.version
            matches version)
          type: object
          additionalProperties: false
          nullable: true
          properties:
            id:
              description: The API version identifier.
              type: string
              format: uuid
              example: 7710d5c4-d902-410b-992f-18b814155b53
              readOnly: true
            spec:
              type: object
              additionalProperties: false
              properties:
                type:
                  $ref: "#/components/schemas/ApiSpecType"
              required:
                - type
          required:
            - id
            - spec
        attributes:
          description: A set of attributes that describe the API
          type: object
          example:
            availability:
              - general
            domain:
              - financial
              - billing
          additionalProperties:
            description: Set of unique attribute names
            type: array
            items:
              description: A value associated with the attribute
              type: string
        images:
          type: object
          example:
            icon:
              uri: /apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw
          additionalProperties: false
          nullable: true
          properties:
            icon:
              type: object
              additionalProperties: false
              nullable: true
              properties:
                uri:
                  description: The relative API path for retrieving the raw the icon image.
                  type: string
                  format: uri-reference
                  nullable: true
                  pattern: ^/[^\s]+/images/icon/raw$
          readOnly: true
          title: Images
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - version
        - description
        - visibility
        - slug
        - specifications
        - attributes
      title: Api
```
