Soda

opencollection: 1.0.0
info:
  name: Soda Cloud REST API
  version: 1.0.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Verify login credentials
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/test-login
    docs: Verify login credentials
- info:
    name: Attributes
    type: folder
  items:
  - info:
      name: Retrieve all attributes
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/attributes
    docs: Retrieve all attributes
  - info:
      name: Create a new attribute
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/attributes
      body:
        type: json
        data: '{}'
    docs: Create a new attribute
  - info:
      name: Update an existing attribute
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/attributes/:attributeId
      params:
      - name: attributeId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update an existing attribute
  - info:
      name: Remove an attribute
      type: http
    http:
      method: DELETE
      url: https://cloud.soda.io/api/v1/attributes/:attributeId
      params:
      - name: attributeId
        value: ''
        type: path
    docs: Remove an attribute
- info:
    name: Checks
    type: folder
  items:
  - info:
      name: Retrieve all checks
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/checks
      params:
      - name: checkIds
        value: ''
        type: query
        description: Optional list of check IDs to filter by
    docs: Retrieve all checks
  - info:
      name: Remove a check
      type: http
    http:
      method: DELETE
      url: https://cloud.soda.io/api/v1/checks/:checkId
      params:
      - name: checkId
        value: ''
        type: path
    docs: Remove a check
- info:
    name: Contracts
    type: folder
  items:
  - info:
      name: List all contracts
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/contracts
    docs: List all contracts
  - info:
      name: Create a new contract
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/contracts
      body:
        type: json
        data: '{}'
    docs: Create a new contract
  - info:
      name: Initiate contract skeleton generation
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/contracts/actions/createSkeleton
      body:
        type: json
        data: '{}'
    docs: Initiate contract skeleton generation
  - info:
      name: Retrieve skeleton generation status
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/contracts/actions/createSkeleton/:operationId
      params:
      - name: operationId
        value: ''
        type: path
    docs: Retrieve skeleton generation status
  - info:
      name: Start contract generation
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/contracts/actions/generate
      body:
        type: json
        data: '{}'
    docs: Start contract generation
  - info:
      name: Check contract generation progress
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/contracts/actions/generate/:operationId
      params:
      - name: operationId
        value: ''
        type: path
    docs: Check contract generation progress
  - info:
      name: Fetch a specific contract
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/contracts/:contractId
      params:
      - name: contractId
        value: ''
        type: path
    docs: Fetch a specific contract
  - info:
      name: Update a contract
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/contracts/:contractId
      params:
      - name: contractId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a contract
  - info:
      name: Validate a contract
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/contracts/:contractId/verify
      params:
      - name: contractId
        value: ''
        type: path
    docs: Validate a contract
  - info:
      name: Retrieve contract version history
      type: http
    http:
      method: GET
      url: https://cloud.soda.io/api/v1/contracts/:contractId/versions
      params:
      - name: contractId
        value: ''
        type: path
    docs: Retrieve contract version history
- info:
    name: Datasets
    type: folder
  items:
  - info:
      name: Create or update data for a dataset
      type: http
    http:
      method: POST
      url: https://cloud.soda.io/api/v1/datasets/:datasetId
      params:
      - name: datasetId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create or update data for a dataset
bundled: true