bitrise-openapi-tracker API documentation

Oct 31, 2024

Change #772f4520

0.1

Compare

1 structure change including:

1 Modification

Modified 1

POST /apps/{app-slug}/builds

Response
201 response Modified
- content type Modified
  - results property Added

Oct 22, 2024

Change #3bbcd2af

0.1

Compare

1 structure change including:

1 Modification

Modified 1

GET /users/{user-slug}/apple-api-credentials

Response
200 response Modified
- content type Modified
  - data property Modified
    - is_enterprise_account property Added

Sep 13, 2024

Change #768e436c

0.1

Breaking

Compare

2 structure changes including:

2 Breaking changes

2 Removals

Removed 2 Breaking

POST /apps/{app-slug}/releases/app-store

Removing a resource is always breaking unless it was deprecated before
Breaking

POST /apps/{app-slug}/releases/google-play

Removing a resource is always breaking unless it was deprecated before
Breaking

Sep 4, 2024

Change #9bf56444

0.1

Breaking

Compare

57 structure changes including:

2 Breaking changes

13 Additions

43 Modifications

1 Removal

Modified 43 Breaking

GET /apps/{app-slug}/builds

Response
200 response Modified
- content type Modified
  - data property Modified
    - abort_reason, branch, commit_hash, commit_message, commit_view_url, machine_type_id, pull_request_target_branch, pull_request_view_url, stack_identifier, tag, triggered_by properties Modified
      - Full types went from object to string
        Breaking
    - credit_cost property Modified
      - Full types went from object to integer
        Breaking
    - original_build_params property Modified
      - Full types went from array[integer] to object
        Breaking
    - rebuildable property Added

GET /apps/{app-slug}/builds/{build-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - abort_reason, branch, commit_hash, commit_message, commit_view_url, machine_type_id, pull_request_target_branch, pull_request_view_url, stack_identifier, tag, triggered_by properties Modified
      - Full types went from object to string
        Breaking
    - credit_cost property Modified
      - Full types went from object to integer
        Breaking
    - original_build_params property Modified
      - Full types went from array[integer] to object
        Breaking
    - rebuildable property Added

GET /apps/{app-slug}/builds/{build-slug}/artifacts

Response
200 response Modified
- content type Modified
  - data property Modified
    - artifact_meta, intermediate_file_info properties Modified
      - Full types went from array[integer] to object
        Breaking
    - artifact_type, title properties Modified
      - Full types went from object to string
        Breaking

GET /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - artifact_meta, intermediate_file_info properties Modified
      - Full types went from array[integer] to object
        Breaking
    - artifact_type, title properties Modified
      - Full types went from object to string
        Breaking

GET /apps/{app-slug}/generic-project-files

Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url, upload_url properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /apps/{app-slug}/generic-project-files/{generic-project-file-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - upload_url property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /apps/{app-slug}/outgoing-webhooks

Response
200 response Modified
- content type Modified
  - data property Modified
    - headers property Modified
      - Full types went from array[integer] to object
        Breaking

GET /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-items

Response
200 response Modified
- content type Modified
  - data property Modified
    - response_body, response_headers properties Modified
      - Full types went from object to string
        Breaking
    - response_http_status, response_seconds properties Modified
      - Full types went from object to integer
        Breaking

GET /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-items/{webhook-delivery-item-slug}

Response
200 response Modified
- content type Modified
  - response_body property Modified
    - Full types went from object to string
      Breaking
    - string, valid properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - response_headers property Modified
    - Full types went from object to string
      Breaking
    - string, valid properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - response_http_status property Modified
    - Full types went from object to integer
      Breaking
    - int64, valid properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
  - response_seconds property Modified
    - Full types went from object to integer
      Breaking
    - int64, valid properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /apps/{app-slug}/pipelines

Response
200 response Modified
- content type Modified
  - data property Modified
    - branch, commit_hash, commit_message, pull_request_target_branch, tag, triggered_by properties Modified
      - Full types went from object to string
        Breaking
    - credit_cost property Modified
      - Full types went from object to integer
        Breaking
    - trigger_params property Modified
    - rebuildable property Added

GET /apps/{app-slug}/pipelines/{pipeline-id}

Response
200 response Modified
- content type Modified
  - stages property Modified
    - workflows property Modified
  - rebuildable, type, workflows properties Added

GET /apps/{app-slug}/secrets

Response
200 response Modified
- content type Modified
  - secrets property Modified
    - id, scope properties Added

GET /apps/{app-slug}/secrets/{secret-name}/value

Operation is now deprecated

GET /builds

Response
200 response Modified
- content type Modified
  - data property Modified
    - abort_reason, branch, commit_hash, commit_message, commit_view_url, machine_type_id, pull_request_target_branch, pull_request_view_url, stack_identifier, tag, triggered_by properties Modified
      - Full types went from object to string
        Breaking
    - credit_cost property Modified
      - Full types went from object to integer
        Breaking
    - original_build_params property Modified
      - Full types went from array[integer] to object
        Breaking
    - repository property Modified

GET /me/activities

Response
200 response Modified
- content type Modified
  - data property Modified
    - description, event_icon, event_stype, target_path_string, title properties Modified
      - Full types went from object to string
        Breaking

GET /me/plan

Response
200 response Modified
- content type Modified
  - data property Modified
    - current_plan, pending_plan properties Modified

GET /organizations

Response
200 response Modified
- content type Modified
  - data property Modified
    - avatar_icon_url property Modified
      - Full types went from object to string
        Breaking

GET /organizations/{org-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - avatar_icon_url property Modified
      - Full types went from object to string
        Breaking

GET /organizations/{org-slug}/apps

Response
200 response Modified
- content type Modified
  - data property Modified
    - avatar_url, project_type, provider, repo_owner, repo_slug, repo_url properties Modified
      - Full types went from object to string
        Breaking

GET /organizations/{organization-slug}/addons

Response
200 response Modified
- content type Modified
  - data property Modified
    - apps property Modified

GET /pipelines

Query
status query parameter Modified
- Full types went from integer to string
  Breaking
Response
200 response Modified
- content type Modified
  - data property Modified
    - branch, commit_hash, commit_message, pull_request_target_branch, tag, triggered_by properties Modified
      - Full types went from object to string
        Breaking
    - credit_cost property Modified
      - Full types went from object to integer
        Breaking
    - repository property Modified

GET /users/{user-slug}/addons

Response
200 response Modified
- content type Modified
  - data property Modified
    - apps property Modified

PUT /apps/{app-slug}/secrets/{secret-name}

Operation is now deprecated

PUT /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}

Body
content type Modified
- headers property Modified
  - Full types went from array[integer] to object
    Breaking
Response
200 response Modified
- content type Modified
  - data property Modified
    - headers property Modified
      - Full types went from array[integer] to object
        Breaking

POST /apps/{app-slug}/outgoing-webhooks

Body
content type Modified
- headers property Modified
  - Full types went from array[integer] to object
    Breaking
Response
200 response Modified
- content type Modified
  - data property Modified
    - headers property Modified
      - Full types went from array[integer] to object
        Breaking

POST /apps/{app-slug}/generic-project-files/{generic-project-file-slug}/uploaded

Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url, upload_url properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /apps/{app-slug}/generic-project-files

Response
201 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /apps/{app-slug}/bitrise.yml

Body
content type Modified
- app_config_datastore_yaml property Modified
  - Full types went from string to object
    Breaking

POST /apps/{app-slug}/android-keystore-files/{android-keystore-file-slug}/uploaded

Path went from /apps/{app-slug}/android-keystore-files/{android-keystore-file-slug} to /apps/{app-slug}/android-keystore-files/{android-keystore-file-slug}/uploaded (same operationId)
Breaking
Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url, upload_url properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /apps/{app-slug}/android-keystore-files

Response
201 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PATCH /apps/{app-slug}/generic-project-files/{generic-project-file-slug}

Body
content type Modified
- exposed_meta_datastore property Modified
  - Full types went from array[integer] to object
    Breaking
Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url, upload_url properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

PATCH /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - artifact_meta, intermediate_file_info properties Modified
      - Full types went from array[integer] to object
        Breaking
    - artifact_type, title properties Modified
      - Full types went from object to string
        Breaking

PATCH /apps/{app-slug}/build-requests/{build-request-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - build_params property Modified
      - Full types went from array[integer] to object
        Breaking

GET /users/{user-slug}/apps

Response
200 response Modified
- content type Modified
  - data property Modified
    - avatar_url, project_type, provider, repo_owner, repo_slug, repo_url properties Modified
      - Full types went from object to string
        Breaking

DELETE /apps/{app-slug}/android-keystore-files/{android-keystore-file-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url, upload_url properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

DELETE /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - artifact_meta, intermediate_file_info properties Modified
      - Full types went from array[integer] to object
        Breaking
    - artifact_type, title properties Modified
      - Full types went from object to string
        Breaking

DELETE /apps/{app-slug}/generic-project-files/{generic-project-file-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url, upload_url properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

DELETE /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - headers property Modified
      - Full types went from array[integer] to object
        Breaking

GET /apps

Response
200 response Modified
- content type Modified
  - data property Modified
    - avatar_url, project_type, provider, repo_owner, repo_slug, repo_url properties Modified
      - Full types went from object to string
        Breaking

GET /apps/{app-slug}

Response
200 response Modified
- content type Modified
  - data property Modified
    - avatar_url, project_type, provider, repo_owner, repo_slug, repo_url properties Modified
      - Full types went from object to string
        Breaking

GET /apps/{app-slug}/android-keystore-files

Response
200 response Modified
- content type Modified
  - data property Modified
    - exposed_meta_datastore property Modified
      - Full types went from array[integer] to object
        Breaking
    - download_url, upload_url properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /apps/{app-slug}/archived-builds

Response
200 response Modified
- content type Modified
  - data property Modified
    - original_build_params property Modified
      - Full types went from array[integer] to object
        Breaking

GET /apps/{app-slug}/build-requests

Response
200 response Modified
- content type Modified
  - data property Modified
    - build_params property Modified
      - Full types went from array[integer] to object
        Breaking

Removed 1 Breaking

GET /organizations/{org-slug}/groups

Removing a resource is always breaking unless it was deprecated before
Breaking

Added 13

POST /organizations/{org-slug}/secrets

POST /organizations/{org-slug}/members

POST /organizations/{org-slug}/groups

POST /groups/{group-slug}/add_member

POST /apps/{app-slug}/secrets

PATCH /organizations/{org-slug}/secrets/{secret-name}

PATCH /apps/{app-slug}/secrets/{secret-name}

GET /organizations/{org-slug}/secrets/{secret-name}

GET /organizations/{org-slug}/secrets

GET /organizations/{org-slug}/members

GET /organizations/{org-slug}/groups

GET /apps/{app-slug}/secrets/{secret-name}

DELETE /organizations/{org-slug}/secrets/{secret-name}

Dec 16, 2023

Change #50abf8ca

0.1

Breaking

Compare

2 structure changes including:

1 Breaking change

1 Modification

1 Removal

Modified 1 Breaking

GET /apps/{app-slug}/pipelines

Query
build_environment query parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking

Removed 1 Breaking

GET /apps/{app-slug}/local-builds

Removing a resource is always breaking unless it was deprecated before
Breaking

Nov 17, 2023

Change #7c8cf383

0.1

Breaking

Compare

2 structure changes including:

2 Modifications

Modified 2 Breaking

POST /apps/{app-slug}/releases/app-store

Body
content type Modified
- automatic_store_upload property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking

POST /apps/{app-slug}/releases/google-play

Body
content type Modified
- automatic_store_upload, bundle_id properties Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- automatic_play_console_upload, package_name properties Added
Response
201 response Modified
- content type Modified
  - bundle_id property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - package_name property Added

Nov 16, 2023

Change #8314989a

0.1

Compare

2 structure changes including:

1 Addition

1 Modification

Modified 1

POST /apps/{app-slug}/releases/app-store

Body
content type Modified
- automatic_store_upload property Added

Added 1

POST /apps/{app-slug}/releases/google-play

Sep 8, 2023

Change #33cd167a

0.1

Compare

5 structure changes including:

5 Modifications

Modified 5

GET /apps/{app-slug}/local-builds

Response
200 response Modified
- data property Modified

GET /apps/{app-slug}/pipelines

Response
200 response Modified
- data property Modified
Query
build_environment, pipeline query parameters Added

GET /apps/{app-slug}/pipelines/{pipeline-id}

Response
200 response Modified
- trigger_params property Modified

POST /apps/register

Body
content type Modified
- git_owner, git_repo_slug, provider, type properties Modified

POST /apps/{app-slug}/builds

Body
content type Modified
- build_params property Modified

Jul 10, 2023

Change #552c98da

0.1

Compare

Do not miss any bitrise-openapi-tracker API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created