openapi: 3.2.0
info:
  title: Fenergo Naming Convention API
  version: '1.0'
  description: 'Operations tagged NamingConvention across 2 of this provider''s published API definitions: fenergo-docgencommand-v1-0-openapi.json, fenergo-docgenquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /docgencommand
- url: /docgenquery
security:
- Bearer: []
tags:
- name: NamingConvention
paths:
  /api/namingconvention:
    post:
      tags:
      - NamingConvention
      summary: Create a new global naming convension set
      description: 'Create a new naming convention set model and store it in the database.


        Required permissions:

        Following permissions are required: DocGenConfigurationCreate'
      operationId: CreateGlobalNamingConventionSet
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Create a naming convension set request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGlobalNamingConventionSetRequestDtoServiceRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateGlobalNamingConventionSetRequestDtoServiceRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateGlobalNamingConventionSetRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Naming convention set created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateGlobalNamingConventionSetResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGlobalNamingConventionSetResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateGlobalNamingConventionSetResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - NamingConvention
      summary: Get all global naming convention sets for the client tenant
      description: 'This method returns all global naming conventions sets with lite versions for a given tenant.


        Required permissions:

        Following permissions are required: DocGenConfigurationAccess'
      operationId: GetGlobalNamingConventionSets
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of naming convention sets is returned
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GlobalNamingConventionSetDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalNamingConventionSetDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GlobalNamingConventionSetDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgencommand
  /api/namingconvention/{setId}:
    delete:
      tags:
      - NamingConvention
      summary: Delete an existing global naming convension set and all its versions
      description: 'Deletes an existing global naming convension set and all its versions.


        Required permissions:

        Following permissions are required: DocGenConfigurationDelete'
      operationId: DeleteGlobalNamingConventionSet
      parameters:
      - name: setId
        in: path
        description: Id for Global Naming Convention Set to delete
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Accepted for processing
        '400':
          description: Invalid request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - NamingConvention
      summary: Get an existing global naming convention set with lite versions by Set Id
      description: 'This method returns existing global naming convention set for given set id.


        Required permissions:

        Following permissions are required: DocGenConfigurationAccess'
      operationId: GetGlobalNamingConventionSetById
      parameters:
      - name: setId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Global naming convention set is returned
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GlobalNamingConventionSetDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalNamingConventionSetDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GlobalNamingConventionSetDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. A set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgencommand
  /api/namingconvention/{setId}/version/{versionNumber}/draft:
    post:
      tags:
      - NamingConvention
      summary: Create a new version for an existing global naming convention set
      description: 'This method creates a new naming convention version.


        The new version initializes with the DTO data. It is assigned the next available version number,

        the default status of Draft and the Author as the only required Signee.


        Required permissions:

        At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate'
      operationId: CreateNamingConventionVersion
      parameters:
      - name: setId
        in: path
        description: The Id of the existing model
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: The version number of the version that the new version is based on
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Accepted for processing
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/NamingConventionVersionDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/NamingConventionVersionDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/NamingConventionVersionDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Naming Convention Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgencommand
  /api/namingconvention/{setId}/version/{versionNumber}:
    put:
      tags:
      - NamingConvention
      summary: Update an existing naming convention version
      description: 'This method updates an existing naming convention version.


        Only Draft and Rejected versions are allowed to be updated.


        Required permissions:

        Following permissions are required: DocGenConfigurationEdit'
      operationId: UpdateNamingConventionVersion
      parameters:
      - name: setId
        in: path
        description: The Id of the existing set
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: The version number to update
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Update naming convention version request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNamingConventionVersionRequestDtoServiceRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateNamingConventionVersionRequestDtoServiceRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateNamingConventionVersionRequestDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
        '400':
          description: Invalid request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Naming Convention Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    delete:
      tags:
      - NamingConvention
      summary: Delete a naming convention version
      description: 'Deletes the selected version of an existing global naming convention set.


        If the deleted version is the last one, then the version number of it will become the next available one for the model.

        Otherwise, the version number will be flagged as deleted and become unavailable.


        Required permissions:

        Following permissions are required: DocGenConfigurationDelete'
      operationId: DeleteNamingConventionVersion
      parameters:
      - name: setId
        in: path
        description: Global Naming Convention set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to delete
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. The specified version deleted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Global naming convention set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgencommand
  /api/namingconvention/{setId}/version/{versionNumber}/submit-for-approval:
    put:
      tags:
      - NamingConvention
      summary: Submit an existing naming convention version for Approval
      description: 'This method submits the selected naming convention version of an existing set for Approval.


        Required permissions:

        Following permissions are required: DocGenConfigurationEdit'
      operationId: SubmitNamingConventionVersion
      parameters:
      - name: setId
        in: path
        description: The Id of the existing set
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: The version number of the version to submit
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Accepted for processing
        '400':
          description: Validation error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Naming Convention Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgencommand
  /api/namingconvention/{setId}/version/{versionNumber}/sign:
    put:
      tags:
      - NamingConvention
      summary: Sign an existing naming convention version
      description: 'This method signs the selected naming convention version of an existing set.

        The Status of the version changes according to the action sent (Approve/Reject).


        Required permissions:

        Following permissions are required: DocGenConfigurationApprove'
      operationId: SignNamingConventionVersion
      parameters:
      - name: setId
        in: path
        description: The Id of the existing set
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: The version number of the version to sign
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveActionServiceRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApproveActionServiceRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApproveActionServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/VersionSignResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/VersionSignResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/VersionSignResponseServiceResponse'
        '400':
          description: Validation error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Naming Convention Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgencommand
  /api/namingconvention/{setId}/version/{versionNumber}/archive:
    put:
      tags:
      - NamingConvention
      summary: Archive an existing naming convention version
      description: 'This method archives the selected naming convention version of an existing set.


        Required permissions:

        Following permissions are required: DocGenConfigurationArchive'
      operationId: ArchiveNamingConventionVersion
      parameters:
      - name: setId
        in: path
        description: The Id of the existing set
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: The version number of the version to archive
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Accepted for processing
        '400':
          description: Validation error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Naming Convention Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgencommand
  /api/namingconvention/{setId}/versions/{versionNumber}:
    get:
      tags:
      - NamingConvention
      summary: Get an existing naming convention version by Set Id and version number
      description: 'This method returns an existing global naming convention version for a given set id and version number.


        Required permissions:

        Following permissions are required: DocGenConfigurationAccess'
      operationId: GetNamingConventionVersionBySetIdAndVersionNumber
      parameters:
      - name: setId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Naming convention version is returned
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/NamingConventionVersionDtoServiceResponse_2'
            application/json:
              schema:
                $ref: '#/components/schemas/NamingConventionVersionDtoServiceResponse_2'
            text/json:
              schema:
                $ref: '#/components/schemas/NamingConventionVersionDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. A version with given set id and version number does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /docgenquery
components:
  schemas:
    CreateGlobalNamingConventionSetResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the global naming convention set created
          format: uuid
        version:
          $ref: '#/components/schemas/NamingConventionVersionDto'
      additionalProperties: false
      description: Create a new Global Naming Convention Set response model
    VersionSignResponse:
      type: object
      properties:
        setId:
          type: string
          description: The Id of the set model that the version belongs to
          format: uuid
        versionNumber:
          type: integer
          description: The number of the version that has been signed
          format: int32
        status:
          $ref: '#/components/schemas/VersionStatus'
      additionalProperties: false
    NamingConventionGroupDto:
      type: object
      properties:
        lineItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NamingConventionLineItemDto'
          description: List of the naming convention item elements
      additionalProperties: false
      description: Naming Convention Group Model. The group model is created per data source, e.g. EntityData, CreditScreening, etc.
    VersionSignResponseServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/VersionSignResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    UpdateNamingConventionVersionRequestDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the version to update
          format: uuid
        setId:
          type: string
          description: Id of the global naming convention set that the version belongs to
          format: uuid
        name:
          type:
          - string
          - 'null'
          description: Name of the version
        description:
          type:
          - string
          - 'null'
          description: Description for the version
        entityDataNamingConventionGroup:
          $ref: '#/components/schemas/NamingConventionGroupDto'
        productsNamingConventionGroup:
          $ref: '#/components/schemas/NamingConventionGroupDto'
        versionNumber:
          type: integer
          description: The version number of the version to update
          format: int32
        effectiveFrom:
          type: string
          description: The date that the version takes effect when published
          format: date-time
          example: '2021-12-12T00:00:00.000Z'
      additionalProperties: false
      description: Update Naming Convention Version request model
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateGlobalNamingConventionSetRequestDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the naming convention
        description:
          type:
          - string
          - 'null'
          description: Description for the naming convention
      additionalProperties: false
      description: Create a new Global Naming Convention Set request model
    NamingConventionLineItemDto:
      type: object
      properties:
        dataKey:
          type:
          - string
          - 'null'
          description: data key value
          example: firstName
        value:
          type:
          - string
          - 'null'
          description: display value for the datakey
          example: First Name
        type:
          type:
          - string
          - 'null'
          description: type of the data key
          example: text/date/number
      additionalProperties: false
      description: Naming Convention Line Item model
    UpdateNamingConventionVersionRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateNamingConventionVersionRequestDto'
      additionalProperties: false
    Decision:
      enum:
      - Approve
      - Reject
      type: string
    CreateGlobalNamingConventionSetResponseDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateGlobalNamingConventionSetResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ApproveActionServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ApproveAction'
      additionalProperties: false
    CreateGlobalNamingConventionSetRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateGlobalNamingConventionSetRequestDto'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    NamingConventionVersionDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/NamingConventionVersionDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    NamingConventionVersionDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the version
          format: uuid
        setId:
          type: string
          description: Id of the global naming convention set that the version belongs to
          format: uuid
        name:
          type:
          - string
          - 'null'
          description: Name of the version
        description:
          type:
          - string
          - 'null'
          description: Description for the version
        entityDataNamingConventionGroup:
          $ref: '#/components/schemas/NamingConventionGroupDto'
        productsNamingConventionGroup:
          $ref: '#/components/schemas/NamingConventionGroupDto'
        versionNumber:
          type: integer
          description: The versions number
          format: int32
          example: 1
        effectiveFrom:
          type: string
          description: The date that the version takes effect when published
          format: date-time
          example: '2021-12-12T00:00:00.000Z'
        status:
          $ref: '#/components/schemas/VersionStatus'
        created:
          type: string
          description: The creation date of the version
          format: date-time
          example: '2021-12-12T15:55:00.000Z'
      additionalProperties: false
      description: The version model of Naming Convention
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    VersionStatus:
      enum:
      - Draft
      - Pending
      - Rejected
      - Published
      - Archived
      - Deleted
      type: string
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApproveAction:
      type: object
      properties:
        comment:
          type:
          - string
          - 'null'
        decision:
          $ref: '#/components/schemas/Decision'
        created:
          type: string
          format: date-time
      additionalProperties: false
    Approver:
      type: object
      properties:
        subject:
          type:
          - string
          - 'null'
        successor:
          allOf:
          - $ref: '#/components/schemas/Approver'
        action:
          allOf:
          - $ref: '#/components/schemas/ApproveAction_2'
        hasProcessedRequest:
          type: boolean
          readOnly: true
      additionalProperties: false
    GlobalNamingConventionSetDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GlobalNamingConventionSetDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    NamingConventionVersionDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/NamingConventionVersionDto_2'
          description: The version model of Naming Convention
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GlobalNamingConventionSetDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GlobalNamingConventionSetDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    NamingConventionVersionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Id of the version
          format: uuid
        setId:
          type: string
          description: Id of the set that the version belongs to
          format: uuid
        name:
          type:
          - string
          - 'null'
          description: Name of the version
        description:
          type:
          - string
          - 'null'
          description: Description for the version
        effectiveFrom:
          type: string
          description: The date that the version takes effect when published
          format: date-time
          example: '2021-12-12T00:00:00.000Z'
        versionNumber:
          type: integer
          description: The versions number
          format: int32
          example: 1
        status:
          allOf:
          - $ref: '#/components/schemas/VersionStatus'
          description: The status of the version
          example: Draft
        created:
          type: string
          description: The creation date of the version
          format: date-time
          example: '2021-12-12T15:55:00.000Z'
        isActive:
          type: boolean
          description: Is Version active
        publicationDate:
          type:
          - string
          - 'null'
          description: The date that the version got published
          format: date-time
          example: '2021-12-12T15:55:00.000Z'
        effectiveUntil:
          type:
          - string
          - 'null'
          description: The calculated date that the version ceases being active
          format: date-time
          example: '2021-12-12T15:55:00.000Z'
        entityDataNamingConventionGroup:
          allOf:
          - $ref: '#/components/schemas/NamingConventionGroupDto'
          description: Naming Convention Group model for Entity Data
        productsNamingConventionGroup:
          allOf:
          - $ref: '#/components/schemas/NamingConventionGroupDto'
          description: Naming Convention Group model for Products
        signees:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Signee'
          description: The defined list of signees for the version
      additionalProperties: false
      description: The version model of Naming Convention
    GlobalNamingConventionSetDto:
      type: object
      properties:
        id:
          type: string
          description: Global Naming Convention Set Id
          format: uuid
        versions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NamingConventionLiteVersionDto'
          description: List of naming convention versions of the set
      additionalProperties: false
    NamingConventionLiteVersionDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the version
          format: uuid
        setId:
          type: string
          description: Id of the set that the version belongs to
          format: uuid
        name:
          type:
          - string
          - 'null'
          description: Name of the version
        description:
          type:
          - string
          - 'null'
          description: Description for the version
        effectiveFrom:
          type: string
          description: The date that the version takes effect when published
          format: date-time
          example: '2021-12-12T00:00:00.000Z'
        versionNumber:
          type: integer
          description: The versions number
          format: int32
          example: 1
        status:
          allOf:
          - $ref: '#/components/schemas/VersionStatus'
          description: The status of the version
          example: Draft
        created:
          type: string
          description: The creation date of the version
          format: date-time
          example: '2021-12-12T15:55:00.000Z'
        isActive:
          type: boolean
          description: Is Version active
        publicationDate:
          type:
          - string
          - 'null'
          description: The date that the version got published
          format: date-time
          example: '2021-12-12T15:55:00.000Z'
        effectiveUntil:
          type:
          - string
          - 'null'
          description: The calculated date that the version ceases being active
          format: date-time
          example: '2021-12-12T15:55:00.000Z'
      additionalProperties: false
      description: The lite model of Naming Convention Version
    Signee:
      type: object
      properties:
        subject:
          type:
          - string
          - 'null'
        successor:
          allOf:
          - $ref: '#/components/schemas/Approver'
        action:
          allOf:
          - $ref: '#/components/schemas/ApproveAction_2'
        hasProcessedRequest:
          type: boolean
          readOnly: true
      additionalProperties: false
    ApproveAction_2:
      type: object
      properties:
        comment:
          type:
          - string
          - 'null'
        decision:
          allOf:
          - $ref: '#/components/schemas/Decision'
        created:
          type: string
          format: date-time
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-docgencommand-v1-0-openapi.json
- fenergo-docgenquery-v1-0-openapi.json