Mend Administration - Labels API

openapi: 3.2.0
info:
  title: Mend Administration - Labels API
  version: '1.0'
  description: 'Operations tagged Administration - Labels across 2 of this provider''s published API definitions: mend-openapi.json, mend-platform-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-saas.mend.io
  description: Generated server url
- url: https://baseUrl
  description: Generated server url
security:
- bearer-key: []
tags:
- name: Administration - Labels
paths:
  /api/v3.0/orgs/{orgUuid}/labels/{labelUuid}:
    put:
      tags:
      - Administration - Labels
      summary: Rename Label
      description: Renames an existing label
      operationId: renameLabel
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: labelUuid
        in: path
        description: Label UUID (Administration > Labels)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainLabelRequestDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
    delete:
      tags:
      - Administration - Labels
      summary: Remove Label Definition
      description: Removes a label definition
      operationId: deleteLabel
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: labelUuid
        in: path
        description: Label UUID (Administration > Labels)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
  /api/v3.0/orgs/{orgUuid}/labels:
    get:
      tags:
      - Administration - Labels
      summary: Get All Organization Labels
      description: Returns a list of all labels in an organization (paginated)
      operationId: getLabels
      parameters:
      - name: cursor
        in: query
        description: Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved
        allowEmptyValue: true
        schema:
          type: string
          default: '0'
      - name: limit
        in: query
        description: Specifies the maximum number of items to be return in the response.
        allowEmptyValue: true
        schema:
          maximum: 10000
          type: string
          default: '50'
      - name: search
        in: query
        description: "Filter your search to return items whose property has a specific value.\nUse the syntax: **[property][operator][value]**\n+ **Property**: the name of the property of the item\n+ **Operator**:\n    + **equals (==)** - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator).\nExample: entity==abc* — will return true for entities like \"abcd\" and \"abc_123\".\n    + **in (=in=)** - Returns true if the value matches any item in the comma-separated list.\nExample: entity=in=value1,value2 — will return true for entities which are either value1, or value2.\n    + **between (=btw=)** - Returns true if the value falls within the specified range.\nExample: entity=btw=10,20 — will return true for values between 10 and 20.\n\n+ **Value**: the value of the property.\nLogical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ labels: equals, in\n+ createdBy: equals\n+ createdAt: between"
        allowEmptyValue: true
        schema:
          type: string
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponsePageableV3ListOrganizationLabelDTOV3'
    post:
      tags:
      - Administration - Labels
      summary: Add Label Definition
      description: Adds a new label definition
      operationId: createLabel
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationLabelRequestDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
components:
  schemas:
    DomainLabelRequestDTO:
      required:
      - namespace
      - value
      type: object
      properties:
        namespace:
          title: Label Namespace
          type: string
          example: Label Namespace A
        value:
          title: Label Value
          type: string
          example: Label Value A
    OrganizationLabelDTOV3:
      type: object
      properties:
        uuid:
          type: string
        namespace:
          type: string
        value:
          type: string
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        system:
          type: boolean
        applications:
          type: integer
          format: int64
        projects:
          type: integer
          format: int64
        id:
          type: integer
          format: int64
    DWRResponsePageableV3ListOrganizationLabelDTOV3:
      type: object
      properties:
        additionalData:
          title: Provides insights into endpoint-supported pagination information.
          type: object
          description: '+ **totalItems**: The total count of data points returned in an API response.

            '
          example:
            totalItems: '422'
            next: http://someUrl?cursor=3
            cursor: 3
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationLabelDTOV3'
    DWRResponseBase:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
    OrganizationLabelRequestDTO:
      required:
      - namespace
      - value
      type: object
      properties:
        namespace:
          title: Label Namespace
          type: string
          example: Label Namespace A
        value:
          title: Label Value
          type: string
          example: Label Value A
    MessageDTO:
      type: object
      properties:
        message:
          title: message
          type: string
          example: Success!
    DWRResponseV3MessageDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/MessageDTO'
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- mend-openapi.json
- mend-platform-openapi-original.json