Cycloid Organization naming rules API

openapi: 3.2.0
info:
  description: This is the Cycloid's API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types available within our console.
  title: Welcome! Organization naming rules API
  termsOfService: https://console.cycloid.io/terms
  contact:
    name: The Great Owl
    url: https://www.cycloid.io
    email: contact@cycloid.io
  license:
    name: Cycloid @copyrights
    url: https://cycloid.io
  version: '0'
servers:
- url: https://http-api.cycloid.io
security:
- api_key: []
- api_key_query: []
tags:
- name: Organization naming rules
paths:
  /organizations/{organization_canonical}/naming_rules:
    parameters:
    - $ref: '#/components/parameters/organization_canonical'
    get:
      description: Get the naming rules of the organization.
      tags:
      - Organization naming rules
      operationId: getOrganizationNamingRules
      responses:
        '200':
          description: The naming rules of the organization.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/OrganizationNamingRules'
              example:
                data:
                  component_regex: ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
                  env_regex: ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
                  project_regex: ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
        '403':
          $ref: '#/components/responses/not_enough_permissions'
        '404':
          $ref: '#/components/responses/not_found_entity_in_path'
        default:
          $ref: '#/components/responses/unexpected_error'
      summary: Get organization naming rules
      x-summary-source: derived
    put:
      description: Create or update the naming rules of the organization.
      tags:
      - Organization naming rules
      operationId: updateOrganizationNamingRules
      responses:
        '200':
          description: The updated naming rules of the organization.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/OrganizationNamingRules'
              example:
                data:
                  component_regex: ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
                  env_regex: ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
                  project_regex: ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
        '403':
          $ref: '#/components/responses/not_enough_permissions'
        '404':
          $ref: '#/components/responses/not_found_entity_in_path'
        '411':
          $ref: '#/components/responses/required_content_length_header'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
        default:
          $ref: '#/components/responses/unexpected_error'
      requestBody:
        content:
          application/vnd.cycloid.io.v1+json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationNamingRules'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationNamingRules'
        description: The naming rules to apply to the organization.
        required: true
      summary: Update organization naming rules
      x-summary-source: derived
    delete:
      description: Delete the naming rules of the organization.
      tags:
      - Organization naming rules
      operationId: deleteOrganizationNamingRules
      responses:
        '204':
          description: Organization naming rules have been deleted.
        '403':
          $ref: '#/components/responses/not_enough_permissions'
        '404':
          $ref: '#/components/responses/not_found_entity_in_path'
        default:
          $ref: '#/components/responses/unexpected_error'
      summary: Delete organization naming rules
      x-summary-source: derived
components:
  responses:
    not_found_entity_in_path:
      description: The response sent when any of the entities present in the path is not found.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: NotFoundEntity
              message: Entity not found
    required_content_length_header:
      description: The request has a body but it doesn't have a Content-Length header.
    not_enough_permissions:
      description: The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: Unauthorized
              message: Not enough permissions to perform the operation
    unprocessable_entity:
      description: All the custom errors that are generated from the Cycloid API
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: SomeCode
              message: some error
    unexpected_error:
      description: The response sent when an unexpected error happened, as known as an internal server error.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: Unexpected
              message: Server Internal error
  schemas:
    OrganizationNamingRules:
      description: Naming validation rules applied to entities within an organization
      title: OrganizationNamingRules
      properties:
        component_message:
          description: Custom error message shown when a component canonical does not match the regex
          type: string
          maxLength: 500
        component_regex:
          description: Regex pattern that component canonicals must match
          type: string
          maxLength: 255
        env_message:
          description: Custom error message shown when an environment canonical does not match the regex
          type: string
          maxLength: 500
        env_regex:
          description: Regex pattern that environment canonicals must match
          type: string
          maxLength: 255
        project_message:
          description: Custom error message shown when a project canonical does not match the regex
          type: string
          maxLength: 500
        project_regex:
          description: Regex pattern that project canonicals must match
          type: string
          maxLength: 255
    ErrorPayload:
      description: 'The payload used by the server to response to the client with an Error, those errors could be any of the ones listed [here](https://github.com/cycloidio/youdeploy-http-api/blob/develop/errors/code.go#L10), only the CODE of the error is the one that is guaranteed to not change between the same major version, the MESSAGE could change.

        '
      title: Error Payload
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailsItem'
        request_id:
          type: string
    UpdateOrganizationNamingRules:
      description: Naming validation rules to apply to entities within an organization
      title: UpdateOrganizationNamingRules
      properties:
        component_message:
          description: Custom error message shown when a component canonical does not match the regex
          type: string
          maxLength: 500
        component_regex:
          description: Regex pattern that component canonicals must match
          type: string
          maxLength: 255
        env_message:
          description: Custom error message shown when an environment canonical does not match the regex
          type: string
          maxLength: 500
        env_regex:
          description: Regex pattern that environment canonicals must match
          type: string
          maxLength: 255
        project_message:
          description: Custom error message shown when a project canonical does not match the regex
          type: string
          maxLength: 500
        project_regex:
          description: Regex pattern that project canonicals must match
          type: string
          maxLength: 255
    ErrorDetailsItem:
      description: Represents an item of the list of details of an error.
      title: Error details item
      required:
      - message
      - code
      properties:
        code:
          type: string
        details:
          type: array
          items:
            type: string
        message:
          type: string
  parameters:
    organization_canonical:
      description: A canonical of an organization.
      name: organization_canonical
      in: path
      required: true
      schema:
        type: string
        maxLength: 100
        minLength: 2
        pattern: ^[a-z0-9]([a-z0-9\-_]*[a-z0-9])?$
  securitySchemes:
    api_key:
      description: The API authorization is done with JWT tokens
      type: apiKey
      name: Authorization
      in: header
    api_key_query:
      description: The API authorization is done with JWT tokens in the query string
      type: apiKey
      name: api_key
      in: query