Google Cloud Endpoints Services API

The Services API from Google Cloud Endpoints — 4 operation(s) for services.

OpenAPI Specification

google-cloud-endpoints-services-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Cloud Endpoints Google Cloud Service Management Services API
  description: The Service Management API allows management of managed services used by Google Cloud Endpoints. It enables creating, configuring, and deploying API service configurations and managing service rollouts.
  version: v1
  contact:
    name: Google Cloud
    url: https://cloud.google.com/endpoints/docs
servers:
- url: https://servicemanagement.googleapis.com
tags:
- name: Services
paths:
  /v1/services:
    get:
      operationId: listServices
      summary: Google Cloud Endpoints List managed services
      description: Lists managed services for the authenticated project.
      parameters:
      - name: producerProjectId
        in: query
        schema:
          type: string
      - name: pageSize
        in: query
        schema:
          type: integer
      - name: pageToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListServicesResponse'
      tags:
      - Services
    post:
      operationId: createService
      summary: Google Cloud Endpoints Create a managed service
      description: Creates a new managed service.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagedService'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Services
  /v1/services/{serviceName}:
    get:
      operationId: getService
      summary: Google Cloud Endpoints Get a managed service
      description: Gets the configuration of a managed service.
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedService'
      tags:
      - Services
    delete:
      operationId: deleteService
      summary: Google Cloud Endpoints Delete a managed service
      description: Deletes a managed service.
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Services
  /v1/services/{serviceName}/configs:
    get:
      operationId: listServiceConfigs
      summary: Google Cloud Endpoints List service configurations
      description: Lists the history of service configurations for a managed service.
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListServiceConfigsResponse'
      tags:
      - Services
    post:
      operationId: createServiceConfig
      summary: Google Cloud Endpoints Create a service configuration
      description: Creates a new service configuration for a managed service.
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceConfig'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceConfig'
      tags:
      - Services
  /v1/services/{serviceName}/rollouts:
    get:
      operationId: listServiceRollouts
      summary: Google Cloud Endpoints List service rollouts
      description: Lists rollout history for a managed service.
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListServiceRolloutsResponse'
      tags:
      - Services
    post:
      operationId: createServiceRollout
      summary: Google Cloud Endpoints Create a service rollout
      description: Creates a new service rollout for a managed service.
      parameters:
      - name: serviceName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Rollout'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Services
components:
  schemas:
    ServiceConfig:
      type: object
      properties:
        name:
          type: string
        title:
          type: string
        producerProjectId:
          type: string
        id:
          type: string
        apis:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              version:
                type: string
        documentation:
          type: object
          properties:
            summary:
              type: string
        quota:
          type: object
          properties:
            limits:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  metric:
                    type: string
                  defaultLimit:
                    type: integer
        usage:
          type: object
          properties:
            requirements:
              type: array
              items:
                type: string
    ManagedService:
      type: object
      properties:
        serviceName:
          type: string
          description: The name of the service.
        producerProjectId:
          type: string
          description: The Google Cloud project that owns the service.
    Operation:
      type: object
      properties:
        name:
          type: string
        done:
          type: boolean
        metadata:
          type: object
        response:
          type: object
        error:
          type: object
    ListServiceConfigsResponse:
      type: object
      properties:
        serviceConfigs:
          type: array
          items:
            $ref: '#/components/schemas/ServiceConfig'
        nextPageToken:
          type: string
    ListServiceRolloutsResponse:
      type: object
      properties:
        rollouts:
          type: array
          items:
            $ref: '#/components/schemas/Rollout'
        nextPageToken:
          type: string
    ListServicesResponse:
      type: object
      properties:
        services:
          type: array
          items:
            $ref: '#/components/schemas/ManagedService'
        nextPageToken:
          type: string
    Rollout:
      type: object
      properties:
        rolloutId:
          type: string
        createTime:
          type: string
          format: date-time
        createdBy:
          type: string
        status:
          type: string
          enum:
          - ROLLOUT_STATUS_UNSPECIFIED
          - IN_PROGRESS
          - SUCCESS
          - CANCELLED
          - FAILED
        serviceName:
          type: string
        trafficPercentStrategy:
          type: object
          properties:
            percentages:
              type: object
              additionalProperties:
                type: number