What are data resources, lifecycle and publication flow

Summary

The platform's data resources are those that allow data to be collected, transform and expose data. The platform has three data resources: Data sources, Data views and APIs.

Data sources: using data sources could connect to my data sources: from files uploaded to the platform to database connections, whether reading or writing.

Data views: data views allow for changes to the data obtained from the source. A data source can have multiple views with different settings. The data views are an abstraction of the source format: regardless of the origin of the data, they will be tabulated and shown in a table so that they can then exposed in an API methods.

APIs: APIs allow you to compose, configure and publish APIs, manage versions, methods, access and much more.

Life cycle and publication flow

All data resources have a lifecycle and an associated publication flow.

By lifecycle we refer to the process of creating, editing, submitting, accepting, rejecting, publishing and deleting a resource. The lifecycle is associated with resource states that relate to user roles. The states are in draft, in revision, accepted, rejected and published, while the user roles correspond to the actions of a Publisher or Editor.

In addition, resources have a hierarchical relationship. From a data source, one or more data views can be created. API method exposes data from a data view.

The following diagram represents the publication flow of the Publisher (or Administrator) role. When creating a new resource, it remains in draft until it is published.

When editing a published resource, a new draft revision is generated, which should be published to impact the production environment.

The following diagram represents the flow of publication considering the Editor and Publisher role.

When you create a new resource, it starts in a draft state. The Editor user must send the resource to review, and a Publisher should accept or reject the resource.

In both cases, whether you accept or reject the appeal, it would remain in draft. If rejected it should be reissued. If accepted, the Publisher user could publish the resource.