APIs.io Engineering Platform Worker Versions 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 Versions 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 Versions
paths:
  /accounts/{account_id}/workers/scripts/{script_name}/versions:
    get:
      description: List of Worker Versions. The first version in the list is the latest version.
      operationId: worker-versions-list-versions
      parameters:
      - in: path
        name: script_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_schemas-script_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - description: Only return versions that can be used in a deployment. Ignores pagination.
        in: query
        name: deployable
        schema:
          default: false
          type: boolean
      - description: Current page.
        in: query
        name: page
        schema:
          default: 1
          type: integer
      - description: Items per-page.
        in: query
        name: per_page
        schema:
          type: integer
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_versions-list-response'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Versions response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_versions-list-response'
          description: List Versions response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Versions
      tags:
      - Worker Versions
      x-api-token-group:
      - Workers Tail Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.deployment.list
    post:
      description: 'Upload a Worker Version without deploying to Cloudflare''s network. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.'
      operationId: worker-versions-upload-version
      parameters:
      - in: path
        name: script_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_schemas-script_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        $ref: '#/components/requestBodies/workers_version-post'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_versions-upload-response'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Upload Version response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_versions-upload-response'
          description: Upload Version response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Upload Version
      tags:
      - Worker Versions
      x-api-token-group:
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.deployment.edit
  /accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}:
    get:
      operationId: worker-versions-get-version-detail
      parameters:
      - in: path
        name: version_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_version_identifier'
      - in: path
        name: script_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_schemas-script_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_versions-single-response'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get Version Detail response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_versions-single-response'
          description: Get Version Detail response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Version Detail
      tags:
      - Worker Versions
      x-api-token-group:
      - Workers Tail Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.deployment.read
components:
  schemas:
    workers_version-item-short:
      properties:
        id:
          example: 18f97339-c287-4872-9bdd-e2135c07ec12
          readOnly: true
          type: string
        metadata:
          example:
            author_email: user@example.com
            author_id: 408cbcdfd4dda4617efef40b04d168a1
            created_on: '2022-11-08T17:19:29.176266Z'
            modified_on: '2022-11-08T17:19:29.176266Z'
            source: api
          readOnly: true
          type: object
        number:
          example: 1
          readOnly: true
          type: number
      type: object
    workers_version-item-full:
      allOf:
      - $ref: '#/components/schemas/workers_version-item-short'
      - properties:
          resources:
            example:
              bindings:
              - json: example_binding
                name: JSON_VAR
                type: json
              script:
                etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794
                handlers:
                - fetch
                last_deployed_from: api
              script_runtime:
                usage_model: bundled
            readOnly: true
            type: object
        required:
        - resources
        type: object
    workers_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    workers_version_identifier:
      example: bcf48806-b317-4351-9ee7-36e7d557d4de
      maxLength: 36
      readOnly: true
      type: string
    workers_version-item-uploaded:
      allOf:
      - $ref: '#/components/schemas/workers_version-item-full'
      - properties:
          startup_time_ms:
            example: 10
            type: integer
        required:
        - resources
        type: object
    workers_versions-list-response:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            properties:
              items:
                items:
                  $ref: '#/components/schemas/workers_version-item-short'
                type: array
            type: object
    workers_versions-upload-response:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/workers_version-item-uploaded'
    workers_versions-single-response:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/workers_version-item-full'
    workers_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    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_schemas-script_name:
      description: Name of the script.
      example: this-is_my_script-01
      pattern: ^[a-z0-9_][a-z0-9-_]*$
      type: string
    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
  requestBodies:
    workers_version-post:
      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
          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 and referenced in the metadata as `main_module`.
                items:
                  format: binary
                  type: string
                type: array
              metadata:
                description: JSON encoded metadata about the uploaded parts and Worker configuration.
                properties:
                  annotations:
                    properties:
                      workers/message:
                        description: Human-readable message about the version.
                        example: Fixed worker code.
                        maxLength: 50
                        type: string
                      workers/tag:
                        description: User-provided identifier for the version.
                        example: any-identifier-from-external-system
                        maxLength: 25
                        type: string
                    type: object
                  bindings:
                    description: List of bindings available to the worker.
                    example:
                    - name: MY_ENV_VAR
                      text: my_data
                      type: plain_text
                    items:
                      type: object
                    type: array
                  compatibility_date:
                    description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
                    example: '2023-07-25'
                    type: string
                  compatibility_flags:
                    description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`.
                    items:
                      type: string
                    type: array
                  keep_bindings:
                    description: List of binding types to keep from previous_upload.
                    items:
                      type: string
                    type: array
                  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
                  usage_model:
                    description: Usage model to apply to invocations.
                    enum:
                    - standard
                    type: string
                type: object
            type: object
      required: true
  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