Serverless API documentation

1 day ago

Change #4756c0a3

1.0.0

Breaking

Compare

16 structure changes including:

16 Modifications

Modified 16 Breaking

GET /v1/Services

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Assets

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions

Response
200 response Modified
- application/json content type Modified
  - asset_versions property Modified
    - visibility property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}

Response
200 response Modified
- application/json content type Modified
  - visibility property Modified
    - Type went from string | null to string
      Breaking

GET /v1/Services/{ServiceSid}/Builds

Response
200 response Modified
- application/json content type Modified
  - builds property Modified
    - status, runtime properties Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Builds/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status, runtime properties Modified
    - Type went from string | null to string
      Breaking

GET /v1/Services/{ServiceSid}/Builds/{Sid}/Status

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

GET /v1/Services/{ServiceSid}/Environments

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Functions

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions

Response
200 response Modified
- application/json content type Modified
  - function_versions property Modified
    - visibility property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}

Response
200 response Modified
- application/json content type Modified
  - visibility property Modified
    - Type went from string | null to string
      Breaking

POST /v1/Services/{ServiceSid}/Builds

Response
201 response Modified
- application/json content type Modified
  - status, runtime properties Modified
    - Type went from string | null to string
      Breaking

POST /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments

Body
application/x-www-form-urlencoded content type Modified
- IsPlugin property Added

May 24, 2022

Change #2213db16

1.29.1

Breaking

Compare

7 structure changes including:

7 Modifications

Modified 7 Breaking

GET /v1/Services

Response
200 response Modified
- services property Modified

GET /v1/Services/{ServiceSid}/Builds

Response
200 response Modified
- builds property Modified

GET /v1/Services/{ServiceSid}/Builds/{Sid}

Response
200 response Modified
- asset_versions, dependencies, function_versions properties Modified

GET /v1/Services/{Sid}

Response
200 response Modified
- domain_base property Added

POST /v1/Services

Response
201 response Modified
- domain_base property Added

POST /v1/Services/{ServiceSid}/Builds

Response
201 response Modified
- asset_versions, dependencies, function_versions properties Modified

POST /v1/Services/{Sid}

Response
200 response Modified
- domain_base property Added

Apr 19, 2021

Change #d616e474

1.13.0

Compare

Do not miss any Serverless API changes, ever again

Changelog

API structure has changed

API structure has changed

API documentation has been created