Skip to content

Commit c1309f5

Browse files
authored
Update importing-content.md
Correct typos and English grammatical or syntactical errors. Signed-off-by: Yacine Kheddache <yacine@microcks.io>
1 parent 1ac535b commit c1309f5

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

content/documentation/guides/usage/importing-content.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ The simplest and fastest way to add new Services or API mocks is to use the UI Q
2929
3030
After choosing your artifacts, click the green `Upload` button to send them to Microcks. Notification messages will appear in the top-right corner to inform you of the process. Newly discovered Services and APIs can be found in the **APIs | Services** repository.
3131

32-
While this method is very convenient for a quick test, you'll have to re-import your artifact file on every new change. To watch the changes of local files you can check out the [Microcks CLI Import](https://github.com/microcks/microcks-cli/blob/master/documentation/cmd/import.md)
32+
While this method is very convenient for a quick test, you'll have to re-import your artifact file on every new change. To watch the changes of local files, you can check out the [Microcks CLI Import](https://github.com/microcks/microcks-cli/blob/master/documentation/cmd/import.md)
3333

3434
### Via the API
3535

36-
The same thing can be done via Microcks' own API. Be sure to start reading the [Connecting to Microcks API](/documentation/guides/automation/api) guide first, and to retrieve a `token` by running the authentication flow. The *Service Account* you use for this operation is required to have the `manager` role, which is not the case with the default one, as explained in [Inspecting default Service Account](/documentation/explanations/service-account/#inspecting-default-service-account).
36+
The same thing can be done via Microcks' own API. Be sure to start by reading the [Connecting to Microcks API](/documentation/guides/automation/api) guide, and to retrieve a `token` by running the authentication flow. The *Service Account* you use for this operation is required to have the `manager` role, which is not the case with the default one, as explained in [Inspecting default Service Account](/documentation/explanations/service-account/#inspecting-default-service-account).
3737

3838
Once you have the `$TOKEN` issued for the correct account, uploading a new Artifact is just a matter of executing this `curl` command:
3939

@@ -44,20 +44,20 @@ curl 'https://microcks.example.com/api/artifact/upload?mainArtifact=true' -H "Au
4444

4545
### Configure dependency resolution
4646

47-
Direct upload is straightforward and quick to realize, but comes with one caveat: it does not allow you to automatically resolve dependencies. For example, if your artifact file uses external references with relative paths, Microcks is not able to resolve these external references by default.
47+
Direct upload is straightforward and quick to implement, but it has one caveat: it does not automatically resolve dependencies. For example, if your artifact file uses external references with relative paths, Microcks cannot resolve them by default.
4848

4949
As a workaround to this limitation, and since Microcks `1.10.1`, we introduced a new `default-artifacts-repository.url` property that takes the value of `DEFAULT_ARTIFACTS_REPOSITORY_URL` environment variable when defined. It can be set to either an HTTP endpoint (starting with `http[s]://`) or a file endpoint (starting with `file://`). This default repository for artifacts will be used as the default location for Microcks to resolve relative dependencies.
5050

5151
```properties
5252
default-artifacts-repository.url=${DEFAULT_ARTIFACTS_REPOSITORY_URL:#{null}}
5353
```
5454

55-
> 💡 For local development purposes, this is super convenient to use a very small HTTP server running on your laptop or a common folder mounted into Microcks container as the default artifacts repository.
55+
> 💡 For local development, it is super convenient to use a very small HTTP server running on your laptop or a common folder mounted into the Microcks container as the default artifacts repository.
5656
5757

5858
## 2. Import content via Importer
5959

60-
Another way of adding new Services or APIs mocks is by scheduling an **Importer Job** into Microcks. We think it's actually the best way to achieve continuous, iterative and incremental discovery of your Services and APIs. The principle is very simple: you save your artifact file into the Git repository of your choice (public or private), and Microcks will take care of periodically checking if changes have been applied and new mock or service definitions are present in your artifact. The nice thing about using Importer is that external files referenced in the target artifact will be automatically resolved for you.
60+
Another way to add new Services or API mocks is to schedule an **Importer Job** in Microcks. We think it's actually the best way to achieve continuous, iterative and incremental discovery of your Services and APIs. The principle is very simple: you save your artifact file to the Git repository of your choice (public or private), and Microcks will periodically check whether changes have been applied and whether new mock or service definitions are present in your artifact. The nice thing about using Importer is that external files referenced in the target artifact will be automatically resolved for you.
6161

6262
<div align="center">
6363
{{< figure src="images/documentation/artifacts-scheduling.png" width="80%" >}}
@@ -71,15 +71,15 @@ Still from the left vertical navigation bar, just select the **Importers** menu
7171

7272
You may declare a new Importer job by hitting the `Create` button.
7373

74-
A wizard modal then appears, as creating an Importer is a three-step process. The first step concerns mandatory basic properties such as the name of your Importer and the repository URL it will use to check for discovering API mocks.
74+
A wizard modal then appears, as creating an Importer is a three-step process. The first step concerns mandatory basic properties, such as your Importer's name and the repository URL it will use to discover API mocks.
7575

7676
<div align="center">
7777
{{< figure src="images/importer-step1.png" width="90%" >}}
7878
</div>
7979

8080
> 💡 You can also specify whether this artifact should be considered as `primary` or `secondary` per the [Multi Artifacts support](/documentation/explanations/multi-artifacts). In the case of a `secondary` artifact, you may check the *Just merge examples into existing API | Service definition* box.
8181
82-
The second step concerns authentication options for accessing the repository. Depending on the type of repository (public or private), you may need to enable/disable certificate validation and manage an authentication process through the usage of a **Secret**. For more info, check the guide on [External Secrets](/documentation/guides/administration/secrets).
82+
The second step concerns authentication options for accessing the repository. Depending on the type of repository (public or private), you may need to enable/disable certificate validation and manage authentication using a **Secret**. For more info, check the [External Secrets](/documentation/guides/administration/secrets) guide.
8383

8484
<div align="center">
8585
{{< figure src="images/importer-step2.png" width="90%" >}}
@@ -98,8 +98,8 @@ At creation time, the importer job is automatically `Scanned` and `Imported`.
9898
Once created, importer jobs can be managed, activated or forced through this screen. You'll see a colored marker for each job line:
9999

100100
* `Scanned` means that the job is actually scheduled for the next importation run. Otherwise, `Inactive` will be displayed.
101-
* `Imported` means that the job has been successfully imported on a previous run. Otherwise, `Last import errors` will be displayed with a popup showing the last error,
102-
* `Services` is a shortcut to access the services definitions discovered by this job.
101+
* `Imported` means that the job has been successfully imported on a previous run. Otherwise, `Last import errors` will be displayed with a pop-up showing the last error,
102+
* `Services` is a shortcut to access the service definitions discovered by this job.
103103

104104
Using the 3-dotted menu, you can easily enable/disable or force the job.
105105

@@ -117,12 +117,12 @@ services.update.interval=${SERVICES_UPDATE_INTERVAL:0 0 0/2 * * *}
117117

118118
## Wrap-up
119119

120-
Importing new content into Microcks can be done in several ways: UI, CLI or API.
120+
Importing new content into Microcks can be done in several ways: via the UI, the CLI, or the API.
121121

122122
While pushing local content is very convenient for immediate definition and local development updates, setting up an importer job is the best way to achieve continuous, iterative and incremental discovery of your Services and APIs.
123123

124-
Making Microcks pull your artifacts also allows advanced resolution of dependencies, which can be mandatory when your OpenAPI or AsyncAPI artifacts are using `$ref`.
124+
Making Microcks pull your artifacts also enables advanced dependency resolution, which can be mandatory when your OpenAPI or AsyncAPI artifacts use `$ref`.
125125

126-
As an import can be scheduled and can take a *little* time, it is done asynchronously regarding the human interaction that has triggered it. We choose not to have a blocking process for error management: Microcks importers will try to discover and import services, but will die silently in case of any failure. We also think that this also promotes an iterative and incremental way of working: you know that your job will gracefully fail if your new samples are not yet complete.
126+
Since an import can be scheduled and may take a *little* time, it is done asynchronously with respect to the human interaction that triggered it. We choose not to use a blocking process for error management: Microcks importers will try to discover and import services, but will die silently in the event of any failure. We also think this promotes an iterative, incremental way of working: you know your job will gracefully fail if your new samples are not yet complete.
127127

128128
Some of the error messages will be reported through the `Last import errors` status, but some will not... To help you in checking your artifacts for compliance with recommended practices and conventions, we're developing the [Microcks Linter Ruleset](https://github.com/microcks/microcks-spectral-ruleset).

0 commit comments

Comments
 (0)