Skip to content

Commit e3f3693

Browse files
committed
Java doc links, typos, end bugs
1 parent 38c5b26 commit e3f3693

File tree

10 files changed

+30
-40
lines changed

10 files changed

+30
-40
lines changed

docs/src/main/asciidoc/adb.adoc

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ https://docs.oracle.com/en/cloud/paas/atp-cloud/index.html[Autonomous Database]
88
on self-driving Oracle Autonomous Database technology to deliver automated patching, upgrades, and tuning, including
99
performing all routine database maintenance tasks while the system is running, without human intervention.
1010

11-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
11+
Maven coordinates:
1212

1313
[source,xml]
1414
----
@@ -30,19 +30,12 @@ dependencies {
3030
=== Using Autonomous Database
3131

3232
The starter automatically configures and registers an `AutonomousDb` bean in the Spring application context.
33-
The `AutonomousDb` bean (link[Javadoc]) can be used to create an Autonomous Database, get details of an Autonomous Database,
33+
The `AutonomousDb` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/adb/package-summary.html[Javadoc]) can be used to create an Autonomous Database, get details of an Autonomous Database,
3434
delete an Autonomous Database and generate a wallet for an Autonomous Database.
3535

3636
[source,java]
3737
----
3838
@Autowired
39-
private Queue queue;
40-
41-
public void createQueue() {
42-
43-
String queueId = queue.createQueue("my-queue", <<compartmentId>>, <<deadLetterQueueDeliveryCount>>, <<retentionInSeconds>>);
44-
}
45-
@Autowired
4639
AutonomousDb autonomousDatabase;
4740
4841
public void createAutonomousDatabase() {

docs/src/main/asciidoc/core.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
// Copyright (c) 2023, Oracle and/or its affiliates.
1+
// Copyright (c) 2023, 2024, Oracle and/or its affiliates.
22
// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
33

44
[#spring-cloud-oci-core]
55
== Spring Cloud OCI Core
66

77
Spring Cloud OCI provides a Spring Boot starter to auto-configure the core components.
88

9-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
9+
Maven coordinates:
1010

1111
[source,xml]
1212
----

docs/src/main/asciidoc/function.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) 2023, Oracle and/or its affiliates.
1+
// Copyright (c) 2023, 2024, Oracle and/or its affiliates.
22
// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
33

44
[#cloud-function]
@@ -7,7 +7,7 @@
77
https://docs.oracle.com/en-us/iaas/Content/Functions/Concepts/functionsoverview.htm[OCI Functions] is a fully managed, multi-tenant, highly scalable, on-demand, Functions-as-a-Service platform. It is built on enterprise-grade Oracle Cloud Infrastructure and powered by the Fn Project open source engine. Use OCI Functions when you want to focus on writing code to meet business needs. The Spring Cloud module for OCI Functions allows to invoke an OCI Function.
88
A Spring Boot starter is provided to auto-configure the Function component.
99

10-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
10+
Maven coordinates:
1111

1212
[source,xml]
1313
----

docs/src/main/asciidoc/genai.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
https://docs.oracle.com/en-us/iaas/Content/generative-ai/home.htm[OCI Generative AI] is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases, including chat and creating text embeddings.
88

9-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
9+
Maven coordinates:
1010

1111
[source,xml]
1212
----
@@ -28,12 +28,11 @@ dependencies {
2828
=== Using Generative AI Chat
2929

3030
The starter configures and registers a `ChatModel` bean in the Spring application context.
31-
The `ChatModel` bean (link[Javadoc]) can be used to interact with OCI Generative AI Chat Models.
31+
The `ChatModel` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/genai/package-summary.html[Javadoc]) can be used to interact with OCI Generative AI Chat Models.
3232

3333
[source,java]
3434
----
3535
@Autowired
36-
@Autowired
3736
private ChatModel chatModel;
3837
3938
public void embed() {
@@ -44,7 +43,7 @@ public void embed() {
4443
=== Using Generative AI Embedding
4544

4645
The starter configures and registers an `EmbeddingModel` bean in the Spring application context.
47-
The `EmbeddingModel` bean (link[Javadoc]) can be used to create text embeddings using OCI Generative AI Embedding Models.
46+
The `EmbeddingModel` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/genai/package-summary.html[Javadoc]) can be used to create text embeddings using OCI Generative AI Embedding Models.
4847

4948
[source,java]
5049
----
@@ -82,7 +81,6 @@ The Spring Boot Starter for Oracle Cloud Generative AI provides the following co
8281

8382
|===
8483

85-
8684
=== Sample
8785

8886
A sample application provided https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-gen-ai-sample[here] contains the examples to demonstrates the usage of OCI Spring Cloud Generative AI module.

docs/src/main/asciidoc/logging.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
// Copyright (c) 2023, Oracle and/or its affiliates.
1+
// Copyright (c) 2023, 2024, Oracle and/or its affiliates.
22
// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
33

44
[#cloud-logging]
55
== Cloud Logging
66

77
https://docs.oracle.com/en-us/iaas/Content/Logging/home.htm[OCI Logging] service is a highly scalable and fully managed single pane of glass for all the logs in your tenancy. Logging provides access to logs from OCI resources. These logs include critical diagnostic information that describes how resources are performing and being accessed. Use Logging to enable, manage, and search Audit, Service, and Custom logs. The Spring Cloud module for OCI Logging allows ingesting logs associated with a logId.
8-
A Spring Boot starter is provided to auto-configure the Logging component.
8+
A Spring Boot starter is provided to autoconfigure the Logging component.
99

10-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
10+
Maven coordinates::
1111

1212
[source,xml]
1313
----
@@ -29,7 +29,7 @@ dependencies {
2929
=== Using Cloud Logging
3030

3131
The starter automatically configures and registers a `Logging` bean in the Spring application context.
32-
The `Logging` bean (link[Javadoc]) can be used to ingest logs associated with a logId specified in the property `spring.cloud.oci.logging.logId` within the application configuration file
32+
The `Logging` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/logging/package-summary.html[Javadoc]) can be used to ingest logs associated with a logId specified in the property `spring.cloud.oci.logging.logId` within the application configuration file
3333

3434
[source,java]
3535
----

docs/src/main/asciidoc/notifications.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
// Copyright (c) 2023, Oracle and/or its affiliates.
1+
// Copyright (c) 2023, 2024, Oracle and/or its affiliates.
22
// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
33

44
[#cloud-notifications]
55
== Cloud Notifications
66

77
https://www.oracle.com/in/devops/notifications/[OCI Notifications] is a highly available, low latency publish/subscribe (pub/sub) service that sends alerts and messages to Oracle Cloud Functions, email, SMS, and message delivery partners, including Slack, PagerDuty and custom HTTPS endpoint. Spring Cloud module for Oracle Cloud Notifications allows you to create a Topic, then create and publish messages to multiple subscription types such as Oracle Cloud Functions, email, SMS, Slack, PagerDuty and custom HTTPS endpoint.
8-
A Spring Boot starter is provided to auto-configure the various Notification components.
8+
A Spring Boot starter is provided to autoconfigure the various Notification components.
99

10-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
10+
Maven coordinates:
1111

1212
[source,xml]
1313
----
@@ -29,7 +29,7 @@ dependencies {
2929
=== Using Cloud Notifications
3030

3131
The starter automatically configures and registers a `Notification` bean in the Spring application context.
32-
The `Notification` bean (link[Javadoc]) can be used to create a Topic, create, list, get a Subscription, and publish messages to the Subscriptions in a Topic.
32+
The `Notification` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/notification/package-summary.html[Javadoc]) can be used to create a Topic, create, list, get a Subscription, and publish messages to the Subscriptions in a Topic.
3333

3434
[source,java]
3535
----

docs/src/main/asciidoc/queues.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
// Copyright (c) 2023, Oracle and/or its affiliates.
1+
// Copyright (c) 2023, 2024, Oracle and/or its affiliates.
22
// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
33

44
[#cloud-queues]
55
== Cloud Queues
66

77
https://docs.oracle.com/en-us/iaas/Content/queue/home.htm[OCI Queues] is a highly available, low latency publish/subscribe (pub/sub) service, handles high volume transactional data that requires independently processed messages without loss or duplication. Spring Cloud module for Oracle Cloud Queues allows you to create a queue, get a queue, list queues, delete a queue, put messages, get messages, update messages and delete a message.
8-
A Spring Boot starter is provided to auto-configure the various Queue components.
8+
A Spring Boot starter is provided to autoconfigure the various Queue components.
99

10-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
10+
Maven coordinates:
1111

1212
[source,xml]
1313
----
@@ -29,7 +29,7 @@ dependencies {
2929
=== Using Cloud Queues
3030

3131
The starter automatically configures and registers a `Queue` bean in the Spring application context.
32-
The `Queue` bean (link[Javadoc]) can be used to create a queue, get a queue, list queues, delete a queue, put messages, get messages, update messages and delete a message.
32+
The `Queue` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/queue/package-summary.html[Javadoc]) can be used to create a queue, get a queue, list queues, delete a queue, put messages, get messages, update messages and delete a message.
3333

3434
[source,java]
3535
----

docs/src/main/asciidoc/storage.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
// Copyright (c) 2023, Oracle and/or its affiliates.
1+
// Copyright (c) 2023, 2024 Oracle and/or its affiliates.
22
// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
33

44
[#cloud-storage]
55
== Cloud Storage
66

77
https://www.oracle.com/in/cloud/storage/[Oracle Cloud Storage] allows you to store any types of file.
8-
A Spring Boot starter is provided to auto-configure the various Storage components.
8+
A Spring Boot starter is provided to autoconfigure the various Storage components.
99

10-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
10+
Maven coordinates:
1111

1212
[source,xml]
1313
----
@@ -29,7 +29,7 @@ dependencies {
2929
=== Using Cloud Storage
3030

3131
The starter automatically configures and registers a `Storage` bean in the Spring application context.
32-
The `Storage` bean (link[Javadoc]) can be used to list, create, update or delete buckets and objects.
32+
The `Storage` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/storage/package-summary.html[Javadoc]) can be used to list, create, update or delete buckets and objects.
3333

3434
[source,java]
3535
----
@@ -63,7 +63,7 @@ SpringApplication.run(...).getResource("Object Storage URL");
6363

6464
This creates a `Resource` object that can be used to read the object, among https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html#resources-resource[other possible operations].
6565

66-
Currently this resource is only readable.
66+
Currently, this resource is only readable.
6767

6868
=== Configuration
6969

docs/src/main/asciidoc/streaming.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
// Copyright (c) 2023, Oracle and/or its affiliates.
1+
// Copyright (c) 2023, 2024, Oracle and/or its affiliates.
22
// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
33

44
[#cloud-stream]
55
== Cloud Stream
66

77
https://docs.oracle.com/en-us/iaas/Content/Streaming/home.htm[OCI Streaming] service provides a fully managed, scalable, and durable solution for ingesting and consuming high-volume data streams in real time.
8-
A Spring Boot starter is provided to auto-configure the Streaming component.
8+
A Spring Boot starter is provided to autoconfigure the Streaming component.
99

10-
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
10+
Maven coordinates::
1111

1212
[source,xml]
1313
----
@@ -29,7 +29,7 @@ dependencies {
2929
=== Using Cloud Streaming
3030

3131
The starter automatically configures and registers a `Streaming` bean in the Spring application context.
32-
The `Streaming` bean (link[Javadoc]) can be used to create streamPool, stream in OCI and ingest and consume high-volume data streams with a streamId
32+
The `Streaming` bean (https://oracle.github.io/spring-cloud-oci/1.1.0/javadocs/com/oracle/cloud/spring/streaming/package-summary.html[Javadoc]) can be used to create streamPool, stream in OCI and ingest and consume high-volume data streams with a streamId
3333

3434
[source,java]
3535
----

docs/src/main/spring-cloud-oci.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)