github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/projects/create.yaml (about)

     1  ---
     2  summary: Create a project
     3  description: Create a new project.
     4  operationId: project/create
     5  tags:
     6    - Projects
     7  parameters:
     8    - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  responses:
    10    "201":
    11      description: Created
    12      content:
    13        application/json:
    14          schema:
    15            "$ref": "../../schemas/project_details.yaml#/project_details"
    16      headers:
    17        X-Rate-Limit-Limit:
    18          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    19        X-Rate-Limit-Remaining:
    20          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    21        X-Rate-Limit-Reset:
    22          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    23    "400":
    24      "$ref": "../../responses.yaml#/400"
    25    "404":
    26      "$ref": "../../responses.yaml#/404"
    27    "429":
    28      "$ref": "../../responses.yaml#/429"
    29  x-code-samples:
    30    - lang: Curl
    31      source: |-
    32        curl "https://api.phrase.com/v2/projects" \
    33          -u USERNAME_OR_ACCESS_TOKEN \
    34          -X POST \
    35          -F name=My%20Android%20Project \
    36          -F main_format=yml \
    37          -F shares_translation_memory=true
    38    - lang: CLI v2
    39      source: |-
    40        phrase projects create \
    41        --data '{"name": "My Android Project", "main_format":"yml", "shares_translation_memory":"true"}' \
    42        --access_token <token>
    43  requestBody:
    44    required: true
    45    content:
    46      application/json:
    47        schema:
    48          type: object
    49          title: project/create/parameters
    50          required:
    51            - name
    52          properties:
    53            name:
    54              description: Name of the project
    55              type: string
    56              example: My Android Project
    57            main_format:
    58              description: Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href="https://support.phrase.com/hc/en-us/sections/6111343326364">Format Guide</a> or our <a href="#formats">Formats API Endpoint</a>.
    59              type: string
    60              example: yml
    61            media:
    62              description: "(Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include:
    63                `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`,
    64                `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value."
    65              type: string
    66              example: Python
    67            shares_translation_memory:
    68              description: Indicates whether the project should share the account's translation memory
    69              type: boolean
    70              example: true
    71            project_image:
    72              description: Image to identify the project
    73              type: string
    74              format: binary
    75              example: "/path/to/my/project-screenshot.png"
    76            remove_project_image:
    77              description: Indicates whether the project image should be deleted.
    78              type: boolean
    79              example:
    80            account_id:
    81              description: Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
    82              type: string
    83              example: abcd1234
    84            point_of_contact:
    85              description:  (Optional) User ID of the point of contact for the project.
    86              type: string
    87              example: abcd1234
    88            source_project_id:
    89              description: When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params.
    90              type: string
    91              example: abcd1234
    92            workflow:
    93              description: (Optional) Review Workflow. "simple" / "review". <a href="https://support.phrase.com/hc/en-us/articles/5784094755484">Read more</a>
    94              type: string
    95              example: review
    96            machine_translation_enabled:
    97              description: "(Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest"
    98              type: boolean
    99              example: true
   100            enable_branching:
   101              description: "(Optional) Enable branching in the project"
   102              type: boolean
   103              example: true
   104            protect_master_branch:
   105              description: "(Optional) Protect the master branch in project where branching is enabled"
   106              type: boolean
   107              example: true
   108            enable_all_data_type_translation_keys_for_translators:
   109              description: "(Optional) Otherwise, translators are not allowed to edit translations other than strings"
   110              type: boolean
   111              example: true
   112            enable_icu_message_format:
   113              description: (Optional) We can validate and highlight your ICU messages. <a href="https://support.phrase.com/hc/en-us/articles/5822319545116">Read more</a>
   114              type: boolean
   115              example: true
   116            zero_plural_form_enabled:
   117              description: "(Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly."
   118              type: boolean
   119              example: true
   120            autotranslate_enabled:
   121              description: (Optional) Autopilot, requires machine_translation_enabled. <a href="https://support.phrase.com/hc/en-us/articles/5822187934364">Read more</a>
   122              type: boolean
   123              example: true
   124            autotranslate_check_new_translation_keys:
   125              description: "(Optional) Requires autotranslate_enabled to be true"
   126              type: boolean
   127              example: true
   128            autotranslate_check_new_uploads:
   129              description: "(Optional) Requires autotranslate_enabled to be true"
   130              type: boolean
   131              example: true
   132            autotranslate_check_new_locales:
   133              description: "(Optional) Requires autotranslate_enabled to be true"
   134              type: boolean
   135              example: true
   136            autotranslate_mark_as_unverified:
   137              description: "(Optional) Requires autotranslate_enabled to be true"
   138              type: boolean
   139              example: true
   140            autotranslate_use_machine_translation:
   141              description: "(Optional) Requires autotranslate_enabled to be true"
   142              type: boolean
   143              example: true
   144            autotranslate_use_translation_memory:
   145              description: "(Optional) Requires autotranslate_enabled to be true"
   146              type: boolean
   147              example: true
   148            smart_suggest_enabled:
   149              description: "(Optional) Smart Suggest, requires machine_translation_enabled"
   150              type: boolean
   151              example: true
   152            smart_suggest_use_glossary:
   153              description: "(Optional) Requires smart_suggest_enabled to be true"
   154              type: boolean
   155              example: true
   156            smart_suggest_use_machine_translation:
   157              description: "(Optional) Requires smart_suggest_enabled to be true"
   158              type: boolean
   159              example: true
   160  x-cli-version: "2.6.3"