Transifex Resource String Comments API

openapi: 3.0.1
info:
  contact:
    email: support@transifex.com
    name: Transifex Support
  description: "<br/>\n<br/>\n\n# Introduction\n\nThis API is based on **{json:api}**.\n\n{json:api} is a specification that follows shared conventions and standards. This specification enables API discoverability and partial\nself-descriptiveness through conventions. The Json Api specification exposes resources and their relationships representations with\nunique uris and all CRUD operations are performed on those endpoints. With it's simplified approach it assists the API uniformity.\n\nRead more: https://jsonapi.org/\n\nAdditionally, this API is defined using OpenAPI (ex Swagger). This means that you can easily:\n* Generate clients in your preferred: https://swagger.io/tools/swagger-codegen/\n* Download the specification file (see above) and use it in clients like Postman etc\n\n<br />\n<br />\n\n# Pagination\n\nAll list endpoints include pagination to guarantee performant responses. Those endpoints will return `next` and `previous` links in the\nresponse payload (`links` section). The client does not have to construct any pagination specific URLs or headers, just follow those\nlinks.\n\nPage size is fixed to 150 items per page.\n\n<br />\n<br />\n\n# Content Negotiation\n\nThe basic media type for the API is `application/vnd.api+json`. If you want to execute a request that includes data (`POST`, `PATCH`, `DELETE`)\nyou should include this media type in the `Content-Type` header. The only case where a different `Content-Type` header will be accepted is for\nendpoints that can accept file like objects where the media type used should be `multipart/form-data`.\n\nThe base media type this API responds is `application/vnd.api+json`. To retrieve the data in this media type you should include it in the `Accept`\nheader. The only case where the server will return another media type is for endpoint that return file like objects.\nIn this case the media type used should be `*/*` and the server will prioritize the negotiation to the media type dictated from the file.\nNote that `application/vnd.api+json` will be also available for accept header in these cases and will return a JSON serialized representation of the file.\n\nRead more here: https://jsonapi.org/format/#content-negotiation\n\n# File Uploads\n\nThere are three different methods for uploading file content to Transifex:\n* Using Content-Type `application/vnd.api+json` the content must\n    be JSON serializable.\n    - For content that is directly JSON serializable you can dump the content\n    of the file directly and set the `content_encoding` attribute  to `text`.\n    - For any content, even if it's not JSON serializable (eg .xlsx, .idml or .docx file extensions),\n    you can encode the file using the `base64` encoding and set the `content_encoding` attribute to `base64`.\n* Using Content-Type `multipart/form-data` the content can be any raw file, and can\n    be send without further processing.\n\n# Asynchronous Processing\n\nAsynchronous operations are triggered via a POST request. The response status in such cases is 202 Accepted, with a link in the Content-Location header.\nTo check the status of the operation, a client can send a request to the location given earlier.\nAn optional `callback_url` can be provided when the asynchronous operation is triggered. If such url is provided, upon completion\na HTTP POST request is executed containing all information required to identify the specific operation:\n\nExample request:\n```\nPOST callback_url HTTP/1.1\nContent-Type: application/json\n\n{\n  \"data\": {\n    \"type\": resource_strings_async_downloads\",\n    \"id\": \"xxxxxxxxx\",\n    \"attributes\": {\n      \"location\": \"https://rest.api.transifex.com/resource_strings_async_downloads/xxxxxxxxx\",\n      \"status\": \"succeeded\"\n    }\n  }\n}\n```\n\n# Restrictions\n\nThe following Plan based restrictions apply:\n* [Activity Reports](#tag/Activity-Reports) are available to Premium and up\n* [XLIFF export](#tag/Resource-Translations/paths/~1resource_translations_async_downloads/post) is available to Premium and up.\n* [Screenshots](#tag/Context-Screenshots) are available to Premium and up\n\n# Rate Limit\n\nTo maintain optimal performance and availability of the API, we limit the request rate to 500\nrequests/min or 30,000 requests / 5 minutes / IP. Polling endpoints like\n`resource_translations_async_downloads/{resource_translations_async_download_id}` and\n`resource_strings_async_downloads/{resource_strings_async_download_id}` have a rate limit of 1,200 requests/min.\nOnce past the respective limit, requests will be throttled and you will get a 429 Throttled response.\n\n\nExample response:\n```\n{\n  \"errors\": [\n    {\n      \"code\": \"Throttled\",\n      \"detail\": \"Request was throttled. Expected available in 60 seconds.\",\n      \"status\": \"429\",\n      \"title\": \"Throttled\"\n    }\n  ]\n}\n```\n\n# Authentication\n<!-- ReDoc-Inject: <security-definitions> -->\n"
  title: Transifex Activity Reports Resource String Comments API
  version: '3.0'
  x-logo:
    altText: Transifex logo
    backgroundColor: '#FFFFFF'
    url: transifex-blue-logo.svg
servers:
- url: https://rest.api.transifex.com
security:
- bearerAuth: []
tags:
- description: "Represents comments on resource strings. These are the same comments exposed in the Transifex Editor under the \"Comments\" tab.\n\nA comment can also be flagged as an **issue**. In this case, some extra functionality is available\n  * You can change an issue's status\n  * You can change it's category\n  * You can assign a priority\n\nCategories can be configured per organization. To configure the available categories for your organization, contact\n<a href=\"https://www.transifex.com/contact/\">Transifex Support</a>.\n\nFor further details & examples, take a look below.\n"
  name: Resource String Comments
paths:
  /resource_string_comments:
    get:
      description: Get a list of all resource string comments for an organization. You can further narrow down the list using the available filters.
      parameters:
      - description: Filter results by an organization
        in: query
        name: filter[organization]
        required: true
        schema:
          description: Organization identifier.
          example: o:org_123
          pattern: ^o:[a-zA-Z0-9._-]+$
          type: string
      - description: Filter results by a project
        in: query
        name: filter[project]
        required: false
        schema:
          description: Project identifier.
          example: o:organization_slug:p:project_slug
          pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$
          type: string
      - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own.

          '
        in: query
        name: page[cursor]
        schema:
          type: string
      - in: query
        name: filter[category]
        required: false
        schema:
          example: frontpage
          type: string
      - in: query
        name: filter[author]
        required: false
        schema:
          example: u:username
          pattern: u:[^:]+
          type: string
      - in: query
        name: filter[datetime_created][gte]
        required: false
        schema:
          example: XXXX-XX-XXTXX:XX:XXZ
          format: date-time
          type: string
      - in: query
        name: filter[datetime_created][lt]
        required: false
        schema:
          example: XXXX-XX-XXTXX:XX:XXZ
          format: date-time
          type: string
      - in: query
        name: filter[priority]
        required: false
        schema:
          enum:
          - low
          - normal
          - high
          - critical
          - blocker
          example: critical
          type: string
      - in: query
        name: filter[resource]
        required: false
        schema:
          description: Resource identifier.
          example: o:organization_slug:p:project_slug:r:resource_slug
          pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
          type: string
      - in: query
        name: filter[resource_string]
        required: false
        schema:
          description: Resource String identifier.
          example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
          pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
          type: string
      - in: query
        name: filter[status]
        required: false
        schema:
          enum:
          - open
          - resolved
          example: open
          type: string
      - in: query
        name: filter[type]
        required: false
        schema:
          enum:
          - comment
          - issue
          example: issue
          type: string
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      allOf:
                      - properties:
                          id:
                            example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748
                            pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
                            type: string
                          type:
                            default: resource_string_comments
                            enum:
                            - resource_string_comments
                            type: string
                        required:
                        - type
                        - id
                        type: object
                      - properties:
                          attributes:
                            allOf:
                            - description: Resource String Comment attributes
                              properties:
                                category:
                                  example: frontpage
                                  nullable: true
                                  type: string
                                message:
                                  example: the key is wrong
                                  type: string
                                priority:
                                  default: normal
                                  enum:
                                  - low
                                  - normal
                                  - high
                                  - critical
                                  - blocker
                                  nullable: true
                                  type: string
                                status:
                                  enum:
                                  - open
                                  - resolved
                                  example: resolved
                                  nullable: true
                                  type: string
                                type:
                                  enum:
                                  - comment
                                  - issue
                                  example: issue
                                  type: string
                              required:
                              - category
                              - message
                              - priority
                              - status
                              - type
                              type: object
                            - properties:
                                datetime_created:
                                  example: XXXX-XX-XXTXX:XX:XXZ
                                  format: date-time
                                  type: string
                                datetime_modified:
                                  example: XXXX-XX-XXTXX:XX:XXZ
                                  format: date-time
                                  type: string
                                datetime_resolved:
                                  example: XXXX-XX-XXTXX:XX:XXZ
                                  format: date-time
                                  nullable: true
                                  type: string
                              required:
                              - datetime_created
                              - datetime_resolved
                              - datetime_modified
                              type: object
                          links:
                            additionalProperties: false
                            properties:
                              self:
                                description: Resource String details link
                                example: /resource_string_comments/o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748
                                type: string
                            type: object
                          relationships:
                            additionalProperties: false
                            description: Resource String Comment relationships.
                            properties:
                              author:
                                additionalProperties: false
                                properties:
                                  data:
                                    description: User id.
                                    properties:
                                      id:
                                        description: User identifier.
                                        example: u:user_1
                                        pattern: ^u:[\w.-]+$
                                        type: string
                                      type:
                                        enum:
                                        - users
                                        type: string
                                    required:
                                    - type
                                    - id
                                    type: object
                                  links:
                                    additionalProperties: false
                                    description: User links.
                                    properties:
                                      related:
                                        description: User details link.
                                        example: /users/u:user_1
                                        type: string
                                    required:
                                    - related
                                    type: object
                                type: object
                              language:
                                additionalProperties: false
                                properties:
                                  data:
                                    additionalProperties: false
                                    description: Language data container.
                                    properties:
                                      id:
                                        description: Language identifier.
                                        example: l:en_US
                                        pattern: ^l:[a-zA-Z0-9@_.-]+$
                                        type: string
                                      type:
                                        enum:
                                        - languages
                                        type: string
                                    required:
                                    - type
                                    - id
                                    type: object
                                  links:
                                    additionalProperties: false
                                    description: Language related link.
                                    properties:
                                      related:
                                        description: Language details link.
                                        example: /languages/l:en_US
                                        type: string
                                    required:
                                    - related
                                    type: object
                                type: object
                              resolver:
                                additionalProperties: false
                                nullable: true
                                properties:
                                  data:
                                    description: User id.
                                    properties:
                                      id:
                                        description: User identifier.
                                        example: u:user_1
                                        pattern: ^u:[\w.-]+$
                                        type: string
                                      type:
                                        enum:
                                        - users
                                        type: string
                                    required:
                                    - type
                                    - id
                                    type: object
                                  links:
                                    additionalProperties: false
                                    description: User links.
                                    properties:
                                      related:
                                        description: User details link.
                                        example: /users/u:user_1
                                        type: string
                                    required:
                                    - related
                                    type: object
                                type: object
                              resource:
                                additionalProperties: false
                                properties:
                                  data:
                                    additionalProperties: false
                                    description: Resource data container.
                                    properties:
                                      id:
                                        description: Resource identifier.
                                        example: o:organization_slug:p:project_slug:r:resource_slug
                                        pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
                                        type: string
                                      type:
                                        enum:
                                        - resources
                                        type: string
                                    required:
                                    - type
                                    - id
                                    type: object
                                  links:
                                    additionalProperties: false
                                    description: Resource related link.
                                    properties:
                                      related:
                                        description: Resource details link.
                                        example: /resources/o:organization_slug:p:project_slug:r:resource_slug
                                        type: string
                                    required:
                                    - related
                                    type: object
                                type: object
                              resource_string:
                                additionalProperties: false
                                properties:
                                  data:
                                    additionalProperties: false
                                    description: Resource String data container.
                                    properties:
                                      id:
                                        description: Resource String identifier.
                                        example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
                                        pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
                                        type: string
                                      type:
                                        enum:
                                        - resource_strings
                                        type: string
                                    required:
                                    - type
                                    - id
                                    type: object
                                  links:
                                    additionalProperties: false
                                    description: Resource String related link.
                                    properties:
                                      related:
                                        description: Resource String details link.
                                        example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
                                        type: string
                                    required:
                                    - related
                                    type: object
                                type: object
                            required:
                            - resource_string
                            - resource
                            - language
                            type: object
                        type: object
                    type: array
                  links:
                    additionalProperties: false
                    description: Pagination links
                    properties:
                      next:
                        description: Link to the next page of results
                        example: /resource_strings_comments?filter[organization]=o:organization_slug&page[cursor]=XXX
                        nullable: true
                        type: string
                      previous:
                        description: Link to the previous page of results
                        example: /resource_strings_comments?filter[organization]=o:organization_slug&page[cursor]=XXX
                        nullable: true
                        type: string
                      self:
                        description: Link to the current page of results
                        example: /resource_strings_comments?filter[organization]=o:organization_slug&page[cursor]=XXX
                        type: string
                    type: object
                required:
                - data
                - links
                type: object
          description: List of resource string comments ordered by creation date in descending order
        '400':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        code:
                          example: invalid
                          type: string
                        detail:
                          example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
                          type: string
                        source:
                          anyOf:
                          - properties:
                              pointer:
                                example: /data/attributes/name
                                type: string
                          - properties:
                              parameter:
                                example: ?filter[foo]
                                type: string
                        status:
                          example: '400'
                          type: string
                        title:
                          example: Field `name` is invalid
                          type: string
                      type: object
                    type: array
                type: object
          description: Invalid
        '401':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        code:
                          example: unauthorized
                          type: string
                        detail:
                          example: Please verify your credentials
                          type: string
                        status:
                          example: '401'
                          type: string
                        title:
                          example: Unauthorized
                          type: string
                      type: object
                    type: array
                type: object
          description: Unauthorized
        '404':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          example: not found
                          type: string
                        detail:
                          example: Object not found. It may have been deleted or not been created yet
                          type: string
                        status:
                          example: '404'
                          type: string
                        title:
                          example: Object not found
                          type: string
                      type: object
                    type: array
                type: object
          description: Not found
        '500':
          content:
            application/vnd.api+json:
              schema:
                additionalProperties: false
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        code:
                          example: server error
                          type: string
                        detail:
                          example: Something went wrong, please try again
                          type: string
                        status:
                          example: '500'
                          type: string
                        title:
                          example: Something went wrong
                          type: string
                      type: object
                    type: array
                type: object
          description: Internal Error
      summary: List resource string comments
      tags:
      - Resource String Comments
      x-released: true
    post:
      description: Create a new resource string comment. This needs to be associated with a resource string and a target language.
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              additionalProperties: false
              properties:
                data:
                  additionalProperties: false
                  description: Create resource body request details
                  properties:
                    attributes:
                      additionalProperties: false
                      description: Resource String Comment attributes
                      properties:
                        category:
                          example: frontpage
                          nullable: true
                          type: string
                        message:
                          example: the key is wrong
                          type: string
                        priority:
                          default: normal
                          enum:
                          - low
                          - normal
                          - high
                          - critical
                          - blocker
                          nullable: true
                          type: string
                        type:
                          enum:
                          - comment
                          - issue
                          example: issue
                          type: string
                      required:
                      - message
                      - type
                      type: object
                    relationships:
                      additionalProperties: false
                      description: Resource String parent relationships
                      properties:
                        language:
                          additionalProperties: false
                          description: The `language` this comment refers to
                          properties:
                            data:
                              additionalProperties: false
                              description: Language data container.
                              properties:
                                id:
                                  description: Language identifier.
                                  example: l:en_US
                                  pattern: ^l:[a-zA-Z0-9@_.-]+$
                                  type: string
                                type:
                                  enum:
                                  - languages
                                  type: string
                              required:
                              - type
                              - id
                              type: object
                          required:
                          - data
                          type: object
                        resource_string:
                          additionalProperties: false
                          description: The `resource string` this comment refers to
                          properties:
                            data:
                              additionalProperties: false
                              description: Resource String data container.
                              properties:
                                id:
                                  description: Resource String identifier.
                                  example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
                                  pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
                                  type: string
                                type:
                                  enum:
                                  - resource_strings
                                  type: string
                              required:
                              - type
                              - id
                              type: object
                          required:
                          - data
                          type: object
                      required:
                      - language
                      - resource_string
                      type: object
                    type:
                      enum:
                      - resource_string_comments
                      type: string
                  required:
                  - type
                  - attributes
                  - relationships
                  type: object
              required:
             

# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/transifex/refs/heads/main/openapi/transifex-resource-string-comments-api-openapi.yml