Design API backend schema

[bajiat]

In order to decouple API backends from Api Umbrella, we will need a collection for API backend that is separate from the proxy settings. In other words, the schema needs to be changed and separated from proxies and their settings.

Idea: Align with Swagger specification or Open API specification (depending on the schedule of the latter). This might enable importing API backend configuration by importing Swagger (or Open API) file. Only after adding the API backend, the owner would assign a proxy to it.

Potential user story related to the Swagger idea:

As an API owner
I want to add my API by importing a Swagger file
so that I can reuse my Swagger file and do not need to type in the API details

As a minimum requirement, all fields that exist both in our collection and in Swagger spec should match.

Definition of done

• Api Backend schema exists
• Api Backend does not contain API Umbrella related settings
• When applicable, schema field(s) confirm to Swagger / Open API specification

[brylie]

After initial discussion, we agreed to rename the ApiBackends collection to Apis, and set up the following schema:

# Apis
- name
- Description
- isPublic
- backendUrl
- version
- managerIds
- averageRating
- bookmarkCount
- created_at
- created_by
- updated_at
- updated_by
- proxyId

[jykae]

I think we need also these:

documentationFileId: {
    type: String,
    optional: true
  },
  apiLogoFileId: {
    type: String,
    optional: true
  },
  documentation_link: {
    type: String,
    optional: true,
    regEx: SimpleSchema.RegEx.Url
  }

[brylie]

Jep, those fields are in the work-in-progress branch.

[brylie]

As part of this task, I have been removing a bit of code related to the following components:

• API Umbrella
• Add API wizard
• Initial setup wizard

We can re-introduce API Umbrella code at a later point, but both of the wizards were deemed unnecessary for the time being (after discussions at standup and with @bajiat). As such, I am designing a modal dialogue to inform admin users when either the Branding or Settings collection are empty, so they know to visit those pages (ping @Nazarah):