APIs.io Engineering Platform Worker Environment API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Worker Environment API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Worker Environment
paths:
  /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content:
    get:
      description: Get script content from a worker with an environment
      operationId: worker-environment-get-script-content
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - in: path
        name: service_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_service'
      - in: path
        name: environment_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_environment'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get script content failure
        '200':
          content:
            string:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
          description: Get script content
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get script content
      tags:
      - Worker Environment
      x-api-token-group:
      - Workers Tail Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.script.read
    put:
      description: Put script content from a worker with an environment
      operationId: worker-environment-put-script-content
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - in: path
        name: service_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_service'
      - in: path
        name: environment_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_environment'
      - description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.
        in: header
        name: CF-WORKER-BODY-PART
        schema:
          type: string
      - description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.
        in: header
        name: CF-WORKER-MAIN-MODULE-PART
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            encoding:
              <any part name>:
                contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map
            schema:
              properties:
                <any part name>:
                  description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present. This should be referenced either in the metadata as `main_module` (esm)/`body_part` (service worker) or as a header `CF-WORKER-MAIN-MODULE-PART` (esm) /`CF-WORKER-BODY-PART` (service worker) by part name. Source maps may also be included using the `application/source-map` content type.
                  items:
                    format: binary
                    type: string
                  type: array
                metadata:
                  description: JSON encoded metadata about the uploaded parts and Worker configuration.
                  properties:
                    body_part:
                      description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
                      example: worker.js
                      type: string
                    main_module:
                      description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
                      example: worker.js
                      type: string
                  type: object
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Put script content failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-response-single'
          description: Put script content
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Put script content
      tags:
      - Worker Environment
      x-api-token-group:
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings:
    get:
      description: Get script settings from a worker with an environment
      operationId: worker-script-environment-get-settings
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - in: path
        name: service_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_service'
      - in: path
        name: environment_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_environment'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script settings failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-settings-response'
          description: Fetch script settings
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Script Settings
      tags:
      - Worker Environment
      x-api-token-group:
      - Workers Tail Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.script.read
    patch:
      description: Patch script metadata, such as bindings
      operationId: worker-script-environment-patch-settings
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - in: path
        name: service_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_service'
      - in: path
        name: environment_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_environment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_script-settings-response'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Patch script settings failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-settings-response'
          description: Patch script settings
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Patch Script Settings
      tags:
      - Worker Environment
      x-api-token-group:
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.script.create
components:
  schemas:
    workers_environment:
      description: Optional environment if the Worker utilizes one.
      example: production
      type: string
    workers_api-response-single:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      type: object
    workers_script-settings-response:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/workers_script-settings-item'
    workers_modified_on:
      description: When the script was last modified.
      example: '2017-01-01T00:00:00Z'
      format: date-time
      readOnly: true
      type: string
    workers_created_on:
      description: When the script was created.
      example: '2017-01-01T00:00:00Z'
      format: date-time
      readOnly: true
      type: string
    workers_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/workers_messages'
        messages:
          $ref: '#/components/schemas/workers_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    workers_script-response-single:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/workers_script-response'
        x-cfLinkErrors:
          '10001': Unsupported or unexpected Content Type
          '10002': Unexpected internal server error
          '10003': Missing required URL parameter
          '10004': Malformed URL parameter
          '10006': Unparseable script body
          '10007': Resource not found (similar to HTTP 404)
          '10014': Internal error while attempting authorization checks
          '10015': The current account is not authorized to use workers
          '10018': Attempted to update a script where the e-tag does not match
          '10021': Script content failed validation checks, but was otherwise parseable
          '10023': Unauthorized access attempt
          '10027': Script body was too large
          '10075': Requires a Workers Paid plan
    workers_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/workers_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/workers_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    workers_service:
      description: Name of Worker to bind to
      example: my-worker
      type: string
    workers_usage_model:
      description: Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').
      example: unbound
      pattern: ^(bundled|unbound)$
      type: string
    workers_etag:
      description: Hashed script content, can be used in a If-None-Match header when updating.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      type: string
    workers_tail_consumers:
      description: List of Workers that will consume logs from the attached Worker.
      items:
        $ref: '#/components/schemas/workers_tail_consumers_script'
      type: array
    workers_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    workers_placement_mode:
      description: Specifies the placement mode for the Worker (e.g. 'smart').
      example: smart
      type: string
    workers_script-response:
      properties:
        created_on:
          $ref: '#/components/schemas/workers_created_on'
        etag:
          $ref: '#/components/schemas/workers_etag'
        id:
          description: The id of the script in the Workers system. Usually the script name.
          example: my-workers-script
          readOnly: true
          type: string
        logpush:
          $ref: '#/components/schemas/workers_logpush'
        modified_on:
          $ref: '#/components/schemas/workers_modified_on'
        placement_mode:
          $ref: '#/components/schemas/workers_placement_mode'
        tail_consumers:
          $ref: '#/components/schemas/workers_tail_consumers'
        usage_model:
          $ref: '#/components/schemas/workers_usage_model'
    workers_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    workers_script-settings-item:
      properties:
        logpush:
          $ref: '#/components/schemas/workers_logpush'
        tail_consumers:
          $ref: '#/components/schemas/workers_tail_consumers'
      type: object
    workers_tail_consumers_script:
      description: A reference to a script that will consume logs from the attached Worker.
      properties:
        environment:
          description: Optional environment if the Worker utilizes one.
          example: production
          type: string
        namespace:
          description: Optional dispatch namespace the script belongs to.
          example: my-namespace
          type: string
        service:
          description: Name of Worker that is to be the consumer.
          example: my-log-consumer
          type: string
      required:
      - service
      type: object
    workers_logpush:
      description: Whether Logpush is turned on for the Worker.
      example: false
      type: boolean
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true