-
Bug
-
Resolution: Unresolved
-
Major
-
2.13.0 GA
-
3
-
https://gitlab.cee.redhat.com/red-hat-3scale-documentation/3scale-documentation/-/merge_requests/1403, https://gitlab.cee.redhat.com/red-hat-3scale-documentation/3scale-documentation/-/merge_requests/1639, https://gitlab.cee.redhat.com/red-hat-3scale-documentation/3scale-documentation/-/merge_requests/1650
-
API CCS Sprint 36 (3Scale), API CCS Sprint 44 (3Scale) 2
Currently there is no documentation describing the limitations for any custom keys that can be created by API.
Examples: app_id, app_key, user_key.
In the admin portal UI there is a note when creating a custom key that states the following:
Only alphanumeric characters [0-9, a-z, A-Z], hyphen-minus ,
between 5 and 256 characters long. No spaces allowed.
This accounts for the app_key & client_secret but when creating a new key or even a new application plus keys on the 3scale API there needs to be clearer documentation stating what is/isn't allowed.
Important: This also needs to be added to the ActiveDocs.
Note: Documentation was improved for 2.14 and 2.13, we need to extend definition based on changes for 2.15
- clones
-
THREESCALE-924 Provide clear documentation on allowed characters and limitations for custom keys
- Closed
- relates to
-
THREESCALE-9188 Explain restrictions for allowed characters and limitations for custom keys while creating API Docs (ActiveDocs)
- Closed
- links to