Edit general information about your API version and define its media
types, endpoints and security schemes.
Procedure
Access the general information page.
This page opens automatically after creating your API. You can also open it by clicking the name of your API at the top of the left panel.
Click pencil icon to
the left of the GENERAL section to edit
the version, the description, the contact and license information and the terms
of service for your API.
Information noteNote: The name of your API can be changed from the Talend Cloud API Designer homepage. For more
information, see Renaming an API.
Edit the MEDIA TYPES section to add or remove media types.
The media types defined in this
section are global, they are applied to the whole API version. They can also be
defined at the operation level.
Add your endpoint(s) in the ENDPOINTS section.
The endpoints defined in this section
are global, they are applied to the whole API version. Once they are defined, your
endpoints appear below the name of your API in the top of the left panel, along with
the mock endpoint if it is enabled.
Published endpoints are visible in the live
documentation and in the portal. The first published endpoint is also used when
trying the API in Talend Cloud API Tester. For more information, see Trying your API in Talend Cloud API Tester. Endpoints that are
not published are only visible in Talend Cloud API Designer.
Information noteNote: If you have several endpoints, the first one in the list is used by default when
you try your API in Talend Cloud API Tester. You can move an endpoint in the list by clicking the bar to the left of the
URL and dragging it up or down.
Define the security for the API in the GLOBAL SECURITY and SECURITY SCHEMES sections.
The security defined in this
section is global, it is applied to the entire API version. It can also be
defined at the resource and operation levels.
Click Save.
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!