The Overview page gives you key details about your API, helping users understand what it does and how it’s configured. It includes:
- API name, description and version
- Visibility setting
- Version scheme information
- Schema setting
- Release information
- Published version and status
- Subscription information
By default, all APIs added to a workspace and published to the DEP Find and Use an API Catalogue are set to Private. If you want your API to be visible to all users, you’ll need to change its visibility setting to Public. You can update visibility settings from the API’s detail page by selecting Change next to the visibility option.
What you can do on the Overview page
You can:
- Adding a Hosted API to a workspace
- Changing the name of a workspace Hosted API
- Changing the description of a workspace Hosted API
- Changing the visibility of a workspace Hosted API
- Changing the schema for a workspace Hosted API
- Viewing the schema file for a workspace Hosted API
- Preview changes of a schema upload to a workspace Hosted API
- Downloading the schema file for a workspace Hosted API
- Removing a Hosted API from a workspace