Skip to content
This repository has been archived by the owner on Mar 6, 2020. It is now read-only.

Commit

Permalink
fixed links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
musketyr committed Feb 5, 2020
1 parent 810c1f0 commit 992ebec
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 35 deletions.
30 changes: 15 additions & 15 deletions docs/guide/src/docs/asciidoc/dynamodb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -377,9 +377,9 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-dynamodb/src/test/groovy/com/a
----
<1> `Builders` class provides all necessary factory methods and keywords
<2> Annotate an interface with `@Service` with the type of the entity as its `value`
<3> `@Query` annotation accepts a closure which returns a query builder (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/QueryBuilder.html[QueryBuilder] for full reference)
<3> `@Query` annotation accepts a closure which returns a query builder (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/QueryBuilder.html[QueryBuilder] for full reference)
<4> Specify a hash key with `hash` method and method's `hashKey` argument
<5> Specify some range key criteria with the method's `rangeKey` argument (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<5> Specify some range key criteria with the method's `rangeKey` argument (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<6> You can limit which properties are returned from the query
<7> Only `rangeIndex` property will be populated in the entities returned
<8> The arguments have no special meaning but you can use them in the query. The method must return either `Flowable` or `List` of entities.
Expand All @@ -398,9 +398,9 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-dynamodb/src/test/groovy/com/a
----
<1> Annotate an interface with `@Service` with the type of the entity as its `value`
<2> Define class which implements `Function<Map<String, Object>, DetachedQuery>`
<3> Use `Builders` class to create a query builder for given DynamoDB entity (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/QueryBuilder.html[QueryBuilder] for full reference)
<3> Use `Builders` class to create a query builder for given DynamoDB entity (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/QueryBuilder.html[QueryBuilder] for full reference)
<4> Specify a hash key with `hash` method and method's `hashKey` argument
<5> Specify some range key criteria with the method's `rangeKey` argument (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<5> Specify some range key criteria with the method's `rangeKey` argument (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<6> Only `rangeIndex` property will be populated in the entities returned
<7> `@Query` annotation accepts a class which implements `Function<Map<String, Object>, DetachedQuery>`
<8> The arguments have no special meaning but you can use them in the query using `arguments` map. The method must return either `Flowable` or `List` of entities.
Expand All @@ -427,8 +427,8 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-dynamodb/src/test/groovy/com/a
----
<1> `Builders` class provides all necessary factory methods and keywords
<2> Annotate an interface with `@Service` with the type of the entity as its `value`
<3> `@Scan` annotation accepts a closure which returns a scan builder (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/ScanBuilder.html[ScanBuilder] for full reference)
<4> Specify some filter criteria with the method's `foo` argument (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<3> `@Scan` annotation accepts a closure which returns a scan builder (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/ScanBuilder.html[ScanBuilder] for full reference)
<4> Specify some filter criteria with the method's `foo` argument (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<5> The arguments have no special meaning but you can use them in the scan definition. The method must return either `Flowable` or `List` of entities.


Expand All @@ -445,8 +445,8 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-dynamodb/src/test/groovy/com/a
----
<1> Annotate an interface with `@Service` with the type of the entity as its `value`
<2> Define class which implements `Function<Map<String, Object>, DetachedScan>`
<3> Use `Builders` class to create a scan builder for given DynamoDB entity (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/ScanBuilder.html[ScanBuilder] for full reference)
<4> Specify some filter criteria with the method's `foo` argument (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<3> Use `Builders` class to create a scan builder for given DynamoDB entity (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/ScanBuilder.html[ScanBuilder] for full reference)
<4> Specify some filter criteria with the method's `foo` argument (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/RangeConditionCollector.html[RangeConditionCollector] for full reference)
<5> `@Scan` annotation accepts a class which implements `Function<Map<String, Object>, DetachedScan>`
<6> The arguments have no special meaning but you can use them in the scan definition. The method must return either `Flowable` or `List` of entities.

Expand All @@ -468,11 +468,11 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-dynamodb/src/test/groovy/com/a
----
<1> `Builders` class provides all necessary factory methods and keywords
<2> Annotate an interface with `@Service` with the type of the entity as its `value`
<3> `@Update` annotation accepts a closure which returns an update builder (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference)
<3> `@Update` annotation accepts a closure which returns an update builder (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference)
<4> Specify a hash key with `hash` method and method's `hashKey` argument
<5> Specify a range key with `range` method and method's `rangeKey` argument
<6> Specify update operation - increment `number` attribute (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference). You may have multiple update operations.
<7> Specify what should be returned from the method (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference).
<6> Specify update operation - increment `number` attribute (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference). You may have multiple update operations.
<7> Specify what should be returned from the method (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference).
<8> The arguments have no special meaning but you can use them in the scan definition. The method's return value depends on the value returned from `returnUpdatedNew` mapper.


Expand All @@ -489,11 +489,11 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-dynamodb/src/test/groovy/com/a
----
<1> Annotate an interface with `@Service` with the type of the entity as its `value`
<2> Define class which implements `Function<Map<String, Object>, DetachedUpdate>`
<3> Use `Builders` class to create an update builder for given DynamoDB entity (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference)
<3> Use `Builders` class to create an update builder for given DynamoDB entity (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference)
<4> Specify a hash key with `hash` method and method's `hashKey` argument
<5> Specify a range key with `range` method and method's `rangeKey` argument
<6> Specify update operation - increment `number` attribute (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference). You may have multiple update operations.
<7> Specify what should be returned from the method (see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference).
<6> Specify update operation - increment `number` attribute (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference). You may have multiple update operations.
<7> Specify what should be returned from the method (see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/builder/UpdateBuilder.html[UpdateBuilder] for full reference).
<8> `@Update` annotation accepts a class which implements `Function<Map<String, Object>, DetachedUpdate>`
<9> The arguments have no special meaning but you can use them in the scan definition. The method's return value depends on the value returned from `returnUpdatedNew` mapper.

Expand Down Expand Up @@ -567,7 +567,7 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-dynamodb/src/test/groovy/com/a
<8> Delete an entity by object reference
<9> Delete all entities with given range index value

Please see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/dynamodb/DynamoDBService.html[DynamoDBService] for full reference.
Please see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/dynamodb/DynamoDBService.html[DynamoDBService] for full reference.

==== DynamoDB Accelerator (DAX)

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/src/docs/asciidoc/kinesis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Otherwise you need no configuration at all but some of the configuration may be
----
include::{root-dir}/subprojects/micronaut-aws-sdk-test/src/test/resources/application-docs-kinesis.yml[]
----
<1> You can specify the default stream for https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/kinesis/KinesisService.html[KinesisService] and `@KinesisClient`
<1> You can specify the default stream for https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/kinesis/KinesisService.html[KinesisService] and `@KinesisClient`
<2> You can define multiple configurations
<3> Each of the configuration can be access using `@Named('test') KinesisService` qualifier or you can define the configuration as `value` of `@KinesisClient('test')`
<4> Application name is required for `@KinesisListner`
Expand Down Expand Up @@ -162,7 +162,7 @@ from particular shards.
Instance of `KinesisService` is created for the default Kinesis configuration and each stream configuration in `aws.kinesis.streams` map.
You should always use `@Named` qualifier when injecting `KinesisService` if you have more than one stream configuration present, e.g. `@Named("other") KinesisService otherService`.

Please, see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/kinesis/KinesisService.html[KinesisService] for the full reference.
Please, see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/kinesis/KinesisService.html[KinesisService] for the full reference.

==== Testing
You can very easily mock any of the interfaces and declarative services but if you need close-to-production
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/src/docs/asciidoc/s3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapu
<1> Delete bucket
<2> The Bucket is no longer present

Please, see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/s3/SimpleStorageService.html[SimpleStorageService] for the full reference.
Please, see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/s3/SimpleStorageService.html[SimpleStorageService] for the full reference.

==== Testing
You can very easily mock the `SimpleStorageService` but if you need close-to-production
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/src/docs/asciidoc/ses.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-ses/src/test/groovy/com/agorap
<9> Define the mime type (usually optional - deduced from the file)
<10> Define the description of the file (optional)

Please, see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/ses/SimpleEmailService.html[SimpleEmailService] for the full reference.
Please, see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/ses/SimpleEmailService.html[SimpleEmailService] for the full reference.

==== Testing
It is recommended just to mock the `SimpleEmailService` in your tests as it only contains single abstract method.
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/src/docs/asciidoc/sns.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ No configuration is required but some of the configuration properties may be use
----
include::{root-dir}/subprojects/micronaut-aws-sdk-test/src/test/resources/application-docs-sns.yml[]
----
<1> You can specify the default topic for https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/sns/SimpleNotificationService.html[SimpleNotificationService] and `@NotificationClient`
<1> You can specify the default topic for https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/sns/SimpleNotificationService.html[SimpleNotificationService] and `@NotificationClient`
<2> Amazon Resource Name for the iOS application mobile push
<3> Amazon Resource Name for the Android application mobile push
<4> Amazon Resource Name for the Amazon application mobile push
Expand Down Expand Up @@ -129,7 +129,7 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-sns/src/test/groovy/com/agorap
----
<1> Send a message to the phone number

Please, see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/sns/SimpleNotificationService.html[SimpleNotificationService] for the full reference.
Please, see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/sns/SimpleNotificationService.html[SimpleNotificationService] for the full reference.

==== Testing
You can very easily mock any of the interfaces and declarative services but if you need close-to-production
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/src/docs/asciidoc/sqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-test/src/test/resources/applic
<1> Queue prefix is prepended to every queue name (may be useful for local development)
<2> Whether to create any missing queue automatically (default `false`)
<3> Whether to first fetch all queues and set up queue to url cache first time the service is prompted for the queue URL (default `false`)
<4> You can specify the default topic for https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/sqs/SimpleQueueService.html[SimpleQueueService] and `@QueueClient`
<4> You can specify the default topic for https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/sqs/SimpleQueueService.html[SimpleQueueService] and `@QueueClient`
<5> Whether the newly created queues are supposed to be https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html[FIFO queues] (default `false`)
<6> The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from `0` to `900` (15 minutes). Default: `0`.
<7> The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from `60` (1 minute) to `1,209,600` (14 days). Default: `345,600` (4 days).
Expand Down Expand Up @@ -121,7 +121,7 @@ include::{root-dir}/subprojects/micronaut-aws-sdk-sqs/src/test/groovy/com/agorap
TIP: Try to use AWS Lambda functions triggered by SQS messages to handle incoming SQS messages instead of implementing
complex message handling logic yourselves.

Please, see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/sqs/SimpleQueueService.html[SimpleQueueService] for the full reference.
Please, see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/sqs/SimpleQueueService.html[SimpleQueueService] for the full reference.

==== Testing
You can very easily mock any of the interfaces and declarative services but if you need close-to-production
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/src/docs/asciidoc/sts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Following example shows how to create credentials for assumed role.
include::{root-dir}/subprojects/micronaut-aws-sdk-sts/src/test/groovy/com/agorapulse/micronaut/aws/sts/SecurityTokenServiceSpec.groovy[tag=usage]
----

Please, see https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/sts/SecurityTokenService.html[SecurityTokenService] for the full reference.
Please, see https://agorapulse.github.io/micronaut-libraries/api/com/agorapulse/micronaut/aws/sts/SecurityTokenService.html[SecurityTokenService] for the full reference.

==== Testing
It is recommended just to mock the `SecurityTokenService` in your tests as it only contains single abstract method.
Expand Down
Loading

0 comments on commit 992ebec

Please sign in to comment.