mr-api.yaml

openapi: 3.0.1
info:
  title: ManagementResourceApi
  description: This describes the API clients use for accessing features. This reflects the API from 1.6.1 onwards.
  version: "1.2.4"
#  CRUD for portfolios, environments, features, service account, people, and groups (edited)
#  roles are fixed
#  then people<->group association
#  and group<->role association
paths:
  /mr-api/dacha1/cache:
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - CacheService
      description: "Allows superusers to refresh the global Dacha1 cache (if it exists)."
      operationId: cacheRefresh
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CacheRefreshRequest"
      responses:
        200:
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CacheRefreshResponse"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "Dacha1 is not being used and API does not exist"
  /mr-api/organization/{id}/group:
    parameters:
      - name: id
        required: true
        in: path
        description: "the id of the organisation"
        schema:
          type: string
          format: uuid
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - GroupService
      description: "Gets the superuser group for this organisation. There is no other way to ascertain which org you are dealing with"
      operationId: getSuperuserGroup
      responses:
        200:
          description: "The superuser group presuming the organization exists"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"
  /mr-api/portfolio:
    parameters:
      - name: includeGroups
        description: "Include groups for this this portfolio in results"
        in: query
        schema:
          type: boolean
      - name: includeApplications
        description: "Include applications for this portfolio in results"
        in: query
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - PortfolioService
      description: "Gets a list of portfolios."
      operationId: findPortfolios
      parameters:
        - name: order
          in: query
          description: "how to order the results"
          schema:
            $ref: "#/components/schemas/SortOrder"
        - name: filter
          in: query
          description: "What to filter the results by"
          schema:
            type: string
        - name: parentPortfolioId
          in: query
          description: "The parent portfolio to search under. If none is provided, use the top level one"
          schema:
            type: string
      responses:
        200:
          description: "Gets all portfolios, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Portfolio"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - PortfolioService
      description: "Create a new portfolio"
      operationId: createPortfolio
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreatePortfolio"
      responses:
        200:
          description: "Resulting portfolio"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Portfolio"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden to create portfolio"
        404:
          description: "unable to create portfolio"
        409:
          description: "duplicate portfolio"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - PortfolioService
      parameters:
        - name: includeEnvironments
          description: "Include environments for the included applications this portfolio in results"
          in: query
          schema:
            type: boolean
      description: "Update a portfolio"
      operationId: updatePortfolioOnOrganisation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Portfolio"
      responses:
        200:
          description: "Resulting portfolio"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Portfolio"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "no permission to update portfolio"
        404:
          description: "cannot find portfolio to update"
        409:
          description: "duplicate portfolio name"
        422:
          description: "updating old portfolio"
  /mr-api/portfolio/{id}:
    parameters:
      - name: id
        description: "The id of the portfolio to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeGroups
        description: "Include groups for this this portfolio in results"
        in: query
        schema:
          type: boolean
      - name: includeApplications
        description: "Include applications for this portfolio in results"
        in: query
        schema:
          type: boolean
      - name: includeEnvironments
        description: "Include the environments inside the applications"
        in: query
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - PortfolioService
      description: "Get portfolio"
      operationId: getPortfolio
      responses:
        200:
          description: "Resulting portfolio"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Portfolio"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"
    put:
      deprecated: true
      security:
        - bearerAuth: [ ]
      tags:
        - PortfolioService
      description: "Update a portfolio"
      operationId: updatePortfolio
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Portfolio"
      responses:
        200:
          description: "Resulting portfolio"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Portfolio"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "no permission to update portfolio"
        404:
          description: "cannot find portfolio to update"
        409:
          description: "duplicate portfolio name"
        422:
          description: "updating old portfolio"
    delete:
      security:
        - bearerAuth: [ ]
      tags:
        - PortfolioService
      description: "Delete a portfolio"
      operationId: deletePortfolio
      responses:
        200:
          description: "How many portfolios were deleted."
          content:
            application/json:
              schema:
                type: boolean
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"

  /mr-api/portfolio/{id}/application:
    parameters:
      - name: id
        description: "The id of the portfolio to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeEnvironments
        in: query
        description: "Include the environments in the result"
        schema:
          type: boolean
      - name: includeFeatures
        in: query
        description: "Include the features in the result"
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Gets a list of applications."
      operationId: findApplications
      parameters:
        - name: order
          in: query
          description: "how to order the results"
          schema:
            $ref: "#/components/schemas/SortOrder"
        - name: filter
          in: query
          description: "What to filter the results by"
          schema:
            type: string
      responses:
        200:
          description: "Gets all portfolios, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Application"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "none found"

    post:
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Create a new application"
      operationId: createApplication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateApplication"
      responses:
        200:
          description: "Resulting application"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Application"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        409:
          description: "duplicates"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Update an application"
      operationId: updateApplicationOnPortfolio
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Application"
      responses:
        200:
          description: "Resulting portfolio"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Application"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "app not found"
        409:
          description: "Duplicate application"
        422:
          description: "Trying to save old record"

  /mr-api/portfolio/{id}/group:
    parameters:
      - name: id
        description: "The id of the portfolio to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includePeople
        description: "include people in each group"
        in: query
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - GroupService
      description: "Gets a list of groups."
      operationId: findGroups
      parameters:
        - name: order
          in: query
          description: "how to order the results"
          schema:
            $ref: "#/components/schemas/SortOrder"
        - name: filter
          in: query
          description: "What to filter the results by"
          schema:
            type: string
      responses:
        200:
          description: "Gets groups, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - GroupService
      description: "Create a new group"
      operationId: createGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateGroup"
      responses:
        200:
          description: "Resulting group"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "no permission"
        409:
          description: "duplicate"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - GroupService
      description: "Update a group"
      operationId: updateGroupOnPortfolio
      parameters:
        - name: includeMembers
          description: "include people in each group"
          in: query
          schema:
            type: boolean
        - name: includeGroupRoles
          description: "include environment and application roles in each group"
          in: query
          schema:
            type: boolean
        - name: updateMembers
          description: "update members, deleting those that are not passed"
          in: query
          schema:
            type: boolean
          required: false
        - name: updateEnvironmentGroupRoles
          description: "update environment group roles, deleting any not passed"
          in: query
          schema:
            type: boolean
          required: false
        - name: updateApplicationGroupRoles
          description: "update application group roles, deleting any not passed"
          in: query
          schema:
            type: boolean
          required: false
        - name: applicationId
          description: "if updating the application group roles, and the application id is passed, then the changes are limited to that application"
          in: query
          schema:
            type: string
            format: uuid
          required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Group"
      responses:
        200:
          description: "Resulting group"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
        409:
          description: "duplicate user or duplicate group"
        422:
          description: "version conflict"

  /mr-api/person:
    parameters:
      - name: includeGroups
        description: "Include groups in result"
        in: query
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - PersonService
      description: "Gets a list of matching people."
      operationId: findPeople
      parameters:
        - name: countGroups
          description: "Return the number of groups"
          in: query
          required: false
          schema:
            type: boolean
        - name: order
          in: query
          description: "how to order the results"
          schema:
            $ref: "#/components/schemas/SortOrder"
        - name: filter
          in: query
          description: "What to filter the results by"
          schema:
            type: string
        - name: startAt
          in: query
          description: "Where in the results to start"
          schema:
            type: integer
        - name: pageSize
          in: query
          description: "How many results to return"
          schema:
            type: integer
        - name: includeLastLoggedIn
          in: query
          description: "Include last logged in timestamp"
          schema:
            type: boolean
        - name: includeDeactivated
          in: query
          description: "Include people who are no longer active"
          schema:
            type: boolean
        - name: personTypes
          in: query
          description: "Filter by person types"
          schema:
            type: array
            items:
              $ref: "#/components/schemas/PersonType"
        - name: sortBy
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/SearchPersonSortBy"
      responses:
        200:
          description: "Gets all persons, alphabetically sorted"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchPersonResult"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "only admins can call this API"
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - PersonService
      description: "Create a new person"
      operationId: createPerson
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreatePersonDetails"
      responses:
        200:
          description: "Registration url"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RegistrationUrl"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden to only admins"
        409:
          description: "person already exists"
  /mr-api/person/{id}/token-reset:
    post:
      parameters:
        - name: id
          description: "The id of the person to find"
          in: path
          schema:
            type: string
            format: uuid
          required: true
      security:
        - bearerAuth: [ ]
      tags:
        - PersonService
      description: "Reset security token of supported person type (usually service accounts only)"
      operationId: resetSecurityToken
      responses:
        200:
          description: "New security token"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AdminServiceResetTokenResponse"
        404:
          description: "Service account not found"
        403:
          description: "No permission to change"
        401:
          description: "Not authenticated"
  /mr-api/person/{id}/v2:
    parameters:
      - name: id
        description: "The id of the person to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - PersonService
      description: "Update a person"
      operationId: updatePersonV2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdatePerson"
      responses:
        204:
          description: "Resulting person"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden to update that person"
        404:
          description: "person not found"
        422:
          description: "attempting to update old person record"
  /mr-api/person/{id}:
    parameters:
      - name: id
        description: "The id of the person to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeGroups
        description: "Include groups in result"
        in: query
        schema:
          type: boolean
      - name: includeAcls
        description: "include acls for each group"
        in: query
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - PersonService
      parameters:
        - name: id
          description: "The id of the person to find. Duplicated here as we accept a plain string (not only a uuid)"
          in: path
          schema:
            type: string
          required: true
      description: "Get person"
      operationId: getPerson
      responses:
        200:
          description: "If this is a sdk service acocunt, ID of the service account is in the PersonInfo fields with the key serviceAccountId"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - PersonService
      description: "Update a person"
      operationId: updatePerson
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Person"
      responses:
        200:
          description: "Resulting person"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden to update that person"
        404:
          description: "person not found"
        422:
          description: "attempting to update old person record"
    delete:
      security:
        - bearerAuth: [ ]
      tags:
        - PersonService
      description: "Delete a person"
      operationId: deletePerson
      responses:
        200:
          description: "How many people were deleted."
          content:
            application/json:
              schema:
                type: boolean
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
  /mr-api/authentication:
    post:
      tags:
        - AuthService
      description: "Create a new user"
      operationId: registerPerson
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PersonRegistrationDetails"
      responses:
        200:
          description: "Tokenized person"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TokenizedPerson"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "person already registered who is using this token or cannot find person to register"

  /mr-api/external-provider/{provider}:
    parameters:
      - name: provider
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - AuthService
      description: "Gets a login URL for this specified provider if it is supported by the server"
      operationId: getLoginUrlForProvider
      responses:
        200:
          description: "The information required to redirect"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProviderRedirect"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"
  /mr-api/login:
    post:
      tags:
        - AuthService
      description: "Login to Feature Hub"
      operationId: login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserCredentials"
      responses:
        200:
          description: "Successfully logged in"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TokenizedPerson"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "login is disabled for this instance"
        404:
          description: "user is not found"
  /mr-api/logout:
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - AuthService
      description: "Get person by token"
      operationId: logout
      responses:
        204:
          description: "Token deactivated"
        400:
          description: "Bad Request"
        401:
          description: "no permission"

  /mr-api/authentication/{id}/replaceTempPassword:
    parameters:
      - name: id
        description: "The id of the person to replace temporary password for"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    put:
      tags:
        - AuthService
      description: "Replace temporary password"
      x-java-annotations: "@io.featurehub.mr.api.AllowedDuringPasswordReset"
      security:
        - bearerAuth: [ ]
      operationId: replaceTempPassword
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PasswordReset"
      responses:
        200:
          description: "Successfully reset temporary password"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TokenizedPerson"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
  /mr-api/authentication/{email}/expiredTokenReset:
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - AuthService
      parameters:
        - name: email
          in: path
          description: "The email address of the person whose expired token to reset"
          schema:
            type: string
          required: true
      description: "Allows an administrator to reset a user's expired token so they can login"
      operationId: resetExpiredToken
      responses:
        200:
          description: "The token of the expired person"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RegistrationUrl"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"

  /mr-api/authentication/{id}/changePassword:
    parameters:
      - name: id
        description: "The id of the person to change password for"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - AuthService
      description: "Change password"
      operationId: changePassword
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PasswordUpdate"
      responses:
        200:
          description: "Successfully updated password"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
  /mr-api/authentication/{token}:
    get:
      tags:
        - AuthService
      description: "Get person by token"
      operationId: personByToken
      parameters:
        - name: token
          in: path
          schema:
            type: string
          required: true
      responses:
        200:
          description: "Get user by token"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"

  /mr-api/authentication/{id}/resetPassword:
    parameters:
      - name: id
        description: "The id of the person to reset password for"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    put:
      tags:
        - AuthService
      security:
        - bearerAuth: [ ]
      description: "Reset password"
      operationId: resetPassword
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PasswordReset"
      responses:
        200:
          description: "Successfully reset password"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
  /mr-api/application/{appId}:
    parameters:
      - name: appId
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeEnvironments
        in: query
        description: "Include the environments in the result"
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Get application"
      operationId: getApplication
      responses:
        200:
          description: "Resulting application"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Application"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "no application"
    put:
      deprecated: true
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Update an application"
      operationId: updateApplication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Application"
      responses:
        200:
          description: "Resulting portfolio"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Application"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "app not found"
        409:
          description: "Duplicate application"
        422:
          description: "Trying to save old record"
    delete:
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Delete an application"
      operationId: deleteApplication
      responses:
        200:
          description: "Did we delete the application"
          content:
            application/json:
              schema:
                type: boolean
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
  /mr-api/application/{appId}/summary:
    parameters:
      - name: appId
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Geta summary of the application status"
      operationId: summaryApplication
      responses:
        200:
          description: "Resulting application"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicationSummary"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "no application"

  /mr-api/application/{id}/features:
    parameters:
      - name: id
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeMetaData
        description: "Include the metadata in the returned feature objects. Can be large."
        in: query
        schema:
          type: boolean
        required: false
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "get all features available in this application"
      operationId: getAllFeaturesForApplication
      responses:
        200:
          description: "Gets all features, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Feature"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "add a new feature to this application, returns all features."
      operationId: createFeaturesForApplication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateFeature"
      responses:
        200:
          description: "All features, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Feature"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        409:
          description: "Duplicate feature"
    put:
      parameters:
        - name: returnAllFeatures
          in: query
          schema:
            default: true
            type: boolean
          required: false
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "updates all named features in this application, returns all features by default otherwise just the feature updated"
      operationId: updateFeatureForApplicationOnFeature
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Feature"
      responses:
        200:
          description: "All features, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Feature"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"
        409:
          description: "duplicate feature"
        422:
          description: "other feature updated already"
  /mr-api/application/{id}/features/{key}:
    parameters:
      - name: id
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: key
        description: "The named unique key of the associated feature"
        in: path
        schema:
          type: string
        required: true
      - name: includeMetaData
        description: "Include the metadata in the returned feature objects. Can be large."
        in: query
        schema:
          type: boolean
        required: false
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "get an individual feature"
      operationId: getFeatureByKey
      responses:
        200:
          description: "All features, alphabetically sorted"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Feature"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "updates all named features in this application, returns all features. Use this ONLY if you wish to change the key."
      operationId: updateFeatureForApplication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Feature"
      responses:
        200:
          description: "All features, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Feature"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"
        409:
          description: "duplicate feature"
        422:
          description: "other feature updated already"
    delete:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "updates all named features in this application, returns all features."
      operationId: deleteFeatureForApplication
      responses:
        200:
          description: "All features, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Feature"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "none found"
  /mr-api/application/{id}/feature-environments/{key}:
    parameters:
      - name: id
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: key
        description: "The key of the associated feature"
        in: path
        schema:
          type: string
        required: true
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "Get a list of all environments and features and their values that this user has access to"
      operationId: getAllFeatureValuesByApplicationForKey
      responses:
        200:
          description: "Gets all feature values for all environments for an application"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/FeatureEnvironment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"

    put:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "Update a list of all environments and features and their values that this user has access to"
      operationId: updateAllFeatureValuesByApplicationForKey
      parameters:
        - name: removeValuesNotPassed
          description: "The id of the application to find"
          in: query
          schema:
            type: boolean
          required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/FeatureValue"
      responses:
        200:
          description: "Gets all feature values for all environments for an application"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/FeatureEnvironment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        409:
          description: "Conflict in trying to save, someone else updated a record first"
        422:
          description: "There were validation failures in the rollout strategies"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RolloutStrategyValidationResponse"
  /mr-api/application/{id}/all-feature-environment:
    parameters:
      - name: id
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: environmentIds
        description: "The environment ids to filter by. This should be limited to what the user is currently looking at or needing"
        in: query
        schema:
          type: array
          items:
            type: string
            format: uuid
      - name: filter
        description: "A filter to apply to the features - partial match of key or description"
        in: query
        schema:
          type: string
        required: false
      - name: max
        description: "The maximum number of features to get for this page"
        in: query
        schema:
          type: integer
        required: false
      - name: page
        description: "The page number of the results. 0 indexed."
        in: query
        schema:
          type: integer
        required: false
      - name: featureTypes
        in: query
        schema:
          type: array
          items:
            $ref: "#/components/schemas/FeatureValueType"
        required: false
      - name: sortOrder
        in: query
        schema:
          $ref: "#/components/schemas/SortOrder"
        required: false
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - FeatureService
      description: "Get a list of all environments and features and their values that this user has access to"
      operationId: findAllFeatureAndFeatureValuesForEnvironmentsByApplication
      responses:
        200:
          description: "Gets all portfolios, alphabetically sorted"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicationFeatureValues"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "not found"

  /mr-api/application/{id}/environment-ordering:
    parameters:
      - name: id
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      description: "this api is designed to update the ordering of environments. it will error on circular references or environments that don't exist."
      operationId: environmentOrdering
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/Environment"
      responses:
        200:
          description: "returns all environments with no particular sort order."
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
  /mr-api/application/{id}/environment:
    parameters:
      - name: id
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      description: "Gets a list of environments."
      operationId: findEnvironments
      parameters:
        - name: order
          in: query
          description: "how to order the results"
          schema:
            $ref: "#/components/schemas/EnvironmentSortOrder"
        - name: filter
          in: query
          description: "What to filter the results by"
          schema:
            type: string
        - name: includeAcls
          description: "Include the acls attached to this environment"
          in: query
          schema:
            type: boolean
        - name: includeFeatures
          description: "Include the features attached to this environment"
          in: query
          schema:
            type: boolean
        - name: includeDetails
          description: "Include all environment details"
          in: query
          schema:
            type: boolean
      responses:
        200:
          description: "Gets all environments, alphabetically sorted"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      description: "Create a new environment"
      operationId: createEnvironmentOnApplication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateEnvironment"
      responses:
        200:
          description: "Resulting environment"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "application not found"
        409:
          description: "duplicate environment"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      parameters:
        - name: includeDetails
          description: "Include all environment details"
          in: query
          schema:
            type: boolean
      description: "Update an environment"
      operationId: updateEnvironmentOnApplication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateEnvironmentV2"
      responses:
        200:
          description: "Resulting environment"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "No environment found to update"
        409:
          description: "Duplicate environment"
        422:
          description: "Updating old environment"

  /mr-api/application/{id}/permissions:
    parameters:
      - name: id
        description: "The id of the application to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - ApplicationService
      description: "Gets the permissions of the current user for the specified application"
      operationId: applicationPermissions
      responses:
        200:
          description: "The application & environment permissions"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicationPermissions"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
    post:
      deprecated: true
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      description: "Create a new environment - this is mounted at the wrong REST endpoint and is not assured to be maintained"
      operationId: createEnvironment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateEnvironment"
      responses:
        200:
          description: "Resulting environment"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "application not found"
        409:
          description: "duplicate environment"

  /mr-api/environment/{eid}/v2:
    parameters:
      - name: eid
        description: "The id of the environment to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeAcls
        description: "Include the acls attached to this environment"
        in: query
        schema:
          type: boolean
      - name: includeFeatures
        description: "Include the features attached to this environment"
        in: query
        schema:
          type: boolean
      - name: includeDetails
        description: "Include all environment details"
        in: query
        schema:
          type: boolean
    put:
      deprecated: true
      security:
        - bearerAuth: [ ]
      tags:
        - Environment2Service
      description: "Update an environment, prefer updateEnvironment on EnvironmentService"
      operationId: updateEnvironmentV2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateEnvironment"
      responses:
        200:
          description: "Resulting environment"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "No environment found to update"
        409:
          description: "Duplicate environment"
        422:
          description: "Updating old environment"
  /mr-api/environment/{eid}:
    parameters:
      - name: eid
        description: "The id of the environment to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeAcls
        description: "Include the acls attached to this environment"
        in: query
        schema:
          type: boolean
      - name: includeFeatures
        description: "Include the features attached to this environment"
        in: query
        schema:
          type: boolean
      - name: includeDetails
        description: "Include all environment details"
        in: query
        schema:
          type: boolean
      - name: decryptWebhookDetails
        description: "Decrypt all webhook env details"
        in: query
        schema:
          type: boolean
    get:
      parameters:
        - name: includeSdkUrl
          description: "include the sdk url"
          in: query
          schema:
            type: boolean
        - name: includeServiceAccounts
          description: "Include the service accounts attached to this environment"
          in: query
          schema:
            type: boolean
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      description: "Get environment"
      operationId: getEnvironment
      responses:
        200:
          description: "Resulting environment"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
    put:
      deprecated: true
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      description: "Update an environment. Please use updateEnvironment"
      operationId: updateEnvironment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Environment"
      responses:
        200:
          description: "Resulting environment"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Environment"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "No environment found to update TODO: fix, should be 404 or 403"
        409:
          description: "Duplicate environment"
        422:
          description: "Updating old environment"
    delete:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentService
      description: "Delete an environment"
      operationId: deleteEnvironment
      responses:
        200:
          description: "Did we delete the environment."
          content:
            application/json:
              schema:
                type: boolean
        400:
          description: "Bad Request"
        401:
          description: "no permission"

  /mr-api/features/{eid}:
    parameters:
      - name: eid
        description: "The id of the environment to find features or 'latest'"
        in: path
        schema:
          type: string
          format: uuid
        required: true
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentFeatureService
      parameters:
        - name: includeFeatures
          description: "include the features in the result"
          in: query
          required: false
          schema:
            type: boolean
        - name: filter
          description: "Filter the feature names by this filter."
          in: query
          schema:
            type: string
          required: false
      description: "Get all features for this environment"
      operationId: getFeaturesForEnvironment
      responses:
        200:
          description: "Resulting features"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EnvironmentFeaturesResult"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentFeatureService
      description: "Update all features for this environment that are passed. Ignores any other feature values that are not passed."
      operationId: updateAllFeaturesForEnvironment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/FeatureValue"
      responses:
        200:
          description: "Resulting features"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/FeatureValue"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "Forbidden, no permission to change role"
        404:
          description: "No environment"
        409:
          description: "Conflict in trying to save, someone else updated a record first"
        422:
          description: "There were validation failures in the rollout strategies"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RolloutStrategyValidationResponse"
  /mr-api/features/{eid}/feature/{key}:
    parameters:
      - name: eid
        description: "The id of the environment to find features"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: key
        description: "The key of the relevant feature"
        in: path
        schema:
          type: string
        required: true
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentFeatureService
      description: "Update a specific feature in this environment."
      operationId: getFeatureForEnvironment
      responses:
        200:
          description: "Resulting feature"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FeatureValue"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
    put:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentFeatureService
      description: "Update a specific feature in this environment."
      operationId: updateFeatureForEnvironment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureValue"
      responses:
        200:
          description: "Resulting features"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FeatureValue"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        409:
          description: "Conflict in trying to save, someone else updated a record first"
        422:
          description: "There were validation failures in the rollout strategies"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RolloutStrategyValidationResponse"
    post:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentFeatureService
      description: "Create a specific feature in this environment."
      operationId: createFeatureForEnvironment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FeatureValue"
      responses:
        200:
          description: "Resulting features"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FeatureValue"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "No permission to change role"
        404:
          description: "No feature for that environment found"
        409:
          description: "Conflict in trying to save, someone else updated a record first"
        422:
          description: "There were validation failures in the rollout strategies"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RolloutStrategyValidationResponse"
    delete:
      security:
        - bearerAuth: [ ]
      tags:
        - EnvironmentFeatureService
      description: "No longer supported. Please update to a null value."
      operationId: deleteFeatureForEnvironment
      responses:
        400:
          description: "Bad Request"
        401:
          description: "no permission"
  /mr-api/group/{gid}:
    parameters:
      - name: gid
        description: "The id of the group to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeMembers
        description: "include people in each group"
        in: query
        schema:
          type: boolean
      - name: includeGroupRoles
        description: "include environment and application roles in each group"
        in: query
        schema:
          type: boolean
    get:
      security:
        - bearerAuth: [ ]
      tags:
        - GroupService
      parameters:
        - name: byApplicationId
          in: query
          schema:
            type: string
            format: uuid
      description: "Get group"
      operationId: getGroup
      responses:
        200:
          description: "Resulting group"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
    put:
      deprecated: true
      security:
        - bearerAuth: [ ]
      tags:
        - GroupService
      description: "Update a group"
      operationId: updateGroup
      parameters:
        - name: updateMembers
          description: "update members, deleting those that are not passed"
          in: query
          schema:
            type: boolean
          required: false
        - name: updateEnvironmentGroupRoles
          description: "update environment group roles, deleting any not passed"
          in: query
          schema:
            type: boolean
          required: false
        - name: updateApplicationGroupRoles
          description: "update application group roles, deleting any not passed"
          in: query
          schema:
            type: boolean
          required: false
        - name: applicationId
          description: "if updating the application group roles, and the application id is passed, then the changes are limited to that application"
          in: query
          schema:
            type: string
            format: uuid
          required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Group"
      responses:
        200:
          description: "Resulting group"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
        409:
          description: "duplicate user or duplicate group"
        422:
          description: "version conflict"
    delete:
      security:
        - bearerAuth: [ ]
      tags:
        - GroupService
      description: "Delete a group"
      operationId: deleteGroup
      responses:
        200:
          description: "Did we delete the group?"
          content:
            application/json:
              schema:
                type: boolean
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
  /mr-api/group/{gid}/person/{pId}:
    parameters:
      - name: gid
        description: "The id of the group to find"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: pId
        description: "The id of the person to add/delete"
        in: path
        schema:
          type: string
          format: uuid
        required: true
      - name: includeMembers
        description: "include people in each group"
        in: query
        schema:
          type: boolean
    post:
      tags:
        - GroupService
      security:
        - bearerAuth: [ ]
      description: "Add a person to a group"
      operationId: addPersonToGroup
      responses:
        200:
          description: "Resulting group"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "group or person not found"
    delete:
      tags:
        - GroupService
      security:
        - bearerAuth: [ ]
      description: "Remove a person from a group"
      operationId: deletePersonFromGroup
      responses:
        200:
          description: "Resulting group"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
  /mr-api/portfolio/{id}/service-account:
    parameters:
      - name: id
        description: "the portfolio this service account belongs to"
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: includePermissions
        description: "include permissions in return"
        in: query
        schema:
          type: boolean
    get:
      tags:
        - ServiceAccountService
      security:
        - bearerAuth: [ ]
      description: "Get list of all service accounts this user can see"
      parameters:
        - name: filter
          description: "include environments for each account"
          in: query
          schema:
            type: string
        - name: applicationId
          description: "Application ID to filter on"
          in: query
          schema:
            type: string
            format: uuid
        - name: includeSdkUrls
          description: "Include the SDKs for environments the user has access to"
          in: query
          schema:
            type: boolean
      operationId: searchServiceAccountsInPortfolio
      responses:
        200:
          description: "List of service accounts found"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ServiceAccount"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
    post:
      tags:
        - ServiceAccountService
      security:
        - bearerAuth: [ ]
      description: "Add a new service account"
      operationId: createServiceAccountInPortfolio
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateServiceAccount"
      responses:
        200:
          description: "Newly created service account"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceAccount"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        409:
          description: "duplicate"
    put:
      parameters:
        - name: includePermissions
          description: "include permissions in return"
          in: query
          schema:
            type: boolean
        - name: appId
          description: "limit removals to this application id"
          in: query
          required: false
          schema:
            type: string
            format: uuid
      tags:
        - ServiceAccountService
      security:
        - bearerAuth: [ ]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ServiceAccount"
      description: "Update this service account, overwiting any attached environment permissions this user has access to"
      operationId: updateServiceAccountOnPortfolio
      responses:
        200:
          description: "Details of service account"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceAccount"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "trying to update SA that doesn't exist"
        422:
          description: "trying to update old version"
  /mr-api/service-account/{id}:
    get:
      parameters:
        - name: id
          description: "the id for the service account to get"
          in: path
          required: true
          schema:
            type: string
        - name: includePermissions
          description: "include permissions in return"
          in: query
          schema:
            type: boolean
        - name: byApplicationId
          in: query
          schema:
            type: string
            format: uuid
      tags:
        - ServiceAccountService
      security:
        - bearerAuth: [ ]
      description: "Get service account by id or 'self' if authenticated as this service account"
      operationId: getServiceAccount
      responses:
        200:
          description: "Details of service account"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceAccount"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
    put:
      deprecated: true
      parameters:
        - name: id
          description: "the id for the service account to get"
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: includePermissions
          description: "include permissions in return"
          in: query
          schema:
            type: boolean
      tags:
        - ServiceAccountService
      security:
        - bearerAuth: [ ]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ServiceAccount"
      description: "Update this service account, overwiting any attached environment permissions this user has access to"
      operationId: updateServiceAccount
      responses:
        200:
          description: "Details of service account"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceAccount"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "trying to update SA that doesn't exist"
        422:
          description: "trying to update old version"

    delete:
      parameters:
        - name: id
          description: "the id for the service account to get"
          in: path
          required: true
          schema:
            type: string
            format: uuid
      tags:
        - ServiceAccountService
      security:
        - bearerAuth: [ ]
      description: "Delete this service account, cascade removes all permissions"
      operationId: deleteServiceAccount
      responses:
        200:
          description: "Details of service account"
          content:
            application/json:
              schema:
                type: boolean
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
  /mr-api/service-account/{id}/reset-api-key:
    post:
      tags:
        - ServiceAccountService
      security:
        - bearerAuth: [ ]
      description: "Causes a new API Key to be generated. Ensure you confirm this with the user."
      operationId: resetApiKey
      parameters:
        - name: id
          description: "the id for the service account to get"
          required: true
          in: path
          schema:
            type: string
            format: uuid
        - name: apiKeyType
          description: "Type of the API key"
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/ResetApiKeyType"
      responses:
        200:
          description: "Details of service account"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceAccount"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        403:
          description: "forbidden"
        404:
          description: "not found"
  /mr-api/initialize:
    get:
      tags:
        - SetupService
      description: "Ping Feature Hub"
      operationId: isInstalled
      responses:
        200:
          description: "Hello from Feature Hub"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SetupResponse"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        404:
          description: "Feature Hub not found"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SetupMissingResponse"
    post:
      tags:
        - SetupService
      description: "Setup site admin"
      operationId: setupSiteAdmin
      responses:
        200:
          description: "Successfully setup site admin"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TokenizedPerson"
        400:
          description: "Bad Request"
        401:
          description: "no permission"
        409:
          description: "duplicate"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetupSiteAdmin'
        description: 'setupSiteAdmin'
        required: true
components:
  securitySchemes:
    bearerAuth: # arbitrary name for the security scheme
      type: http
      scheme: bearer
      bearerFormat: JWT    # optional, arbitrary value for documentation purposes
  schemas:
    EnvironmentFeaturesResult:
      properties:
        featureValues:
          type: array
          items:
            $ref: "#/components/schemas/FeatureValue"
        environments:
          type: array
          items:
            $ref: "#/components/schemas/Environment"
        applications:
          type: array
          items:
            $ref: "#/components/schemas/Application"
        features:
          type: array
          items:
            $ref: "#/components/schemas/Feature"
    SearchPersonResult:
      required:
        - max
      properties:
        max:
          type: integer
        people:
          type: array
          description: "This is for backwards compatibility"
          items:
            $ref: "#/components/schemas/Person"
        summarisedPeople:
          type: array
          description: "If we return the new result type, we are returning a summarised person for less data"
          items:
            $ref: "#/components/schemas/SearchPerson"
        outstandingRegistrations:
          type: array
          items:
            $ref: "#/components/schemas/OutstandingRegistration"
    OutstandingRegistration:
      type: object
      required:
        - id
        - token
        - expired
      properties:
        id:
          type: string
          format: uuid
        token:
          type: string
        expired:
          type: boolean
    SetupSiteAdmin:
      required:
        - organizationName
        - portfolio
      properties:
        portfolio:
          type: string
        organizationName:
          type: string
        emailAddress:
          nullable: true
          description: "User's email or blank if using oauth/saml"
          format: email
          type: string
        password:
          nullable: true
          description: "User's password or blank if using oauth/saml"
          type: string
        name:
          nullable: true
          description: "user's name. Will be take from external provider if using oauth/saml"
          type: string
        authProvider:
          nullable: true
          description: "If the site is using external providers, this is the key of the provider chosen. If there is only one, it can be blank."
          type: string
      type: object
    SetupResponse:
      type: object
      required:
        - organization
        - providers
        - providerInfo
        - capabilityInfo
      properties:
        organization:
          $ref: "#/components/schemas/Organization"
        providers:
          type: array
          items:
            type: string
        providerInfo:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/IdentityProviderInfo"
        capabilityInfo:
          additionalProperties:
            type: string
        redirectUrl:
          description: "Set if there is only one external provider and no local. Allows immediate redirect to provider. It assumes it will be used immediate (e.g. state in oauth2 url)"
          type: string
          nullable: true
    IdentityProviderInfo:
      type: object
      required:
        - buttonBackgroundColor
        - buttonIcon
        - buttonText
      properties:
        buttonIcon:
          type: string
        buttonBackgroundColor:
          type: string
        buttonText:
          type: string
    SetupMissingResponse:
      type: object
      properties:
        providers:
          type: array
          items:
            type: string
        capabilityInfo:
          additionalProperties:
            type: string
        providerInfo:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/IdentityProviderInfo"
    ProviderRedirect:
      type: object
      properties:
        redirectUrl:
          type: string
    TokenizedPerson:
      properties:
        accessToken:
          type: string
          nullable: true
        refreshToken:
          type: string
          nullable: true
        redirectUrl:
          type: string
          nullable: true
        capabilityInfo:
          nullable: true
          additionalProperties:
            type: string
        person: # do not include a description or the API changes code generation
          nullable: true
          allOf:
            - $ref: "#/components/schemas/Person"
    RegistrationUrl:
      required:
        - token
        - personId
      properties:
        registrationUrl:
          nullable: true
          type: string
        personId:
          type: string
          format: uuid
        token:
          type: string
    PersonRegistrationDetails:
      required:
        - name
        - email
        - password
        - confirmPassword
        - registrationToken
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
        email:
          type: string
          maxLength: 100
          minLength: 1
          format: email
        password:
          type: string
          maxLength: 40
          minLength: 1
          format: password
        confirmPassword:
          type: string
          maxLength: 40
          minLength: 1
          format: password
        registrationToken:
          type: string
    AdminServiceResetTokenResponse:
      required:
        - token
      properties:
        token:
          type: string
    CreatePersonDetails:
      required:
        - personType
      properties:
        email:
          nullable: true
          description: "Can be null if a service account"
          type: string
          minLength: 1
          maxLength: 100
          format: email
        personType:
          $ref: "#/components/schemas/PersonType"
        name:
          nullable: true
          description: "Can be null if a service account"
          type: string
          minLength: 1
          maxLength: 100
        groupIds:
          nullable: true
          default: []
          type: array
          items:
            type: string
            format: uuid
    UserCredentials:
      required:
        - email
        - password
      properties:
        email:
          type: string
          maxLength: 100
          format: email
        password:
          type: string
          maxLength: 100
    PasswordReset:
      required:
        - password
      properties:
        password:
          type: string
        reactivate:
          default: false
          type: boolean
    PasswordUpdate:
      required:
        - oldPassword
        - newPassword
      properties:
        oldPassword:
          maxLength: 100
          format: password
          type: string
        newPassword:
          maxLength: 100
          format: password
          type: string

    RolloutStrategyValidationRequest:
      type: object
      description: "A collection of strategies to validate together to see if it violates any rules"
      properties:
        customStrategies:
          type: array
          items:
            $ref: "#/components/schemas/RolloutStrategy"
        sharedStrategies:
          type: array
          items:
            $ref: "#/components/schemas/RolloutStrategyInstance"
    CustomRolloutStrategyViolation:
      type: object
      properties:
        strategy:
          $ref: "#/components/schemas/RolloutStrategy"
        violations:
          type: array
          items:
            $ref: "#/components/schemas/RolloutStrategyViolation"
    SharedRolloutStrategyViolation:
      type: object
      properties:
        strategy:
          $ref: "#/components/schemas/RolloutStrategyInstance"
        violation:
          type: array
          items:
            $ref: "#/components/schemas/RolloutStrategyViolation"
    RolloutStrategyValidationResponse:
      type: object
      properties:
        customStategyViolations:
          type: array
          items:
            $ref: "#/components/schemas/CustomRolloutStrategyViolation"
        sharedStrategyViolations:
          type: array
          items:
            $ref: "#/components/schemas/SharedRolloutStrategyViolation"
        violations:
          type: array
          items:
            $ref: "#/components/schemas/RolloutStrategyCollectionViolationType"
    RolloutStrategyViolation:
      type: object
      required:
        - violation
      properties:
        id:
          nullable: true
          description: "The id of the attribute (if any). if none is provided it is a problem with the strategy itself"
          type: string
        violation:
          $ref: "#/components/schemas/RolloutStrategyViolationType"
    RolloutStrategyViolationType:
      type: string
      enum:
        - no_name
        - name_too_long
        - empty_match_criteria
        - negative_percentage
        - percentage_over_100_percent
        - array_attribute_no_values
        - attr_invalid_well_known_enum
        - attr_missing_value
        - attr_missing_conditional
        - attr_missing_field_name
        - attr_missing_field_type
        - attr_val_not_semantic_version
        - attr_val_not_number
        - attr_val_not_date
        - attr_val_not_date_time
        - attr_val_not_cidr
        - attr_unknown_failure
    RolloutStrategyCollectionViolationType:
      type: string
      enum:
        - percentage_adds_over_100_percent
        - boolean_has_no_value
    ResetApiKeyType:
      type: string
      enum:
        - client_eval_only
        - server_eval_only
    FeatureEnvironment:
      properties:
        environment:
          $ref: "#/components/schemas/Environment"
        roles:
          description: "the roles of this person in this environment"
          default: []
          type: array
          items:
            $ref: "#/components/schemas/RoleType"
        featureValue:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/FeatureValue"
        serviceAccounts:
          default: []
          type: array
          items:
            $ref: "#/components/schemas/ServiceAccount"
    ApplicationFeatureValues:
      required:
        - applicationId
        - features
        - environments
        - maxFeatures
      properties:
        applicationId:
          type: string
          format: uuid
        features:
          type: array
          items:
            $ref: "#/components/schemas/Feature"
        environments:
          type: array
          items:
            $ref: "#/components/schemas/EnvironmentFeatureValues"
        maxFeatures:
          type: integer
    EnvironmentFeatureValues:
      properties:
        environmentId:
          type: string
          format: uuid
        environmentName:
          type: string
        priorEnvironmentId:
          nullable: true
          type: string
          format: uuid
        features:
          description: "the values of the features depending on access"
          type: array
          items:
            $ref: "#/components/schemas/FeatureValue"
        roles:
          description: "the roles of this person in this environment"
          type: array
          items:
            $ref: "#/components/schemas/RoleType"
    CreateFeature:
      description: "Only used when creating a new feature"
      required:
        - key
        - name
        - valueType
      properties:
        key:
          type: string
          description: "Unique within this application"
        alias:
          nullable: true
          type: string
          description: "use this in code, as then people cannot guess your new features from their names"
        link:
          nullable: true
          type: string
        name:
          type: string
          description: "description if any"
        valueType:
          $ref: "#/components/schemas/FeatureValueType"
        secret:
          nullable: true
          type: boolean
          description: "should the config remain invisible to users without secret permission"
        description:
          nullable: true
          type: string
          maxLength: 300
        metaData:
          nullable: true
          type: string
          description: "Metadata that may need to be stored. Intended for ADK use. No data limit on FHOS. 10k on SaaS. (stored as CLOB)"
    Feature:
      description: "exists simply to hold the name of the feature as it exists across all environments"
      required:
        - name
      properties:
        id:
          nullable: true
          type: string
          format: uuid
        key:
          type: string
          description: "Unique within this application"
        alias:
          nullable: true
          type: string
          description: "use this in code, as then people cannot guess your new features from their names"
        link:
          nullable: true
          type: string
        name:
          type: string
          description: "description if any"
        valueType:
          $ref: "#/components/schemas/FeatureValueType"
        version:
          description: "used for optimistic locking when renaming a feature"
          type: integer
          format: int64
        whenArchived:
          nullable: true
          type: string
          format: date-time
        secret:
          nullable: true
          type: boolean
          description: "should the config remain invisible to users without secret permission"
        description:
          nullable: true
          type: string
          maxLength: 300
        metaData:
          nullable: true
          type: string
          description: "Metadata that may need to be stored. Intended for ADK use. No data limit on FHOS. 10k on SaaS. (stored as CLOB)"
    FeatureValue:
      required:
        - key
        - locked
      properties:
        id:
          nullable: true
          type: string
          format: uuid
        key:
          type: string
        locked:
          type: boolean
        value:
          description: "Preferred now, please don't use valueX fields"
        valueString:
          deprecated: true
          nullable: true
          description: "default value if no strategy matches. interpreted by type in parent"
          type: string
        valueNumber:
          deprecated: true
          nullable: true
          type: number
        valueBoolean:
          deprecated: true
          nullable: true
          type: boolean
        valueJson:
          deprecated: true
          nullable: true
          type: string
        retired:
          nullable: false
          default: false
          type: boolean
          description: "if false or null, this feature will visible on edge. if true, it will not be passed to the client"
        rolloutStrategyInstances:
          type: array
          nullable: true
          default: []
          items:
            $ref: "#/components/schemas/RolloutStrategyInstance"
        rolloutStrategies:
          description: "These are custom rollout strategies that only apply to this feature value."
          type: array
          nullable: true
          default: []
          items:
            $ref: "#/components/schemas/RolloutStrategy"
        sharedRolloutStrategies:
          description: "This is list is either provided empty (when publishing) or anemic so the MR will client will understand which shared strategies are attached without having to back-call. If provided
                        then it will mirror rolloutStrategyInstances and only enabled ones will be passed back. The value from the rolloutStrategyInstance will be embedded. This field will
                        _always_ be ignored when being sent back to the server, only rolloutStrategyInstances is used."
          type: array
          nullable: true
          default: []
          items:
            $ref: "#/components/schemas/RolloutStrategy"
        featureGroupStrategies:
          nullable: true
          description: "There are strategies provided by feature groups (if any)"
          type: array
          default: []
          items:
            $ref: "#/components/schemas/ThinGroupRolloutStrategy"
        environmentId:
          nullable: true
          type: string
          format: uuid
        version:
          default: 0
          description: "used for optimistic locking. we set it to 0 for the initial version"
          type: integer
          format: int64
        whoUpdated:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/Person"
        whenUpdated:
          nullable: true
          type: string
          format: date-time
        whatUpdated:
          nullable: true
          type: string
    ThinGroupRolloutStrategy:
      type: object
      properties:
        name:
          type: string
        value:
          description: "The value for this strategy, currently always a string"
    RolloutStrategyInstance:
      properties:
        name:
          description: "This is copied from the shared rollout strategy on return, it is read only from the client perspective"
          type: string
        strategyId:
          type: string
          format: uuid
        value:
          nullable: true
          description: "the value for this rollout strategy for this feature value"
        disabled:
          nullable: true
          type: boolean
    Audit:
      properties:
        createdBy:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/Person"
        updatedBy:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/Person"
        whenCreated:
          nullable: true
          type: string
          format: date-time
        whenUpdated:
          nullable: true
          type: string
          format: date-time
    EnvironmentSortOrder:
      type: string
      enum:
        - ASC
        - DESC
        - PRIORITY
    SortOrder:
      type: string
      enum:
        - ASC
        - DESC
    CreatePortfolio:
      type: object
      required:
        - name
        - description
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
        description:
          nullable: true
          type: string
          maxLength: 400
    Portfolio:
      allOf:
        - $ref: "#/components/schemas/Audit"
        - type: object
          required:
            - name
            - id
            - version
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              minLength: 1
              maxLength: 200
            description:
              nullable: true
              type: string
              maxLength: 400
            version:
              type: integer
              format: int64
            organizationId:
              nullable: true
              type: string
              format: uuid
            groups:
              type: array
              default: []
              items:
                $ref: "#/components/schemas/Group"
            applications:
              type: array
              default: []
              items:
                $ref: "#/components/schemas/Application"
            whenArchived:
              nullable: true
              type: string
              format: date-time
    ApplicationSummary:
      type: object
      required:
        - groupsHavePermission
        - serviceAccountsHavePermission
        - featureCount
        - environmentCount
      properties:
        groupsHavePermission:
          type: boolean
        serviceAccountsHavePermission:
          type: boolean
        featureCount:
          type: integer
        environmentCount:
          type: integer
    CreateApplication:
      type: object
      required:
        - name
        - description
      properties:
        name:
          type: string
          maxLength: 100
        description:
          type: string
          maxLength: 400
    Application:
      allOf:
        - $ref: "#/components/schemas/Audit"
        - type: object
          required:
            - name
            - id
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              maxLength: 100
            description:
              nullable: true
              type: string
              maxLength: 400
            portfolioId:
              nullable: true
              type: string
              format: uuid
            version:
              type: integer
              format: int64
            groups:
              default: []
              type: array
              items:
                $ref: "#/components/schemas/Group"
            features:
              type: array
              default: []
              items:
                $ref: "#/components/schemas/Feature"
            environments:
              type: array
              default: []
              items:
                $ref: "#/components/schemas/Environment"
            whenArchived:
              nullable: true
              type: string
              format: date-time
    UpdatePerson:
      type: object
      required:
        - version
      properties:
        name:
          nullable: true
          type: string
          minLength: 1
          maxLength: 150
        email:
          nullable: true
          type: string
          format: email
          maxLength: 100
        version:
          description: "This keeps track of which person version we are updating in case the user tries to update an old record"
          type: integer
          format: int64
        groups:
          nullable: true
          type: array
          items:
            type: string
            format: uuid
        unarchive:
          nullable: true
          type: boolean
    Person:
      type: object
      properties:
        id:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/PersonId"
        name:
          type: string
          minLength: 1
          maxLength: 150
          nullable: true
        email:
          type: string
          format: email
          maxLength: 100
          nullable: true
        personType:
          nullable: true
          allOf:
            - $ref: "#/components/schemas/PersonType"
        other:
          nullable: true
          type: string
        source:
          nullable: true
          type: string
        version:
          nullable: true
          type: integer
          format: int64
        passwordRequiresReset:
          nullable: true
          type: boolean
        groups:
          nullable: false
          default: []
          type: array
          items:
            $ref: "#/components/schemas/Group"
        whenArchived:
          nullable: true
          type: string
          format: date-time
        whenLastAuthenticated:
          nullable: true
          description: "This is the timestamp in UTC when they last logged into the system"
          type: string
          format: date-time
        whenLastSeen:
          nullable: true
          description: "This is the timestamp in UTC when they last made a request to the system on their most recent login. If it is null it means they have no current token or have never logged in."
          type: string
          format: date-time
        additional:
          nullable: true
          type: array
          default: []
          items:
            $ref: "#/components/schemas/PersonInfo"
    SearchPersonSortBy:
      type: string
      enum:
        - name
        - activationStatus
    SearchPerson:
      type: object
      required:
        - groupCount
        - name
        - email
        - personType
        - id
        - version
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type: string
          format: email
        version:
          type: integer
          format: int64
        personType:
          $ref: "#/components/schemas/PersonType"
        whenLastAuthenticated:
          nullable: true
          description: "This is the timestamp in UTC when they last logged into the system"
          type: string
          format: date-time
        whenLastSeen:
          description: "This is the timestamp in UTC when they last made a request to the system on their most recent login. If it is null it means they have no current token or have never logged in."
          type: string
          format: date-time
          nullable: true
        whenDeactivated:
          nullable: true
          description: "When a person's account was deactivated (if it was) and when"
          type: string
          format: date-time
        groupCount:
          type: integer
    PersonInfo:
      type: object
      required:
        - key
        - value
      properties:
        key:
          description: "e.g. serviceAccountId"
          type: string
        value:
          type: string
    PersonType:
      type: string
      default: person
      enum:
        - person
        - serviceAccount
        - sdkServiceAccount
    PersonId:
      required:
        - id
      properties:
        id:
          type: string
          format: uuid
    ApplicationPermissions:
      type: object
      required:
        - applicationRoles
        - environments
      properties:
        applicationRoles:
          type: array
          items:
            $ref: "#/components/schemas/ApplicationRoleType"
        environments:
          type: array
          items:
            $ref: "#/components/schemas/EnvironmentPermission"
    EnvironmentPermission:
      type: object
      required:
        - id
        - name
        - roles
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        roles:
          type: array
          items:
            $ref: "#/components/schemas/RoleType"
    CreateEnvironment:
      type: object
      required:
        - name
        - description
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 150
        priorEnvironmentId:
          type: string
          format: uuid
          nullable: true
        description:
          type: string
          maxLength: 400
        environmentInfo:
          nullable: true
          additionalProperties:
            type: string
        production:
          default: false
          description: "is this a production environment?"
          type: boolean

    Environment:
      allOf:
        - $ref: "#/components/schemas/Audit"
        - type: object
          required:
            - name
            - id
          properties:
            id:
              type: string
              format: uuid
            applicationId:
              type: string
              format: uuid
            name:
              type: string
              minLength: 1
              maxLength: 150
            priorEnvironmentId:
              type: string
              format: uuid
              nullable: true
            version:
              type: integer
              format: int64
            description:
              nullable: true
              type: string
              maxLength: 400
            production:
              nullable: true
              description: "is this a production environment?"
              type: boolean
            groupRoles:
              nullable: true
              type: array
              default: []
              items:
                $ref: "#/components/schemas/EnvironmentGroupRole"
            features:
              nullable: true
              type: array
              default: []
              items:
                $ref: "#/components/schemas/Feature"
            environmentInfo:
              nullable: true
              default: {}
              additionalProperties:
                type: string
            webhookEnvironmentInfo:
              nullable: true
              additionalProperties:
                type: string
            serviceAccountPermission:
              nullable: true
              type: array
              items:
                $ref: "#/components/schemas/ServiceAccountPermission"
            whenArchived:
              nullable: true
              type: string
              format: date-time
    UpdateEnvironmentV2:
      allOf:
        - $ref: "#/components/schemas/UpdateEnvironment"
        - type: object
          properties:
            id:
              type: string
              format: uuid
          required:
            - id
    UpdateEnvironment:
      type: object
      required:
        - version
      properties:
        version:
          description: "Version of the record, included for attempting to update out of date records"
          type: integer
          format: int64
        name:
          type: string
          minLength: 1
          maxLength: 150
          nullable: true
        description:
          type: string
          maxLength: 400
          nullable: true
        production:
          description: "is this a production environment?"
          nullable: true
          type: boolean
        environmentInfo:
          nullable: true
          description: "Allows some settings that affect the behaviour of this environment. Currently `cacheControl` if set will be passed and set on the responses to GET requests."
          additionalProperties:
            type: string
        webhookEnvironmentInfo:
          nullable: true
          description: "Environment webhook url and headers"
          additionalProperties:
            type: string
        priorEnvironmentId:
          nullable: true
          type: string
          format: uuid
    CreateServiceAccount:
      required:
        - name
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 70
        description:
          nullable: true
          type: string
          maxLength: 400
        permissions:
          type: array
          default: []
          items:
            $ref: "#/components/schemas/ServiceAccountPermission"
    ServiceAccount:
      required:
        - name
        - id
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
          maxLength: 70
        portfolioId:
          nullable: true
          type: string
          format: uuid
        description:
          nullable: true
          type: string
          maxLength: 400
        version:
          nullable: true
          type: integer
          format: int64
        apiKeyClientSide:
          nullable: true
          type: string
          description: "this is a read only field, it denotes an api key where the eval is done client side"
          maxLength: 400
        apiKeyServerSide:
          nullable: true
          type: string
          description: "this is a read only field, it denotes an api key where the eval is done server side"
          maxLength: 400
        permissions:
          type: array
          default: []
          items:
            $ref: "#/components/schemas/ServiceAccountPermission"
        whenArchived:
          nullable: true
          type: string
          format: date-time
    ServiceAccountPermission:
      description: "this represents a specific set of permissions for a SDK service account in an environment"
      required:
        - permissions
        - environmentId
      properties:
        id:
          nullable: true
          type: string
          format: uuid
        permissions:
          type: array
          default: []
          items:
            $ref: "#/components/schemas/RoleType"
        serviceAccount:
          #description: "The service account associated with this permission. Only filled in when coming from Environment"
          nullable: true
          allOf:
            - $ref: "#/components/schemas/ServiceAccount"
        environmentId:
          type: string
          format: uuid
        sdkUrlClientEval:
          description: "Optional if they have chosen includeSdkUrl"
          type: string
          nullable: true
        sdkUrlServerEval:
          description: "Optional if they have chosen includeSdkUrl"
          type: string
          nullable: true
    CacheRefreshRequest:
      type: object
      properties:
        allTheThings:
          nullable: true
          description: "refresh the whole cache"
          type: boolean
        applicationId:
          nullable: true
          description: "if provided these applications will be refreshed"
          type: array
          items:
            type: string
            format: uuid
        portfolioId:
          nullable: true
          type: array
          items:
            type: string
            format: uuid
    CacheRefreshResponse:
      type: object
      properties:
        applicationsRefreshed:
          nullable: true
          type: integer
        portfoliosRefreshed:
          nullable: true
          type: integer
        environmentsRefreshed:
          nullable: true
          type: integer
        serviceAccountsRefreshed:
          nullable: true
          type: integer
    CreateGroup:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        admin:
          nullable: true
          description: "is this an admin group?"
          type: boolean
        applicationRoles:
          nullable: true
          type: array
          default: []
          items:
            $ref: "#/components/schemas/ApplicationGroupRole"
    Group:
      allOf:
        - $ref: "#/components/schemas/Audit"
        - type: object
          required:
            - name
            - id
          properties:
            id:
              type: string
              format: uuid
            admin:
              nullable: true
              description: "is this an admin group?"
              type: boolean
            portfolioId:
              nullable: true
              description: "The portfolio this group belongs to, unless it is the superuser group when it does not belong to one (null)"
              type: string
              format: uuid
            organizationId:
              nullable: true
              description: "this will be the organisation this group belongs to at the top level, or if a portfolio group, the organisation of the portfolio"
              type: string
              format: uuid
            version:
              type: integer
              format: int64
            name:
              type: string
              minLength: 1
              maxLength: 255
            members:
              type: array
              default: []
              items:
                $ref: "#/components/schemas/Person"
            applicationRoles:
              type: array
              default: []
              items:
                $ref: "#/components/schemas/ApplicationGroupRole"
            environmentRoles:
              type: array
              default: []
              items:
                $ref: "#/components/schemas/EnvironmentGroupRole"
            whenArchived:
              nullable: true
              type: string
              format: date-time
    ApplicationGroupRole:
      required:
        - applicationId
        - groupId
        - roles
      properties:
        applicationId:
          type: string
          format: uuid
        groupId:
          type: string
          format: uuid
        roles:
          type: array
          items:
            $ref: "#/components/schemas/ApplicationRoleType"
    ApplicationRoleType:
      type: string
      # FEATURE_EDIT is actually a CRUD role, people asked for the role to be separated into two
      # FEATURE_CREATE is CR - Create and Read
      # FEATURE_EDIT_AND_DELETE is RUD - FEATURE_CREATE + FEATURE_EDIT_AND_DELETE == FEATURE_EDIT
      # eventually FEATURE_EDIT will go away and this transition will start to occur in future versions
      enum:
        - FEATURE_EDIT
        - FEATURE_CREATE
        - FEATURE_EDIT_AND_DELETE
    EnvironmentGroupRole:
      required:
        - environmentId
        - groupId
        - roles
      properties:
        environmentId:
          type: string
          format: uuid
        groupId:
          type: string
          format: uuid
        roles:
          type: array
          items:
            $ref: "#/components/schemas/RoleType"
    Organization:
      allOf:
        - $ref: "#/components/schemas/Audit"
        - type: object
          required:
            - name
          properties:
            id:
              type: string
              format: uuid
            version:
              nullable: true
              type: integer
              format: int64
            name:
              type: string
              minLength: 1
              maxLength: 255
            admin:
              nullable: true
              deprecated: true
              description: "ignored"
              type: boolean
            authorizationUrl:
              nullable: true
              description: "If provided, the browser should redirect to this URL to authenticate"
              type: string
            orgGroup:
              nullable: true
              allOf:
                - $ref: "#/components/schemas/Group"
            portfolios:
              nullable: true
              default: []
              type: array
              items:
                $ref: "#/components/schemas/Portfolio"
            whenArchived:
              nullable: true
              type: string
              format: date-time
    CreateRolloutStrategy:
      type: object
      description: "This is used by Shared Strategies to create new strategies"
      properties:
        name:
          description: "names are unique in a case insensitive fashion"
          type: string
          # validator is checking this
        #          maxLength: 100
        colouring:
          nullable: true
          description: "the colour used to display the strategy in the UI. indexed table of background/foreground combos."
          type: integer
        avatar:
          nullable: true
          type: string
          description: "url to avatar (if any). Not sent to SDK. Preferably a unicorn."
          maxLength: 200
        attributes:
          nullable: true
          default: []
          type: array
          items:
            $ref: "#/components/schemas/RolloutStrategyAttribute"
    RolloutStrategy:
      allOf:
        - $ref: "#/components/schemas/BaseUIStrategy"
        - $ref: "#/components/schemas/BaseRolloutStrategy"
        - type: object
          properties:
            id:
              description: "the server will accept null ids but it won't ever store them as null"
              type: string
              nullable: true
    AnemicPerson:
      type: object
      required:
        - id
        - name
        - type
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type: string
          nullable: true
        type:
          $ref: "#/components/schemas/PersonType"