reactor-api.yml

openapi: 3.1.0
info:
  title: Adobe Launch Reactor API
  description: >-
    The Reactor API allows you to programmatically manage all resources for
    Adobe Experience Platform Tags, including properties, data elements, rules,
    extensions, library builds, and environments. It follows the JSON:API
    specification for request and response formatting.
  version: 1.0.0
  contact:
    name: Adobe Developer Support
    url: https://experienceleague.adobe.com/?support-solution=Experience+Platform
  license:
    name: Adobe Terms of Service
    url: https://www.adobe.com/legal/terms.html
  termsOfService: https://www.adobe.com/legal/terms.html

servers:
- url: https://reactor.adobe.io
  description: Adobe Reactor API Production Server

security:
- bearerAuth: []
  apiKey: []
  orgId: []

paths:
  # Companies
  /companies:
    get:
      operationId: listCompanies
      summary: List Companies
      description: Retrieve all companies you have access to.
      tags:
      - Companies
      parameters:
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of companies.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CompanyListResponse'

              examples:
                Listcompanies200Example:
                  summary: Default listCompanies 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: companies
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /companies/{companyId}:
    get:
      operationId: getCompany
      summary: Retrieve a Company
      description: Look up details for a specific company by its ID.
      tags:
      - Companies
      parameters:
      - $ref: '#/components/parameters/companyId'
      responses:
        '200':
          description: Company details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CompanySingleResponse'
              examples:
                Getcompany200Example:
                  summary: Default getCompany 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: companies
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'

  # Properties
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /companies/{companyId}/properties:
    get:
      operationId: listPropertiesForCompany
      summary: List Properties for a Company
      description: Retrieve a list of properties belonging to a company.
      tags:
      - Properties
      parameters:
      - $ref: '#/components/parameters/companyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterEnabled'
      - $ref: '#/components/parameters/filterPlatform'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of properties.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PropertyListResponse'
              examples:
                Listpropertiesforcompany200Example:
                  summary: Default listPropertiesForCompany 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: properties
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createProperty
      summary: Create a Property
      description: Create a new property under the specified company.
      tags:
      - Properties
      parameters:
      - $ref: '#/components/parameters/companyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/PropertyCreateRequest'
            examples:
              CreatepropertyRequestExample:
                summary: Default createProperty request
                x-microcks-default: true
                value:
                  data:
                    type: properties
                    attributes:
                      name: Example Title
                      platform: web
                      domains:
                      - {}
                      privacy: optin
                      ssl_enabled: true
                      development: true
                      rule_component_sequencing_enabled: true
                      undefined_vars_return_empty: true
      responses:
        '201':
          description: Property created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PropertySingleResponse'
              examples:
                Createproperty201Example:
                  summary: Default createProperty 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: properties
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}:
    get:
      operationId: getProperty
      summary: Retrieve a Property
      description: Look up details for a specific property by its ID.
      tags:
      - Properties
      parameters:
      - $ref: '#/components/parameters/propertyId'
      responses:
        '200':
          description: Property details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PropertySingleResponse'
              examples:
                Getproperty200Example:
                  summary: Default getProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: properties
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateProperty
      summary: Update a Property
      description: Update the editable attributes of a property.
      tags:
      - Properties
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/PropertyUpdateRequest'
            examples:
              UpdatepropertyRequestExample:
                summary: Default updateProperty request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: properties
                    attributes:
                      name: Example Title
                      domains:
                      - {}
                      privacy: optin
                      ssl_enabled: true
                      development: true
                      rule_component_sequencing_enabled: true
                      undefined_vars_return_empty: true
      responses:
        '200':
          description: Property updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PropertySingleResponse'
              examples:
                Updateproperty200Example:
                  summary: Default updateProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: properties
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteProperty
      summary: Delete a Property
      description: Remove a property. Returns HTTP 204 on success.
      tags:
      - Properties
      parameters:
      - $ref: '#/components/parameters/propertyId'
      responses:
        '204':
          description: Property deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/company:
    get:
      operationId: getCompanyForProperty
      summary: Get the Company for a Property
      description: Retrieve the company that owns the specified property.
      tags:
      - Properties
      parameters:
      - $ref: '#/components/parameters/propertyId'
      responses:
        '200':
          description: Company details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CompanySingleResponse'

  # Rules
              examples:
                Getcompanyforproperty200Example:
                  summary: Default getCompanyForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: companies
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/rules:
    get:
      operationId: listRulesForProperty
      summary: List Rules for a Property
      description: Retrieve all rules belonging to a property.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterEnabled'
      - $ref: '#/components/parameters/filterPublished'
      - $ref: '#/components/parameters/filterDirty'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of rules.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleListResponse'
              examples:
                Listrulesforproperty200Example:
                  summary: Default listRulesForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: rules
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createRule
      summary: Create a Rule
      description: Create a new rule under the specified property.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RuleCreateRequest'
            examples:
              CreateruleRequestExample:
                summary: Default createRule request
                x-microcks-default: true
                value:
                  data:
                    type: rules
                    attributes:
                      name: Example Title
                      enabled: true
      responses:
        '201':
          description: Rule created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleSingleResponse'
              examples:
                Createrule201Example:
                  summary: Default createRule 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: rules
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rules/{ruleId}:
    get:
      operationId: getRule
      summary: Retrieve a Rule
      description: Look up a specific rule by its ID.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/ruleId'
      responses:
        '200':
          description: Rule details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleSingleResponse'
              examples:
                Getrule200Example:
                  summary: Default getRule 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: rules
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateRule
      summary: Update a Rule
      description: Modify rule attributes.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/ruleId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RuleUpdateRequest'
            examples:
              UpdateruleRequestExample:
                summary: Default updateRule request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: rules
                    attributes:
                      name: Example Title
                      enabled: true
      responses:
        '200':
          description: Rule updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleSingleResponse'
              examples:
                Updaterule200Example:
                  summary: Default updateRule 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: rules
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteRule
      summary: Delete a Rule
      description: Remove a rule. Returns HTTP 204 on success.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/ruleId'
      responses:
        '204':
          description: Rule deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rules/{ruleId}/libraries:
    get:
      operationId: listLibrariesForRule
      summary: List Libraries for a Rule
      description: Retrieve libraries that use the specified rule.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/ruleId'
      responses:
        '200':
          description: A list of libraries.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/LibraryListResponse'

              examples:
                Listlibrariesforrule200Example:
                  summary: Default listLibrariesForRule 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: libraries
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rules/{ruleId}/revisions:
    get:
      operationId: listRevisionsForRule
      summary: List Revisions for a Rule
      description: Retrieve the revision history for a rule.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/ruleId'
      responses:
        '200':
          description: A list of rule revisions.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleListResponse'

              examples:
                Listrevisionsforrule200Example:
                  summary: Default listRevisionsForRule 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: rules
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rules/{ruleId}/origin:
    get:
      operationId: getOriginForRule
      summary: Get the Origin for a Rule
      description: Retrieve the previous revision of a rule.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/ruleId'
      responses:
        '200':
          description: Origin rule details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleSingleResponse'

              examples:
                Getoriginforrule200Example:
                  summary: Default getOriginForRule 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: rules
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rules/{ruleId}/property:
    get:
      operationId: getPropertyForRule
      summary: Get the Property for a Rule
      description: Retrieve the property that owns the specified rule.
      tags:
      - Rules
      parameters:
      - $ref: '#/components/parameters/ruleId'
      responses:
        '200':
          description: Property details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PropertySingleResponse'

  # Rule Components
              examples:
                Getpropertyforrule200Example:
                  summary: Default getPropertyForRule 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: properties
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/rule_components:
    post:
      operationId: createRuleComponent
      summary: Create a Rule Component
      description: Create a new rule component (event, condition, or action) under the specified property.
      tags:
      - Rule Components
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RuleComponentCreateRequest'
            examples:
              CreaterulecomponentRequestExample:
                summary: Default createRuleComponent request
                x-microcks-default: true
                value:
                  data:
                    type: rule_components
                    attributes:
                      name: Example Title
                      delegate_descriptor_id: '500123'
                      order: 10
                      settings: example_value
                      timeout: 10
                      delay_next: true
                      negate: true
                    relationships:
                      rules:
                        data: {}
                      extension:
                        data: {}
      responses:
        '201':
          description: Rule component created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleComponentSingleResponse'
              examples:
                Createrulecomponent201Example:
                  summary: Default createRuleComponent 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: rule_components
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rules/{ruleId}/rule_components:
    get:
      operationId: listRuleComponentsForRule
      summary: List Rule Components for a Rule
      description: Retrieve all components belonging to a rule.
      tags:
      - Rule Components
      parameters:
      - $ref: '#/components/parameters/ruleId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterEnabled'
      - $ref: '#/components/parameters/filterPublished'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of rule components.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleComponentListResponse'

              examples:
                Listrulecomponentsforrule200Example:
                  summary: Default listRuleComponentsForRule 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: rule_components
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rule_components/{ruleComponentId}:
    get:
      operationId: getRuleComponent
      summary: Retrieve a Rule Component
      description: Look up a specific rule component by its ID.
      tags:
      - Rule Components
      parameters:
      - $ref: '#/components/parameters/ruleComponentId'
      responses:
        '200':
          description: Rule component details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleComponentSingleResponse'
              examples:
                Getrulecomponent200Example:
                  summary: Default getRuleComponent 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: rule_components
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateRuleComponent
      summary: Update a Rule Component
      description: Modify a rule component's attributes.
      tags:
      - Rule Components
      parameters:
      - $ref: '#/components/parameters/ruleComponentId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RuleComponentUpdateRequest'
            examples:
              UpdaterulecomponentRequestExample:
                summary: Default updateRuleComponent request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: rule_components
                    attributes:
                      name: Example Title
                      order: 10
                      settings: example_value
                      timeout: 10
                      delay_next: true
                      negate: true
      responses:
        '200':
          description: Rule component updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleComponentSingleResponse'
              examples:
                Updaterulecomponent200Example:
                  summary: Default updateRuleComponent 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: rule_components
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteRuleComponent
      summary: Delete a Rule Component
      description: Remove a rule component. Returns HTTP 204 on success.
      tags:
      - Rule Components
      parameters:
      - $ref: '#/components/parameters/ruleComponentId'
      responses:
        '204':
          description: Rule component deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rule_components/{ruleComponentId}/extension:
    get:
      operationId: getExtensionForRuleComponent
      summary: Get the Extension for a Rule Component
      description: Retrieve the extension that provides the specified rule component.
      tags:
      - Rule Components
      parameters:
      - $ref: '#/components/parameters/ruleComponentId'
      responses:
        '200':
          description: Extension details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionSingleResponse'

  # Data Elements
              examples:
                Getextensionforrulecomponent200Example:
                  summary: Default getExtensionForRuleComponent 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extensions
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/data_elements:
    get:
      operationId: listDataElementsForProperty
      summary: List Data Elements for a Property
      description: Retrieve all data elements belonging to a property.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterEnabled'
      - $ref: '#/components/parameters/filterPublished'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of data elements.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DataElementListResponse'
              examples:
                Listdataelementsforproperty200Example:
                  summary: Default listDataElementsForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: data_elements
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDataElement
      summary: Create a Data Element
      description: Create a new data element under the specified property.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DataElementCreateRequest'
            examples:
              CreatedataelementRequestExample:
                summary: Default createDataElement request
                x-microcks-default: true
                value:
                  data:
                    type: data_elements
                    attributes:
                      name: Example Title
                      delegate_descriptor_id: '500123'
                      default_value: example_value
                      settings: example_value
                      storage_duration: pageview
                      force_lower_case: true
                      clean_text: true
                      enabled: true
                    relationships:
                      extension:
                        data: {}
      responses:
        '201':
          description: Data element created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DataElementSingleResponse'
              examples:
                Createdataelement201Example:
                  summary: Default createDataElement 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: data_elements
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data_elements/{dataElementId}:
    get:
      operationId: getDataElement
      summary: Retrieve a Data Element
      description: Look up a specific data element by its ID.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/dataElementId'
      responses:
        '200':
          description: Data element details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DataElementSingleResponse'
              examples:
                Getdataelement200Example:
                  summary: Default getDataElement 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: data_elements
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateDataElement
      summary: Update a Data Element
      description: Modify a data element's attributes.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/dataElementId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DataElementUpdateRequest'
            examples:
              UpdatedataelementRequestExample:
                summary: Default updateDataElement request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: data_elements
                    attributes:
                      name: Example Title
                      default_value: example_value
                      settings: example_value
                      storage_duration: pageview
                      force_lower_case: true
                      clean_text: true
                      enabled: true
      responses:
        '200':
          description: Data element updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DataElementSingleResponse'
              examples:
                Updatedataelement200Example:
                  summary: Default updateDataElement 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: data_elements
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDataElement
      summary: Delete a Data Element
      description: Remove a data element. Returns HTTP 204 on success.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/dataElementId'
      responses:
        '204':
          description: Data element deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data_elements/{dataElementId}/revisions:
    get:
      operationId: listRevisionsForDataElement
      summary: List Revisions for a Data Element
      description: Retrieve the revision history for a data element.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/dataElementId'
      responses:
        '200':
          description: A list of data element revisions.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DataElementListResponse'

              examples:
                Listrevisionsfordataelement200Example:
                  summary: Default listRevisionsForDataElement 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: data_elements
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data_elements/{dataElementId}/extension:
    get:
      operationId: getExtensionForDataElement
      summary: Get the Extension for a Data Element
      description: Retrieve the extension associated with the specified data element.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/dataElementId'
      responses:
        '200':
          description: Extension details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionSingleResponse'

              examples:
                Getextensionfordataelement200Example:
                  summary: Default getExtensionForDataElement 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extensions
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data_elements/{dataElementId}/property:
    get:
      operationId: getPropertyForDataElement
      summary: Get the Property for a Data Element
      description: Retrieve the property that owns the specified data element.
      tags:
      - Data Elements
      parameters:
      - $ref: '#/components/parameters/dataElementId'
      responses:
        '200':
          description: Property details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PropertySingleResponse'

  # Extensions
              examples:
                Getpropertyfordataelement200Example:
                  summary: Default getPropertyForDataElement 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: properties
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/extensions:
    get:
      operationId: listExtensionsForProperty
      summary: List Extensions for a Property
      description: Retrieve all extensions installed in a property.
      tags:
      - Extensions
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterEnabled'
      - $ref: '#/components/parameters/filterPublished'
      - $ref: '#/components/parameters/filterDirty'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of extensions.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionListResponse'
              examples:
                Listextensionsforproperty200Example:
                  summary: Default listExtensionsForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: extensions
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createExtension
      summary: Install an Extension
      description: Install a new extension in the specified property.
      tags:
      - Extensions
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ExtensionCreateRequest'
            examples:
              CreateextensionRequestExample:
                summary: Default createExtension request
                x-microcks-default: true
                value:
                  data:
                    type: extensions
                    attributes:
                      delegate_descriptor_id: '500123'
                      settings: example_value
                      enabled: true
                    relationships:
                      extension_package:
                        data: {}
      responses:
        '201':
          description: Extension installed successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionSingleResponse'
              examples:
                Createextension201Example:
                  summary: Default createExtension 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extensions
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extensions/{extensionId}:
    get:
      operationId: getExtension
      summary: Retrieve an Extension
      description: Look up a specific extension by its ID.
      tags:
      - Extensions
      parameters:
      - $ref: '#/components/parameters/extensionId'
      responses:
        '200':
          description: Extension details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionSingleResponse'
              examples:
                Getextension200Example:
                  summary: Default getExtension 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extensions
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateExtension
      summary: Revise an Extension
      description: Update or revise an extension's attributes.
      tags:
      - Extensions
      parameters:
      - $ref: '#/components/parameters/extensionId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ExtensionUpdateRequest'
            examples:
              UpdateextensionRequestExample:
                summary: Default updateExtension request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: extensions
                    attributes:
                      delegate_descriptor_id: '500123'
                      settings: example_value
                      enabled: true
                    meta:
                      action: revise
      responses:
        '200':
          description: Extension updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionSingleResponse'
              examples:
                Updateextension200Example:
                  summary: Default updateExtension 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extensions
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteExtension
      summary: Delete an Extension
      description: Remove an extension. Returns HTTP 204 on success.
      tags:
      - Extensions
      parameters:
      - $ref: '#/components/parameters/extensionId'
      responses:
        '204':
          description: Extension deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extensions/{extensionId}/extension_package:
    get:
      operationId: getExtensionPackageForExtension
      summary: Get the Extension Package for an Extension
      description: Retrieve the extension package associated with the specified extension.
      tags:
      - Extensions
      parameters:
      - $ref: '#/components/parameters/extensionId'
      responses:
        '200':
          description: Extension package details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageSingleResponse'

              examples:
                Getextensionpackageforextension200Example:
                  summary: Default getExtensionPackageForExtension 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extension_packages
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extensions/{extensionId}/revisions:
    get:
      operationId: listRevisionsForExtension
      summary: List Revisions for an Extension
      description: Retrieve the revision history for an extension.
      tags:
      - Extensions
      parameters:
      - $ref: '#/components/parameters/extensionId'
      responses:
        '200':
          description: A list of extension revisions.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionListResponse'

  # Extension Packages
              examples:
                Listrevisionsforextension200Example:
                  summary: Default listRevisionsForExtension 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: extensions
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extension_packages:
    get:
      operationId: listExtensionPackages
      summary: List Extension Packages
      description: Retrieve all extension packages available to you.
      tags:
      - Extension Packages
      parameters:
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of extension packages.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageListResponse'
              examples:
                Listextensionpackages200Example:
                  summary: Default listExtensionPackages 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: extension_packages
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createExtensionPackage
      summary: Create an Extension Package
      description: Upload a new extension package via multipart form data.
      tags:
      - Extension Packages
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                package:
                  type: string
                  format: binary
                  description: The extension package ZIP file.
            examples:
              CreateextensionpackageRequestExample:
                summary: Default createExtensionPackage request
                x-microcks-default: true
                value:
                  package: example_value
      responses:
        '201':
          description: Extension package created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageSingleResponse'

              examples:
                Createextensionpackage201Example:
                  summary: Default createExtensionPackage 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extension_packages
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extension_packages/{extensionPackageId}:
    get:
      operationId: getExtensionPackage
      summary: Retrieve an Extension Package
      description: Look up a specific extension package by its ID.
      tags:
      - Extension Packages
      parameters:
      - $ref: '#/components/parameters/extensionPackageId'
      responses:
        '200':
          description: Extension package details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageSingleResponse'
              examples:
                Getextensionpackage200Example:
                  summary: Default getExtensionPackage 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extension_packages
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateExtensionPackage
      summary: Update an Extension Package
      description: >-
        Update an extension package. Also used to release privately or
        discontinue a package by setting the appropriate meta action.
      tags:
      - Extension Packages
      parameters:
      - $ref: '#/components/parameters/extensionPackageId'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                package:
                  type: string
                  format: binary
                  description: The updated extension package ZIP file.
            examples:
              UpdateextensionpackageRequestExample:
                summary: Default updateExtensionPackage request
                x-microcks-default: true
                value:
                  package: example_value
      responses:
        '200':
          description: Extension package updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageSingleResponse'
              examples:
                Updateextensionpackage200Example:
                  summary: Default updateExtensionPackage 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: extension_packages
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /extension_packages/{extensionPackageId}/versions:
    get:
      operationId: listVersionsForExtensionPackage
      summary: List Versions for an Extension Package
      description: Retrieve all previous versions of an extension package.
      tags:
      - Extension Packages
      parameters:
      - $ref: '#/components/parameters/extensionPackageId'
      responses:
        '200':
          description: A list of extension package versions.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionPackageListResponse'

  # Libraries
              examples:
                Listversionsforextensionpackage200Example:
                  summary: Default listVersionsForExtensionPackage 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: extension_packages
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/libraries:
    get:
      operationId: listLibrariesForProperty
      summary: List Libraries for a Property
      description: Retrieve a list of libraries belonging to a property.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of libraries.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/LibraryListResponse'
              examples:
                Listlibrariesforproperty200Example:
                  summary: Default listLibrariesForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: libraries
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createLibrary
      summary: Create a Library
      description: Create a new library under the specified property.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/LibraryCreateRequest'
            examples:
              CreatelibraryRequestExample:
                summary: Default createLibrary request
                x-microcks-default: true
                value:
                  data:
                    type: libraries
                    attributes:
                      name: Example Title
                    relationships:
                      environment:
                        data: {}
                      data_elements:
                        data: {}
                      extensions:
                        data: {}
                      rules:
                        data: {}
      responses:
        '201':
          description: Library created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/LibrarySingleResponse'
              examples:
                Createlibrary201Example:
                  summary: Default createLibrary 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: libraries
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}:
    get:
      operationId: getLibrary
      summary: Retrieve a Library
      description: Look up a specific library by its ID.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      responses:
        '200':
          description: Library details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/LibrarySingleResponse'
              examples:
                Getlibrary200Example:
                  summary: Default getLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: libraries
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateLibrary
      summary: Update a Library
      description: Transition a library's publishing state or modify its attributes.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/LibraryUpdateRequest'
            examples:
              UpdatelibraryRequestExample:
                summary: Default updateLibrary request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: libraries
                    attributes:
                      name: Example Title
                    meta:
                      action: submit
      responses:
        '200':
          description: Library updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/LibrarySingleResponse'
              examples:
                Updatelibrary200Example:
                  summary: Default updateLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: libraries
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/relationships/{resourceType}:
    post:
      operationId: addResourcesToLibrary
      summary: Add Resources to a Library
      description: Add data elements, extensions, or rules to a library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      - $ref: '#/components/parameters/resourceType'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RelationshipRequest'
            examples:
              AddresourcestolibraryRequestExample:
                summary: Default addResourcesToLibrary request
                x-microcks-default: true
                value:
                  data:
                  - id: abc123
                    type: example_value
      responses:
        '200':
          description: Resources added successfully.
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: replaceResourcesInLibrary
      summary: Replace Resources in a Library
      description: Replace the existing set of resources in a library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      - $ref: '#/components/parameters/resourceType'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RelationshipRequest'
            examples:
              ReplaceresourcesinlibraryRequestExample:
                summary: Default replaceResourcesInLibrary request
                x-microcks-default: true
                value:
                  data:
                  - id: abc123
                    type: example_value
      responses:
        '200':
          description: Resources replaced successfully.
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: removeResourcesFromLibrary
      summary: Remove Resources From a Library
      description: Remove data elements, extensions, or rules from a library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      - $ref: '#/components/parameters/resourceType'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RelationshipRequest'
            examples:
              RemoveresourcesfromlibraryRequestExample:
                summary: Default removeResourcesFromLibrary request
                x-microcks-default: true
                value:
                  data:
                  - id: abc123
                    type: example_value
      responses:
        '204':
          description: Resources removed successfully.

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/relationships/environment:
    post:
      operationId: setEnvironmentForLibrary
      summary: Set Environment for a Library
      description: Assign a library to an environment for publishing.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/RelationshipSingleRequest'
            examples:
              SetenvironmentforlibraryRequestExample:
                summary: Default setEnvironmentForLibrary request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: example_value
      responses:
        '200':
          description: Environment assigned successfully.
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/builds:
    get:
      operationId: listBuildsForLibrary
      summary: List Builds for a Library
      description: Retrieve all builds for a specific library.
      tags:
      - Builds
      parameters:
      - $ref: '#/components/parameters/libraryId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of builds.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/BuildListResponse'
              examples:
                Listbuildsforlibrary200Example:
                  summary: Default listBuildsForLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: builds
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createBuild
      summary: Create a Build
      description: Compile a library into a build for deployment.
      tags:
      - Builds
      parameters:
      - $ref: '#/components/parameters/libraryId'
      responses:
        '201':
          description: Build created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/BuildSingleResponse'

              examples:
                Createbuild201Example:
                  summary: Default createBuild 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: builds
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/data_elements:
    get:
      operationId: listDataElementsForLibrary
      summary: List Data Elements for a Library
      description: Retrieve data elements associated with a library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      responses:
        '200':
          description: A list of data elements.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/DataElementListResponse'

              examples:
                Listdataelementsforlibrary200Example:
                  summary: Default listDataElementsForLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: data_elements
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/extensions:
    get:
      operationId: listExtensionsForLibrary
      summary: List Extensions for a Library
      description: Retrieve extensions associated with a library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      responses:
        '200':
          description: A list of extensions.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ExtensionListResponse'

              examples:
                Listextensionsforlibrary200Example:
                  summary: Default listExtensionsForLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: extensions
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/rules:
    get:
      operationId: listRulesForLibrary
      summary: List Rules for a Library
      description: Retrieve rules associated with a library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      responses:
        '200':
          description: A list of rules.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RuleListResponse'

              examples:
                Listrulesforlibrary200Example:
                  summary: Default listRulesForLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: rules
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/environment:
    get:
      operationId: getEnvironmentForLibrary
      summary: Get the Environment for a Library
      description: Retrieve the environment assigned to a library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      responses:
        '200':
          description: Environment details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EnvironmentSingleResponse'

              examples:
                Getenvironmentforlibrary200Example:
                  summary: Default getEnvironmentForLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: environments
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /libraries/{libraryId}/property:
    get:
      operationId: getPropertyForLibrary
      summary: Get the Property for a Library
      description: Retrieve the property that owns the specified library.
      tags:
      - Libraries
      parameters:
      - $ref: '#/components/parameters/libraryId'
      responses:
        '200':
          description: Property details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/PropertySingleResponse'

  # Builds
              examples:
                Getpropertyforlibrary200Example:
                  summary: Default getPropertyForLibrary 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: properties
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /builds/{buildId}:
    get:
      operationId: getBuild
      summary: Retrieve a Build
      description: Look up a specific build by its ID.
      tags:
      - Builds
      parameters:
      - $ref: '#/components/parameters/buildId'
      responses:
        '200':
          description: Build details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/BuildSingleResponse'
              examples:
                Getbuild200Example:
                  summary: Default getBuild 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: builds
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: republishBuild
      summary: Republish a Build
      description: Republish an existing build.
      tags:
      - Builds
      parameters:
      - $ref: '#/components/parameters/buildId'
      responses:
        '200':
          description: Build republished successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/BuildSingleResponse'
              examples:
                Republishbuild200Example:
                  summary: Default republishBuild 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: builds
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /builds/{buildId}/environment:
    get:
      operationId: getEnvironmentForBuild
      summary: Get the Environment for a Build
      description: Retrieve the deployment environment for a build.
      tags:
      - Builds
      parameters:
      - $ref: '#/components/parameters/buildId'
      responses:
        '200':
          description: Environment details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EnvironmentSingleResponse'

              examples:
                Getenvironmentforbuild200Example:
                  summary: Default getEnvironmentForBuild 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: environments
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /builds/{buildId}/library:
    get:
      operationId: getLibraryForBuild
      summary: Get the Library for a Build
      description: Retrieve the library from which a build was compiled.
      tags:
      - Builds
      parameters:
      - $ref: '#/components/parameters/buildId'
      responses:
        '200':
          description: Library details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/LibrarySingleResponse'

  # Environments
              examples:
                Getlibraryforbuild200Example:
                  summary: Default getLibraryForBuild 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: libraries
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/environments:
    get:
      operationId: listEnvironmentsForProperty
      summary: List Environments for a Property
      description: Retrieve all environments belonging to a property.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of environments.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EnvironmentListResponse'
              examples:
                Listenvironmentsforproperty200Example:
                  summary: Default listEnvironmentsForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: environments
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createEnvironment
      summary: Create an Environment
      description: Create a new environment under the specified property.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/EnvironmentCreateRequest'
            examples:
              CreateenvironmentRequestExample:
                summary: Default createEnvironment request
                x-microcks-default: true
                value:
                  data:
                    type: environments
                    attributes:
                      name: Example Title
                      stage: development
                      archive: true
                      path: example_value
                    relationships:
                      host:
                        data: {}
      responses:
        '201':
          description: Environment created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EnvironmentSingleResponse'
              examples:
                Createenvironment201Example:
                  summary: Default createEnvironment 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: environments
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /environments/{environmentId}:
    get:
      operationId: getEnvironment
      summary: Retrieve an Environment
      description: Look up a specific environment by its ID.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/environmentId'
      responses:
        '200':
          description: Environment details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EnvironmentSingleResponse'
              examples:
                Getenvironment200Example:
                  summary: Default getEnvironment 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: environments
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateEnvironment
      summary: Update an Environment
      description: Modify an environment's attributes.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/environmentId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/EnvironmentUpdateRequest'
            examples:
              UpdateenvironmentRequestExample:
                summary: Default updateEnvironment request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: environments
                    attributes:
                      name: Example Title
                      archive: true
                      path: example_value
      responses:
        '200':
          description: Environment updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EnvironmentSingleResponse'
              examples:
                Updateenvironment200Example:
                  summary: Default updateEnvironment 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: environments
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteEnvironment
      summary: Delete an Environment
      description: Remove an environment. Returns HTTP 204 on success.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/environmentId'
      responses:
        '204':
          description: Environment deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /environments/{environmentId}/host:
    get:
      operationId: getHostForEnvironment
      summary: Get the Host for an Environment
      description: Retrieve the host configuration for an environment.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/environmentId'
      responses:
        '200':
          description: Host details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/HostSingleResponse'

              examples:
                Gethostforenvironment200Example:
                  summary: Default getHostForEnvironment 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: hosts
                      relationships: {}
                      links:
                        self: https://www.example.com
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /environments/{environmentId}/builds:
    get:
      operationId: listBuildsForEnvironment
      summary: List Builds for an Environment
      description: Retrieve builds associated with an environment.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/environmentId'
      responses:
        '200':
          description: A list of builds.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/BuildListResponse'

  # Hosts
              examples:
                Listbuildsforenvironment200Example:
                  summary: Default listBuildsForEnvironment 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: builds
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/hosts:
    get:
      operationId: listHostsForProperty
      summary: List Hosts for a Property
      description: Retrieve all hosts belonging to a property.
      tags:
      - Hosts
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterName'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of hosts.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/HostListResponse'
              examples:
                Listhostsforproperty200Example:
                  summary: Default listHostsForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: hosts
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createHost
      summary: Create a Host
      description: Create a new host under the specified property.
      tags:
      - Hosts
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/HostCreateRequest'
            examples:
              CreatehostRequestExample:
                summary: Default createHost request
                x-microcks-default: true
                value:
                  data:
                    type: hosts
                    attributes:
                      name: Example Title
                      type_of: akamai
                      server: example_value
                      port: 10
                      path: example_value
                      username: example_value
                      encrypted_private_key: example_value
                      skip_symlinks: true
      responses:
        '201':
          description: Host created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/HostSingleResponse'
              examples:
                Createhost201Example:
                  summary: Default createHost 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: hosts
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /hosts/{hostId}:
    get:
      operationId: getHost
      summary: Retrieve a Host
      description: Look up a specific host by its ID.
      tags:
      - Hosts
      parameters:
      - $ref: '#/components/parameters/hostId'
      responses:
        '200':
          description: Host details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/HostSingleResponse'
              examples:
                Gethost200Example:
                  summary: Default getHost 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: hosts
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateHost
      summary: Update a Host
      description: Modify a host's attributes. Only SFTP hosts can be updated.
      tags:
      - Hosts
      parameters:
      - $ref: '#/components/parameters/hostId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/HostUpdateRequest'
            examples:
              UpdatehostRequestExample:
                summary: Default updateHost request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: hosts
                    attributes:
                      name: Example Title
                      server: example_value
                      port: 10
                      path: example_value
                      username: example_value
                      encrypted_private_key: example_value
                      skip_symlinks: true
      responses:
        '200':
          description: Host updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/HostSingleResponse'
              examples:
                Updatehost200Example:
                  summary: Default updateHost 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: hosts
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteHost
      summary: Delete a Host
      description: Remove a host. Returns HTTP 204 on success.
      tags:
      - Hosts
      parameters:
      - $ref: '#/components/parameters/hostId'
      responses:
        '204':
          description: Host deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

  # Callbacks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/callbacks:
    get:
      operationId: listCallbacksForProperty
      summary: List Callbacks for a Property
      description: Retrieve all callbacks belonging to a property.
      tags:
      - Callbacks
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of callbacks.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CallbackListResponse'
              examples:
                Listcallbacksforproperty200Example:
                  summary: Default listCallbacksForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: callbacks
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCallback
      summary: Create a Callback
      description: Create a new callback under the specified property.
      tags:
      - Callbacks
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CallbackCreateRequest'
            examples:
              CreatecallbackRequestExample:
                summary: Default createCallback request
                x-microcks-default: true
                value:
                  data:
                    type: callbacks
                    attributes:
                      url: https://www.example.com
                      subscriptions:
                      - {}
      responses:
        '201':
          description: Callback created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CallbackSingleResponse'
              examples:
                Createcallback201Example:
                  summary: Default createCallback 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: callbacks
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /callbacks/{callbackId}:
    get:
      operationId: getCallback
      summary: Retrieve a Callback
      description: Look up a specific callback by its ID.
      tags:
      - Callbacks
      parameters:
      - $ref: '#/components/parameters/callbackId'
      responses:
        '200':
          description: Callback details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CallbackSingleResponse'
              examples:
                Getcallback200Example:
                  summary: Default getCallback 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: callbacks
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateCallback
      summary: Update a Callback
      description: Modify a callback's URL or subscriptions.
      tags:
      - Callbacks
      parameters:
      - $ref: '#/components/parameters/callbackId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CallbackUpdateRequest'
            examples:
              UpdatecallbackRequestExample:
                summary: Default updateCallback request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: callbacks
                    attributes:
                      url: https://www.example.com
                      subscriptions:
                      - {}
      responses:
        '200':
          description: Callback updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CallbackSingleResponse'
              examples:
                Updatecallback200Example:
                  summary: Default updateCallback 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: callbacks
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCallback
      summary: Delete a Callback
      description: Remove a callback. Returns HTTP 204 on success.
      tags:
      - Callbacks
      parameters:
      - $ref: '#/components/parameters/callbackId'
      responses:
        '204':
          description: Callback deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

  # Secrets
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /properties/{propertyId}/secrets:
    get:
      operationId: listSecretsForProperty
      summary: List Secrets for a Property
      description: Retrieve all secrets belonging to an event forwarding property.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/propertyId'
      - $ref: '#/components/parameters/filterCreatedAt'
      - $ref: '#/components/parameters/filterUpdatedAt'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: A list of secrets.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SecretListResponse'
              examples:
                Listsecretsforproperty200Example:
                  summary: Default listSecretsForProperty 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: secrets
                      relationships: {}
                      links: {}
                    meta:
                      pagination:
                        current_page: 10
                        next_page: 10
                        prev_page: 10
                        total_pages: 10
                        total_count: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createSecret
      summary: Create a Secret
      description: Create a new secret for an event forwarding property.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/propertyId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/SecretCreateRequest'
            examples:
              CreatesecretRequestExample:
                summary: Default createSecret request
                x-microcks-default: true
                value:
                  data:
                    type: secrets
                    attributes:
                      name: Example Title
                      type_of: token
                      credentials: example_value
                    relationships:
                      environment:
                        data: {}
      responses:
        '201':
          description: Secret created successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SecretSingleResponse'
              examples:
                Createsecret201Example:
                  summary: Default createSecret 201 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: secrets
                      relationships: {}
                      links:
                        self: https://www.example.com
        '422':
          $ref: '#/components/responses/UnprocessableEntity'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /secrets/{secretId}:
    get:
      operationId: getSecret
      summary: Retrieve a Secret
      description: Look up a specific secret by its ID.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/secretId'
      responses:
        '200':
          description: Secret details.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SecretSingleResponse'
              examples:
                Getsecret200Example:
                  summary: Default getSecret 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: secrets
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateSecret
      summary: Update a Secret
      description: Test, retry, or reauthorize a secret.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/secretId'
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/SecretUpdateRequest'
            examples:
              UpdatesecretRequestExample:
                summary: Default updateSecret request
                x-microcks-default: true
                value:
                  data:
                    id: abc123
                    type: secrets
                    meta:
                      action: test
      responses:
        '200':
          description: Secret updated successfully.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SecretSingleResponse'
              examples:
                Updatesecret200Example:
                  summary: Default updateSecret 200 response
                  x-microcks-default: true
                  value:
                    data:
                      id: abc123
                      type: secrets
                      relationships: {}
                      links:
                        self: https://www.example.com
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteSecret
      summary: Delete a Secret
      description: Remove a secret. Returns HTTP 204 on success.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/secretId'
      responses:
        '204':
          description: Secret deleted successfully.
        '404':
          $ref: '#/components/responses/NotFound'

  # Search
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /search:
    post:
      operationId: search
      summary: Search Resources
      description: >-
        Search across multiple resource types including properties, rules, data
        elements, extensions, libraries, builds, environments, hosts,
        callbacks, rule components, extension packages, and audit events.
      tags:
      - Search
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
            examples:
              SearchRequestExample:
                summary: Default search request
                x-microcks-default: true
                value:
                  data:
                    from: 10
                    size: 10
                    query:
                      attributes.name:
                        value: example_value
                      attributes.created_at:
                        range: {}
                    sort:
                    - attributes.created_at: asc
                      attributes.name: asc
                    resource_types:
                    - audit_events
      responses:
        '200':
          description: Search results.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SearchResponse'

              examples:
                Search200Example:
                  summary: Default search 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: abc123
                      type: example_value
                      attributes: example_value
                      relationships: example_value
                      links: example_value
                    meta:
                      total_hits: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        OAuth 2.0 Server-to-Server access token obtained from Adobe Developer
        Console. Tokens expire every 24 hours.
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Client ID credential from Adobe Developer Console.
    orgId:
      type: apiKey
      in: header
      name: x-gw-ims-org-id
      description: Adobe Organization ID.

  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a company.
    propertyId:
      name: propertyId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a property.
    ruleId:
      name: ruleId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a rule.
    ruleComponentId:
      name: ruleComponentId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a rule component.
    dataElementId:
      name: dataElementId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a data element.
    extensionId:
      name: extensionId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for an extension.
    extensionPackageId:
      name: extensionPackageId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for an extension package.
    libraryId:
      name: libraryId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a library.
    buildId:
      name: buildId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a build.
    environmentId:
      name: environmentId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for an environment.
    hostId:
      name: hostId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a host.
    callbackId:
      name: callbackId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a callback.
    secretId:
      name: secretId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier for a secret.
    resourceType:
      name: resourceType
      in: path
      required: true
      schema:
        type: string
        enum:
        - data_elements
        - extensions
        - rules
      description: The type of resource to manage in the library relationship.
    filterCreatedAt:
      name: filter[created_at]
      in: query
      schema:
        type: string
      description: Filter by creation date.
    filterUpdatedAt:
      name: filter[updated_at]
      in: query
      schema:
        type: string
      description: Filter by last updated date.
    filterName:
      name: filter[name]
      in: query
      schema:
        type: string
      description: Filter by name.
    filterEnabled:
      name: filter[enabled]
      in: query
      schema:
        type: boolean
      description: Filter by enabled status.
    filterPublished:
      name: filter[published]
      in: query
      schema:
        type: boolean
      description: Filter by published status.
    filterDirty:
      name: filter[dirty]
      in: query
      schema:
        type: boolean
      description: Filter by dirty (unpublished changes) status.
    filterPlatform:
      name: filter[platform]
      in: query
      schema:
        type: string
        enum:
        - web
        - mobile
        - edge
      description: Filter by platform type.
    pageNumber:
      name: page[number]
      in: query
      schema:
        type: integer
        minimum: 1
      description: Page number for pagination.
    pageSize:
      name: page[size]
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
      description: Number of results per page.

  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    UnprocessableEntity:
      description: The request body contains validation errors.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'

  schemas:
    # Error
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              status:
                type: string
              code:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string

    # Pagination
          example: []
    PaginationMeta:
      type: object
      properties:
        pagination:
          type: object
          properties:
            current_page:
              type: integer
            next_page:
              type: integer
              nullable: true
            prev_page:
              type: integer
              nullable: true
            total_pages:
              type: integer
            total_count:
              type: integer

    # JSON:API Relationship
          example: example_value
    Relationship:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
          example: example_value
        links:
          type: object
          properties:
            related:
              type: string
              format: uri

          example: example_value
    RelationshipRequest:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              type:
                type: string
            required:
            - id
            - type

          example: []
    RelationshipSingleRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
          required:
          - id
          - type

    # Company
          example: example_value
    CompanyAttributes:
      type: object
      properties:
        name:
          type: string
          description: The name of the company.
          example: Example Title
        org_id:
          type: string
          description: The Adobe organization ID.
          example: '500123'
        token:
          type: string
          description: A unique token for the company.
          example: example_value
        created_at:
          type: string
          format: date-time
          description: When the company was created.
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          description: When the company was last updated.
          example: '2026-01-15T10:30:00Z'
        cjm_enabled:
          type: boolean
          description: Whether Customer Journey Management is enabled.
          example: true
        edge_enabled:
          type: boolean
          description: Whether Edge capabilities are enabled.

          example: true
    CompanyResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [companies]
          example: companies
        attributes:
          $ref: '#/components/schemas/CompanyAttributes'
        relationships:
          type: object
          properties:
            properties:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    CompanyListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompanyResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    CompanySingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CompanyResource'

    # Property
    PropertyAttributes:
      type: object
      properties:
        name:
          type: string
          description: The name of the property.
          example: Example Title
        platform:
          type: string
          enum:
          - web
          - mobile
          - edge
          description: The platform type (web, mobile, or edge).
          example: web
        domains:
          type: array
          items:
            type: string
          description: A list of domains associated with the property.
          example: []
        enabled:
          type: boolean
          description: Whether the property is enabled.
          example: true
        development:
          type: boolean
          description: Whether the property is in development mode.
          example: true
        privacy:
          type: string
          enum:
          - optin
          - optout
          description: The default privacy setting.
          example: optin
        ssl_enabled:
          type: boolean
          description: Whether SSL is enabled.
          example: true
        rule_component_sequencing_enabled:
          type: boolean
          description: Whether rule component sequencing is enabled.
          example: true
        undefined_vars_return_empty:
          type: boolean
          description: Whether undefined data element variables return empty strings.
          example: true
        token:
          type: string
          description: A unique token for the property.
          example: example_value
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    PropertyResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [properties]
          example: properties
        attributes:
          $ref: '#/components/schemas/PropertyAttributes'
        relationships:
          type: object
          properties:
            company:
              $ref: '#/components/schemas/Relationship'
            callbacks:
              $ref: '#/components/schemas/Relationship'
            data_elements:
              $ref: '#/components/schemas/Relationship'
            environments:
              $ref: '#/components/schemas/Relationship'
            extensions:
              $ref: '#/components/schemas/Relationship'
            hosts:
              $ref: '#/components/schemas/Relationship'
            libraries:
              $ref: '#/components/schemas/Relationship'
            rules:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    PropertyListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PropertyResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    PropertySingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PropertyResource'

    PropertyCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              enum: [properties]
            attributes:
              type: object
              required:
              - name
              - platform
              properties:
                name:
                  type: string
                platform:
                  type: string
                  enum:
                  - web
                  - mobile
                  - edge
                domains:
                  type: array
                  items:
                    type: string
                privacy:
                  type: string
                  enum:
                  - optin
                  - optout
                ssl_enabled:
                  type: boolean
                development:
                  type: boolean
                rule_component_sequencing_enabled:
                  type: boolean
                undefined_vars_return_empty:
                  type: boolean

          example: example_value
    PropertyUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
            type:
              type: string
              enum: [properties]
            attributes:
              type: object
              properties:
                name:
                  type: string
                domains:
                  type: array
                  items:
                    type: string
                privacy:
                  type: string
                  enum:
                  - optin
                  - optout
                ssl_enabled:
                  type: boolean
                development:
                  type: boolean
                rule_component_sequencing_enabled:
                  type: boolean
                undefined_vars_return_empty:
                  type: boolean

    # Rule
          example: example_value
    RuleAttributes:
      type: object
      properties:
        name:
          type: string
          description: The human-readable name of the rule.
          example: Example Title
        enabled:
          type: boolean
          description: Whether the rule is enabled.
          example: true
        published:
          type: boolean
          description: Whether the rule has been published.
          example: true
        dirty:
          type: boolean
          description: Whether the rule has unpublished changes.
          example: true
        revision_number:
          type: integer
          description: The current revision number.
          example: 10
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    RuleResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [rules]
          example: rules
        attributes:
          $ref: '#/components/schemas/RuleAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
            rule_components:
              $ref: '#/components/schemas/Relationship'
            libraries:
              $ref: '#/components/schemas/Relationship'
            revisions:
              $ref: '#/components/schemas/Relationship'
            origin:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    RuleListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RuleResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    RuleSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RuleResource'

    RuleCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              enum: [rules]
            attributes:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                enabled:
                  type: boolean

          example: example_value
    RuleUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
            type:
              type: string
              enum: [rules]
            attributes:
              type: object
              properties:
                name:
                  type: string
                enabled:
                  type: boolean

    # Rule Component
          example: example_value
    RuleComponentAttributes:
      type: object
      properties:
        name:
          type: string
          description: The human-readable name of the rule component.
          example: Example Title
        delegate_descriptor_id:
          type: string
          description: The descriptor ID identifying the component type from an extension package.
          example: '500123'
        order:
          type: integer
          description: The execution order within its type group.
          example: 10
        rule_order:
          type: number
          description: The order relative to other components in the rule.
          example: 42.5
        settings:
          type: string
          description: A JSON-encoded string of settings for the component.
          example: example_value
        timeout:
          type: integer
          description: Timeout in milliseconds for the component.
          example: 10
        delay_next:
          type: boolean
          description: Whether to delay the next action.
          example: true
        negate:
          type: boolean
          description: Whether to negate the condition result.
          example: true
        enabled:
          type: boolean
          description: Whether the rule component is enabled.
          example: true
        published:
          type: boolean
          example: true
        dirty:
          type: boolean
          example: true
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    RuleComponentResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [rule_components]
          example: rule_components
        attributes:
          $ref: '#/components/schemas/RuleComponentAttributes'
        relationships:
          type: object
          properties:
            rules:
              $ref: '#/components/schemas/Relationship'
            extension:
              $ref: '#/components/schemas/Relationship'
            origin:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    RuleComponentListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RuleComponentResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    RuleComponentSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RuleComponentResource'

    RuleComponentCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          - relationships
          properties:
            type:
              type: string
              enum: [rule_components]
            attributes:
              type: object
              required:
              - name
              - delegate_descriptor_id
              properties:
                name:
                  type: string
                delegate_descriptor_id:
                  type: string
                order:
                  type: integer
                settings:
                  type: string
                timeout:
                  type: integer
                delay_next:
                  type: boolean
                negate:
                  type: boolean
            relationships:
              type: object
              required:
              - rules
              - extension
              properties:
                rules:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          type:
                            type: string
                            enum: [rules]
                extension:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum: [extensions]
          example: example_value

    RuleComponentUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
            type:
              type: string
              enum: [rule_components]
            attributes:
              type: object
              properties:
                name:
                  type: string
                order:
                  type: integer
                settings:
                  type: string
                timeout:
                  type: integer
                delay_next:
                  type: boolean
                negate:
                  type: boolean

    # Data Element
          example: example_value
    DataElementAttributes:
      type: object
      properties:
        name:
          type: string
          description: The human-readable name of the data element.
          example: Example Title
        delegate_descriptor_id:
          type: string
          description: The descriptor ID identifying the data element type from an extension.
          example: '500123'
        default_value:
          type: string
          description: The default value when the data element returns no value.
          example: example_value
        settings:
          type: string
          description: A JSON-encoded string of settings for the data element.
          example: example_value
        storage_duration:
          type: string
          enum:
          - pageview
          - session
          - visitor
          description: How long the data element value persists.
          example: pageview
        force_lower_case:
          type: boolean
          description: Whether to force the value to lowercase.
          example: true
        clean_text:
          type: boolean
          description: Whether to clean whitespace from the value.
          example: true
        enabled:
          type: boolean
          description: Whether the data element is enabled.
          example: true
        published:
          type: boolean
          example: true
        dirty:
          type: boolean
          example: true
        revision_number:
          type: integer
          example: 10
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    DataElementResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [data_elements]
          example: data_elements
        attributes:
          $ref: '#/components/schemas/DataElementAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
            extension:
              $ref: '#/components/schemas/Relationship'
            libraries:
              $ref: '#/components/schemas/Relationship'
            revisions:
              $ref: '#/components/schemas/Relationship'
            origin:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    DataElementListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DataElementResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    DataElementSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DataElementResource'

    DataElementCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          - relationships
          properties:
            type:
              type: string
              enum: [data_elements]
            attributes:
              type: object
              required:
              - name
              - delegate_descriptor_id
              properties:
                name:
                  type: string
                delegate_descriptor_id:
                  type: string
                default_value:
                  type: string
                settings:
                  type: string
                storage_duration:
                  type: string
                  enum:
                  - pageview
                  - session
                  - visitor
                force_lower_case:
                  type: boolean
                clean_text:
                  type: boolean
                enabled:
                  type: boolean
            relationships:
              type: object
              required:
              - extension
              properties:
                extension:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum: [extensions]
          example: example_value

    DataElementUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
            type:
              type: string
              enum: [data_elements]
            attributes:
              type: object
              properties:
                name:
                  type: string
                default_value:
                  type: string
                settings:
                  type: string
                storage_duration:
                  type: string
                  enum:
                  - pageview
                  - session
                  - visitor
                force_lower_case:
                  type: boolean
                clean_text:
                  type: boolean
                enabled:
                  type: boolean

    # Extension
          example: example_value
    ExtensionAttributes:
      type: object
      properties:
        name:
          type: string
          description: The unique name of the extension.
          example: Example Title
        display_name:
          type: string
          description: The human-readable display name.
          example: example_value
        version:
          type: string
          description: The version of the installed extension.
          example: example_value
        delegate_descriptor_id:
          type: string
          description: The descriptor ID for the extension configuration.
          example: '500123'
        settings:
          type: string
          description: A JSON-encoded string of settings.
          example: example_value
        enabled:
          type: boolean
          description: Whether the extension is enabled.
          example: true
        published:
          type: boolean
          example: true
        dirty:
          type: boolean
          example: true
        revision_number:
          type: integer
          example: 10
        deleted_at:
          type: string
          format: date-time
          nullable: true
          description: When the extension was deleted, if applicable.
          example: '2026-01-15T10:30:00Z'
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    ExtensionResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [extensions]
          example: extensions
        attributes:
          $ref: '#/components/schemas/ExtensionAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
            extension_package:
              $ref: '#/components/schemas/Relationship'
            libraries:
              $ref: '#/components/schemas/Relationship'
            revisions:
              $ref: '#/components/schemas/Relationship'
            origin:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    ExtensionListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    ExtensionSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExtensionResource'

    ExtensionCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - relationships
          properties:
            type:
              type: string
              enum: [extensions]
            attributes:
              type: object
              properties:
                delegate_descriptor_id:
                  type: string
                settings:
                  type: string
                enabled:
                  type: boolean
            relationships:
              type: object
              required:
              - extension_package
              properties:
                extension_package:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum: [extension_packages]
          example: example_value

    ExtensionUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          properties:
            id:
              type: string
            type:
              type: string
              enum: [extensions]
            attributes:
              type: object
              properties:
                delegate_descriptor_id:
                  type: string
                settings:
                  type: string
                enabled:
                  type: boolean
            meta:
              type: object
              properties:
                action:
                  type: string
                  enum:
                  - revise
                  description: Set to revise to create a new revision.

    # Extension Package
          example: example_value
    ExtensionPackageAttributes:
      type: object
      properties:
        name:
          type: string
          description: The unique name of the extension package.
          example: Example Title
        display_name:
          type: string
          description: The human-readable display name.
          example: example_value
        description:
          type: string
          description: A description of the extension package.
          example: A sample description.
        version:
          type: string
          description: The current version.
          example: example_value
        platform:
          type: string
          enum:
          - web
          - mobile
          - edge
          description: The platform the extension package supports.
          example: web
        author:
          type: object
          properties:
            name:
              type: string
            url:
              type: string
              format: uri
            email:
              type: string
              format: email
          example: example_value
        availability:
          type: string
          enum:
          - development
          - private
          - public
          example: development
        discontinued:
          type: boolean
          example: true
        status:
          type: string
          example: example_value
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    ExtensionPackageResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [extension_packages]
          example: extension_packages
        attributes:
          $ref: '#/components/schemas/ExtensionPackageAttributes'
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    ExtensionPackageListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionPackageResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    ExtensionPackageSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExtensionPackageResource'

    # Library
    LibraryAttributes:
      type: object
      properties:
        name:
          type: string
          description: The name of the library.
          example: Example Title
        state:
          type: string
          enum:
          - development
          - submitted
          - approved
          - rejected
          - published
          description: The current publishing state.
          example: development
        build_required:
          type: boolean
          description: Whether the library needs a new build.
          example: true
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    LibraryResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [libraries]
          example: libraries
        attributes:
          $ref: '#/components/schemas/LibraryAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
            environment:
              $ref: '#/components/schemas/Relationship'
            data_elements:
              $ref: '#/components/schemas/Relationship'
            extensions:
              $ref: '#/components/schemas/Relationship'
            rules:
              $ref: '#/components/schemas/Relationship'
            builds:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    LibraryListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LibraryResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    LibrarySingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LibraryResource'

    LibraryCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              enum: [libraries]
            attributes:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
            relationships:
              type: object
              properties:
                environment:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum: [environments]
                data_elements:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          type:
                            type: string
                            enum: [data_elements]
                extensions:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          type:
                            type: string
                            enum: [extensions]
                rules:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          type:
                            type: string
                            enum: [rules]
          example: example_value

    LibraryUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          properties:
            id:
              type: string
            type:
              type: string
              enum: [libraries]
            attributes:
              type: object
              properties:
                name:
                  type: string
            meta:
              type: object
              properties:
                action:
                  type: string
                  enum:
                  - submit
                  - approve
                  - reject
                  - develop
                  description: The publishing state transition action.

    # Build
          example: example_value
    BuildAttributes:
      type: object
      properties:
        status:
          type: string
          enum:
          - pending
          - succeeded
          - failed
          description: The current status of the build.
          example: pending
        token:
          type: string
          description: A unique token for the build.
          example: example_value
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    BuildResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [builds]
          example: builds
        attributes:
          $ref: '#/components/schemas/BuildAttributes'
        relationships:
          type: object
          properties:
            library:
              $ref: '#/components/schemas/Relationship'
            environment:
              $ref: '#/components/schemas/Relationship'
            data_elements:
              $ref: '#/components/schemas/Relationship'
            extensions:
              $ref: '#/components/schemas/Relationship'
            rules:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    BuildListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BuildResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    BuildSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BuildResource'

    # Environment
    EnvironmentAttributes:
      type: object
      properties:
        name:
          type: string
          description: The name of the environment.
          example: Example Title
        stage:
          type: string
          enum:
          - development
          - staging
          - production
          description: The environment stage.
          example: development
        archive:
          type: boolean
          description: Whether the build is delivered as a ZIP archive.
          example: true
        path:
          type: string
          description: The URL path appended to the host domain for deployment.
          example: example_value
        library_name:
          type: string
          description: The custom library filename.
          example: example_value
        library_path:
          type: string
          description: The custom library path.
          example: example_value
        token:
          type: string
          description: A unique token for the environment.
          example: example_value
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    EnvironmentResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [environments]
          example: environments
        attributes:
          $ref: '#/components/schemas/EnvironmentAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
            host:
              $ref: '#/components/schemas/Relationship'
            library:
              $ref: '#/components/schemas/Relationship'
            builds:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    EnvironmentListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    EnvironmentSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EnvironmentResource'

    EnvironmentCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          - relationships
          properties:
            type:
              type: string
              enum: [environments]
            attributes:
              type: object
              required:
              - name
              - stage
              properties:
                name:
                  type: string
                stage:
                  type: string
                  enum:
                  - development
                  - staging
                  - production
                archive:
                  type: boolean
                path:
                  type: string
            relationships:
              type: object
              required:
              - host
              properties:
                host:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum: [hosts]
          example: example_value

    EnvironmentUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
            type:
              type: string
              enum: [environments]
            attributes:
              type: object
              properties:
                name:
                  type: string
                archive:
                  type: boolean
                path:
                  type: string

    # Host
          example: example_value
    HostAttributes:
      type: object
      properties:
        name:
          type: string
          description: The human-readable name of the host.
          example: Example Title
        type_of:
          type: string
          enum:
          - akamai
          - sftp
          description: The hosting type.
          example: akamai
        server:
          type: string
          description: The host URL for SFTP hosts.
          example: example_value
        port:
          type: integer
          description: The server port for SFTP hosts.
          example: 10
        path:
          type: string
          description: The URL path suffix for SFTP hosts.
          example: example_value
        username:
          type: string
          description: The authentication username for SFTP hosts.
          example: example_value
        encrypted_private_key:
          type: string
          description: The encrypted private key for SFTP hosts.
          example: example_value
        skip_symlinks:
          type: boolean
          description: Whether to use file copying instead of symbolic links for SFTP hosts.
          example: true
        status:
          type: string
          description: The current status of the host.
          example: example_value
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    HostResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [hosts]
          example: hosts
        attributes:
          $ref: '#/components/schemas/HostAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    HostListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/HostResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    HostSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/HostResource'

    HostCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              enum: [hosts]
            attributes:
              type: object
              required:
              - name
              - type_of
              properties:
                name:
                  type: string
                type_of:
                  type: string
                  enum:
                  - akamai
                  - sftp
                server:
                  type: string
                port:
                  type: integer
                path:
                  type: string
                username:
                  type: string
                encrypted_private_key:
                  type: string
                skip_symlinks:
                  type: boolean

          example: example_value
    HostUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
            type:
              type: string
              enum: [hosts]
            attributes:
              type: object
              properties:
                name:
                  type: string
                server:
                  type: string
                port:
                  type: integer
                path:
                  type: string
                username:
                  type: string
                encrypted_private_key:
                  type: string
                skip_symlinks:
                  type: boolean

    # Callback
          example: example_value
    CallbackAttributes:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: The HTTPS URL to send callback messages to.
          example: https://www.example.com
        subscriptions:
          type: array
          items:
            type: string
          description: The audit event types that trigger the callback.
          example: []
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    CallbackResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [callbacks]
          example: callbacks
        attributes:
          $ref: '#/components/schemas/CallbackAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    CallbackListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CallbackResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    CallbackSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CallbackResource'

    CallbackCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              enum: [callbacks]
            attributes:
              type: object
              required:
              - url
              - subscriptions
              properties:
                url:
                  type: string
                  format: uri
                subscriptions:
                  type: array
                  items:
                    type: string

          example: example_value
    CallbackUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          - attributes
          properties:
            id:
              type: string
            type:
              type: string
              enum: [callbacks]
            attributes:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                subscriptions:
                  type: array
                  items:
                    type: string

    # Secret
          example: example_value
    SecretAttributes:
      type: object
      properties:
        name:
          type: string
          description: The name of the secret.
          example: Example Title
        type_of:
          type: string
          enum:
          - token
          - simple-http
          - oauth2
          - oauth2-google
          description: The type of secret.
          example: token
        status:
          type: string
          enum:
          - pending
          - succeeded
          - failed
          description: The exchange status of the secret.
          example: pending
        credentials:
          type: object
          description: The credential payload, varies by secret type.
          example: example_value
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time

          example: '2026-01-15T10:30:00Z'
    SecretResource:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum: [secrets]
          example: secrets
        attributes:
          $ref: '#/components/schemas/SecretAttributes'
        relationships:
          type: object
          properties:
            property:
              $ref: '#/components/schemas/Relationship'
            environment:
              $ref: '#/components/schemas/Relationship'
          example: example_value
        links:
          type: object
          properties:
            self:
              type: string
              format: uri

          example: example_value
    SecretListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SecretResource'
          example: []
        meta:
          $ref: '#/components/schemas/PaginationMeta'

    SecretSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SecretResource'

    SecretCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          - relationships
          properties:
            type:
              type: string
              enum: [secrets]
            attributes:
              type: object
              required:
              - name
              - type_of
              properties:
                name:
                  type: string
                type_of:
                  type: string
                  enum:
                  - token
                  - simple-http
                  - oauth2
                  - oauth2-google
                credentials:
                  type: object
            relationships:
              type: object
              required:
              - environment
              properties:
                environment:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum: [environments]
          example: example_value

    SecretUpdateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - id
          - type
          properties:
            id:
              type: string
            type:
              type: string
              enum: [secrets]
            meta:
              type: object
              properties:
                action:
                  type: string
                  enum:
                  - test
                  - retry
                  - reauthorize

    # Search
          example: example_value
    SearchRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            from:
              type: integer
              description: Number of results to offset by.
            size:
              type: integer
              description: Maximum number of results to return (max 100).
              maximum: 100
            query:
              type: object
              description: Search query with field paths and matching conditions.
              properties:
                attributes.name:
                  type: object
                  properties:
                    value:
                      type: string
                attributes.created_at:
                  type: object
                  properties:
                    range:
                      type: object
                      properties:
                        gt:
                          type: string
                        gte:
                          type: string
                        lt:
                          type: string
                        lte:
                          type: string
            sort:
              type: array
              items:
                type: object
                properties:
                  attributes.created_at:
                    type: string
                    enum:
                    - asc
                    - desc
                  attributes.name:
                    type: string
                    enum:
                    - asc
                    - desc
            resource_types:
              type: array
              items:
                type: string
                enum:
                - audit_events
                - builds
                - callbacks
                - data_elements
                - environments
                - extension_packages
                - extensions
                - hosts
                - libraries
                - properties
                - rule_components
                - rules

          example: example_value
    SearchResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              type:
                type: string
              attributes:
                type: object
              relationships:
                type: object
              links:
                type: object
          example: []
        meta:
          type: object
          properties:
            total_hits:
              type: integer

          example: example_value
tags:
- name: Companies
  description: Manage organization companies.
- name: Properties
  description: Manage tag properties which serve as containers for rules, data elements, extensions, and libraries.
- name: Rules
  description: Manage rules that control tag behavior through events, conditions, and actions.
- name: Rule Components
  description: Manage the individual event, condition, and action components within rules.
- name: Data Elements
  description: Manage data elements that serve as variables pointing to application data.
- name: Extensions
  description: Manage installed extensions within properties.
- name: Extension Packages
  description: Manage extension packages that define capabilities available to tags users.
- name: Libraries
  description: Manage libraries which are collections of resources compiled into builds.
- name: Builds
  description: Manage compiled tag library builds for deployment.
- name: Environments
  description: Manage deployment environments for tag library builds.
- name: Hosts
  description: Manage hosting destinations for tag library delivery.
- name: Callbacks
  description: Manage webhook callbacks triggered by audit events.
- name: Secrets
  description: Manage secrets for event forwarding properties to authenticate with external systems.
- name: Search
  description: Search across multiple resource types.