GRgravitee-io
Dictionaries

Create or update Dictionaries from Dictionaries Spec

Changed on

Create/update Dictionaries from Dictionaries Spec

put/organizations/{orgId}/environments/{envId}/dictionaries

Request

  • Base URL
    https://eu.cloudgate.gravitee.io/apim/automation
  • URL
    https://eu.cloudgate.gravitee.io/apim/automation/organizations/{orgId}/environments/{envId}/dictionaries
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or HTTP bearer

Path parameters

orgIdstring required
Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required
Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

Query parameters

dryRunboolean
Example:true

For modifying requests, this parameter allow you to test the result of an endpoint without actually persisting the state of the underlying spec.

Request body

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the dictionary

deployedboolean required

If true, a MANUAL type dictionary is deployed in the gateway, a DYNAMIC type dictionary is started. Changing this value back to false will stop the dictionary or undeploy it.

descriptionstring

Detailed description of the dictionary

type'MANUAL' | 'DYNAMIC' required

Type of dictionary. MANUAL is to be updated manually, DYNAMIC is updated and deployed automatically.

Example request

{
  "hrid": "demo_api"
}

Response

State of the successfully created/updated Dictionary

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the dictionary

deployedboolean required

If true, a MANUAL type dictionary is deployed in the gateway, a DYNAMIC type dictionary is started. Changing this value back to false will stop the dictionary or undeploy it.

descriptionstring

Detailed description of the dictionary

type'MANUAL' | 'DYNAMIC' required

Type of dictionary. MANUAL is to be updated manually, DYNAMIC is updated and deployed automatically.

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

Example response

{
  "hrid": "demo_api"
}

Changes

  • 460368511daeRevision changes
    • breaking

      the request property type changed from no type to object

    • breaking

      the response property ///// became optional for the status

    • breaking

      the //// response's property type changed from no type to object for status

    • warning

      changed the pattern of the request property from ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the request property / became optional

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      the //// response's property pattern was changed from ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$ for the status

  • ecefec7d65f9Revision changes
    • breaking

      the request property / became required

    • breaking

      the request property type changed from object to no type

    • breaking

      the //// response's property type changed from object to no type for status

    • warning

      changed the pattern of the request property from ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      the response property ///// became required for the status

    • info

      the //// response's property pattern was changed from ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$ for the status