Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix link syntax to include .md file type #4049

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-apiml.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The following definition of skill levels about Zowe assist you with gathering th

This article describes how API ML uses Transport Layer Security (TLS). Use this guide to familiarize yourself with the API ML security concepts.

- [**Zowe API Mediation Layer Single Sign On Overview**](../user-guide/api-mediation-sso)
- [**Zowe API Mediation Layer Single Sign On Overview**](../user-guide/api-mediation-sso.md)

This article provides an overview of the API ML single-sign-on feature, the principle participants in the SSO process, and links to detailed Zowe SSO documentation.

Expand Down
14 changes: 8 additions & 6 deletions docs/user-guide/api-mediation-sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ This article provides an overview of the API ML single sign on feature, the prin
Currently, API ML can provide SSO only in a single security domain.
:::

- [Zowe API ML client](#zowe-api-ml-client)
- [API service accessed via Zowe API ML](#api-service-accessed-via-zowe-api-ml)
- [Existing services that cannot be modified](#existing-services-that-cannot-be-modified)
- [Zowe API Mediation Layer Single Sign On Overview](#zowe-api-mediation-layer-single-sign-on-overview)
- [Zowe API ML client](#zowe-api-ml-client)
- [API service accessed via Zowe API ML](#api-service-accessed-via-zowe-api-ml)
- [Existing services that cannot be modified](#existing-services-that-cannot-be-modified)
- [Further resources](#further-resources)

The following diagram describes the interactions between the general participants in the single sign on process.

Expand Down Expand Up @@ -51,7 +53,7 @@ This section describes the requirements that an API service needs to satisfy to
* The alternative is to validate the signature of the JWT token using the public key of the token issuer (e.g. the API ML Gateway). The API service needs to have the API ML Gateway certificate along with the full CA certification chain in the API service truststore.

:::note
The REST API of ZAAS can easily be called from a Java application using the [ZAAS Client](../extend/extend-apiml/zaas-client).
The REST API of ZAAS can easily be called from a Java application using the [ZAAS Client](../extend/extend-apiml/zaas-client.md).
:::

### Existing services that cannot be modified
Expand All @@ -62,7 +64,7 @@ For more information, see [Enabling single sign on for extending services via Pa

## Further resources

* [User guide for SSO in Zowe CLI](./cli-using-integrating-apiml/#accessing-multiple-services-with-sso)
* [System requirements for using web tokens for SSO in Zlux and ZSS](./systemrequirements)
* [User guide for SSO in Zowe CLI](./cli-using-integrating-apiml.md#accessing-multiple-services-with-sso)
* [System requirements for using web tokens for SSO in Zlux and ZSS](./systemrequirements.md)


27 changes: 15 additions & 12 deletions docs/user-guide/api-mediation/api-mediation-caching-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,19 @@ In the current implementation of the Caching Service, Infinispan is recommended

The Caching Service is available only for internal Zowe applications, and is not exposed to the internet. The Caching service supports a hot-reload scenario in which a client service requests all available service data.

- [Architecture](#architecture)
- [Storage methods](#storage-methods)
- [Infinispan](#infinispan-recommended)
- [VSAM](#vsam-deprecated)
- [Redis](#redis)
- [InMemory](#inmemory)
- [How to start the service](#how-to-start-the-service)
- [Methods to use the Caching service API](#methods-to-use-the-caching-service-api)
- [Configuration properties](#configuration-properties)
- [Authentication](#authentication)
- [Using the Caching Service](#using-the-caching-service)
- [Architecture](#architecture)
- [Storage methods](#storage-methods)
- [Infinispan (recommended)](#infinispan-recommended)
- [VSAM (deprecated)](#vsam-deprecated)
- [Redis](#redis)
- [InMemory](#inmemory)
- [How to start the Service](#how-to-start-the-service)
- [Methods to use the Caching Service API](#methods-to-use-the-caching-service-api)
- [Configuration properties](#configuration-properties)
- [Authentication](#authentication)
- [Direct calls](#direct-calls)
- [Routed calls through API Gateway](#routed-calls-through-api-gateway)

## Architecture

Expand Down Expand Up @@ -117,8 +120,8 @@ This parameter specifies service behavior when the limit of records is reached.

:::note
- For more information about how to configure the Caching Service in the `application.yml`, see
[Add API Onboarding Configuration](../../extend/extend-apiml/onboard-spring-boot-enabler).
- When using VSAM, ensure that you set the additional configuration parameters. For more information about setting these parameters, see [Using VSAM as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-vsam).
[Add API Onboarding Configuration](../../extend/extend-apiml/onboard-spring-boot-enabler.md).
- When using VSAM, ensure that you set the additional configuration parameters. For more information about setting these parameters, see [Using VSAM as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-vsam.md).
:::

## Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The configuration entries of each LPAR in the `zowe.yaml` file control which com

The caching services for each Zowe instance, whether on the same LPAR, or distributed across the sysplex, are connected to each other by the same shared VSAM data set. This arrangement allows state sharing so that each instance behaves similarly to the user irrespective of where their request is routed.

To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../configure-sysplex).
To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../configure-sysplex.md).

## API Versioning

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/api-mediation/use-graphql-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ GraphQL is a query language for APIs that provides descriptions of the data in y

For more information about configuring routing to API ML, see the following articles:

* [Implementing routing to the Gateway](../../extend/extend-apiml/implementing-routing-to-the-api-gateway)
* [Routing Requests to REST API](./routing-requests-to-rest-apis)
* [Implementing routing to the Gateway](../../extend/extend-apiml/implementing-routing-to-the-api-gateway.md)
* [Routing Requests to REST API](./routing-requests-to-rest-apis.md)

:::tip

Expand Down
34 changes: 17 additions & 17 deletions docs/user-guide/api-mediation/using-api-mediation-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,48 +25,48 @@ See the following topics for detailed information about how to use the API Media

Three authentication methods can be used with single sign on:

* [Authenticating with a JWT token](../authenticating-with-jwt-token)
* [Authenticating with client certificates](../authenticating-with-client-certificates)
* [Authenticating with a Personal Access Token](./authenticating-with-personal-access-token)
* [Authenticating with a JWT token](../authenticating-with-jwt-token.md)
* [Authenticating with client certificates](../authenticating-with-client-certificates.md)
* [Authenticating with a Personal Access Token](./authenticating-with-personal-access-token.md)

### Using multi-factor authentication

User identity verification can be performed by using multi-factor authentication. For more information, see [Using multi-factor authentication (MFA)](./using-multi-factor-authentication).
User identity verification can be performed by using multi-factor authentication. For more information, see [Using multi-factor authentication (MFA)](./using-multi-factor-authentication.md).

### API Routing

Various routing options can be used for APIs when using API Mediation Layer:

* [Routing requests to REST APIs](./routing-requests-to-rest-apis)
* [Routing with WebSickets](../routing-with-websockets)
* [Using GraphQL APIs](use-graphql-api)
* [MultiTenancy Configuration](./api-mediation-multi-tenancy)
* [Routing requests to REST APIs](./routing-requests-to-rest-apis.md)
* [Routing with WebSickets](../routing-with-websockets.md)
* [Using GraphQL APIs](use-graphql-api.md)
* [MultiTenancy Configuration](./api-mediation-multi-tenancy.md)

### Learning more about APIs

API Mediation Layer makes it possible to view API information is a variety of ways:

* [Obtaining information about API Services](../obtaining-information-about-api-services)
* [Using Swagger "Try it out" in the API Catalog](../api-mediation-swagger-try-it-out)
* [Using Swagger Code Snippets in the API Catalog](../api-mediation-swagger-code-snippets)
* [Obtaining information about API Services](../obtaining-information-about-api-services.md)
* [Using Swagger "Try it out" in the API Catalog](../api-mediation-swagger-try-it-out.md)
* [Using Swagger Code Snippets in the API Catalog](../api-mediation-swagger-code-snippets.md)

### Administrating APIs

* [Using Static API services refresh in the API Catalog](../api-mediation-static-api-refresh)
* [Onboarding a REST API service with the YAML Wizard](../onboard-wizard)
* [Using Static API services refresh in the API Catalog](../api-mediation-static-api-refresh.md)
* [Onboarding a REST API service with the YAML Wizard](../onboard-wizard.md)

### Using the Caching Service

As an API developer, you can use the Caching Service as a storage solution to enable resource sharing between service instances, thereby ensuring High Availability of services. For details, see [Using the Caching service](./api-mediation-caching-service).
As an API developer, you can use the Caching Service as a storage solution to enable resource sharing between service instances, thereby ensuring High Availability of services. For details, see [Using the Caching service](./api-mediation-caching-service.md).

### Using API Catalog

There are various options for using the API Catalog:

* [Viewing Service Information abd API Documentation in the API Catalog](../api-mediation-view-service-information-and-api-doc)
* [Changing an expired password via API Catalog](../api-mediation-change-password-via-catalog)
* [Viewing Service Information abd API Documentation in the API Catalog](../api-mediation-view-service-information-and-api-doc.md)
* [Changing an expired password via API Catalog](../api-mediation-change-password-via-catalog.md)

### Additional use case when usig API Mediation Layer

* [SMF records](./api-mediation-smf)
* [SMF records](./api-mediation-smf.md)

4 changes: 2 additions & 2 deletions docs/user-guide/authenticating-with-jwt-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This article describes how services in the Zowe API ecosystem are expected to ac
For more information about authenticating with JWT tokens, see the Medium blog post [Single-Sign-On to z/OS REST APIs with Zowe](https://medium.com/zowe/single-sign-on-to-z-os-rest-apis-with-zowe-6e35fd022a95).
:::

By default, JWT tokens are produced by z/OSMF and the API Mediation Layer only serves as a proxy. For information about how to change who and how tokens are produced, see [Authentication Providers within Enable Single Sign On for Clients](./api-mediation/configuration-jwt/#using-saf-as-an-authentication-provider).
By default, JWT tokens are produced by z/OSMF and the API Mediation Layer only serves as a proxy. For information about how to change who and how tokens are produced, see [Authentication Providers within Enable Single Sign On for Clients](./api-mediation/configuration-jwt.md#using-saf-as-an-authentication-provider).


## JWT Token-based Login Flow and Request/Response Format
Expand Down Expand Up @@ -161,7 +161,7 @@ https://{gatewayUrl}:{gatewayPort}/gateway/api/v1/auth/refresh
The new token overwrites the old cookie with a Set-Cookie header. As part of the process, the old token becomes invalidated and is no longer usable.

:::note Notes:
- The endpoint is disabled by default. For more information, see [Enable JWT token endpoint](./api-mediation/configuration-jwt/#enabling-a-jwt-token-refresh-endpoint).
- The endpoint is disabled by default. For more information, see [Enable JWT token endpoint](./api-mediation/configuration-jwt.md#enabling-a-jwt-token-refresh-endpoint).
- The endpoint is protected by a client certificate.
- The refresh request requires the token in one of the following formats:
- Cookie named `apimlAuthenticationToken`.
Expand Down
18 changes: 10 additions & 8 deletions docs/user-guide/obtaining-information-about-api-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ As an API Mediation Layer user, information about API services can be obtained f

This article provides further detail about each of these use cases.

- [Using API ID in API ML to locate APIs in different instances](#using-api-id-in-api-ml-to-locate-apis-in-different-instances)
- [Protecting Service Information](#protecting-service-information)
- [Using API Endpoints](#using-api-endpoints)
- [Obtaining Information about a Specific Service](#obtaining-information-about-a-specific-service)
- [Obtaining Information about All Services](#obtaining-information-about-all-services)
- [Obtaining Information about All Services with a Specific API ID](#obtaining-information-about-all-services-with-a-specific-api-id)
- [Obtaining Information about API Services](#obtaining-information-about-api-services)
- [Using API ID in API ML to locate APIs in different instances](#using-api-id-in-api-ml-to-locate-apis-in-different-instances)
- [Protecting Service Information](#protecting-service-information)
- [Using API Endpoints](#using-api-endpoints)
- [Obtaining Information about a Specific Service](#obtaining-information-about-a-specific-service)
- [Obtaining Information about All Services](#obtaining-information-about-all-services)
- [Obtaining Information about All Services with a Specific API ID](#obtaining-information-about-all-services-with-a-specific-api-id)
- [Response Format](#response-format)

## Using API ID in API ML to locate APIs in different instances

Expand All @@ -24,7 +26,7 @@ The _API ID_ uniquely identifies the API in the API ML. The API ID can be used t

Information about API services is considered sensitive as it contains partial information about the internal topology of the mainframe system. As such, this information should be made accessible only by authorized users and services.

Access to this information requires authentication using mainframe credentials, as well as verification of access to resources through SAF. The resource class and resource is defined in the `ZWESECUR` job. Dor more information about `ZWESECUR` job, see [Addresing z/OS requrements for Zowe](./configure-zos-system).
Access to this information requires authentication using mainframe credentials, as well as verification of access to resources through SAF. The resource class and resource is defined in the `ZWESECUR` job. Dor more information about `ZWESECUR` job, see [Addresing z/OS requrements for Zowe](./configure-zos-system.md).

The security administrator needs to permit READ access to the `APIML.SERVICES` resource in the `ZOWE` resource class to access the information about API services.

Expand All @@ -48,7 +50,7 @@ RECKEY APIML ADD(SERVICES SERVICE(READ) ROLE(user) ALLOW)
F ACF2,REBUILD(ZWE)
```

The API Gateway can be configured to check for SAF resource authorization in several ways. For more information, see [SAF Resource Checking](./api-mediation/configuration-saf-resource-checking).
The API Gateway can be configured to check for SAF resource authorization in several ways. For more information, see [SAF Resource Checking](./api-mediation/configuration-saf-resource-checking.md).

## Using API Endpoints

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The following definition of skill levels about Zowe assist you with gathering th

This article describes how API ML uses Transport Layer Security (TLS). Use this guide to familiarize yourself with the API ML security concepts.

- [**Zowe API Mediation Layer Single Sign On Overview**](../user-guide/api-mediation-sso)
- [**Zowe API Mediation Layer Single Sign On Overview**](../user-guide/api-mediation-sso.md)

This article provides an overview of the API ML single-sign-on feature, the principle participants in the SSO process, and links to detailed Zowe SSO documentation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,19 @@ In the current implementation of the Caching Service, VSAM is required for the s

The Caching Service is available only for internal Zowe applications, and is not exposed to the internet. The Caching service supports a hot-reload scenario in which a client service requests all available service data.

- [Architecture](#architecture)
- [Storage methods](#storage-methods)
- [Infinispan](#infinispan-recommended)
- [VSAM](#vsam)
- [Redis](#redis)
- [InMemory](#inmemory)
- [How to start the service](#how-to-start-the-service)
- [Methods to use the Caching service API](#methods-to-use-the-caching-service-api)
- [Configuration properties](#configuration-properties)
- [Authentication](#authentication)
- [Using the Caching Service](#using-the-caching-service)
- [Architecture](#architecture)
- [Storage methods](#storage-methods)
- [Infinispan (recommended)](#infinispan-recommended)
- [VSAM](#vsam)
- [Redis](#redis)
- [InMemory](#inmemory)
- [How to start the Service](#how-to-start-the-service)
- [Methods to use the Caching Service API](#methods-to-use-the-caching-service-api)
- [Configuration properties](#configuration-properties)
- [Authentication](#authentication)
- [Direct calls](#direct-calls)
- [Routed calls through API Gateway](#routed-calls-through-api-gateway)

## Architecture

Expand Down Expand Up @@ -115,8 +118,8 @@ This parameter specifies service behavior when the limit of records is reached.

:::note
- For more information about how to configure the Caching Service in the `application.yml`, see
[Add API Onboarding Configuration](../../extend/extend-apiml/onboard-spring-boot-enabler).
- When using VSAM, ensure that you set the additional configuration parameters. For more information about setting these parameters, see [Using VSAM as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-vsam).
[Add API Onboarding Configuration](../../extend/extend-apiml/onboard-spring-boot-enabler.md).
- When using VSAM, ensure that you set the additional configuration parameters. For more information about setting these parameters, see [Using VSAM as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-vsam.md).
:::

## Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The caching services for each Zowe instance, whether on the same LPAR, or distri

For simplification of the preceding diagram, the Jobs and Files API servers are not shown as being started. If the user defines Jobs and Files API servers to be started in the `zowe.yaml` configuration file, these servers behave the same as the servers that are illustrated. In other words, these services register to their API discovery server which then communicates with other discovery servers on other Zowe instances on either the same or other LPARs. The API traffic received by any API Gateway on any Zowe instance is routed to any of the Jobs or Files API components that are available.

To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../configure-sysplex).
To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../configure-sysplex.md).

## API Versioning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
GraphQL is a query language for APIs that provides descriptions of the data in your APIs, and allows for specific queries to facilitate API development. Routing for such APIs is possible within the Zowe ecosystem, however at the present time, Zowe itself does not provide any GraphQL APIs.

For more information about configuring routing to API ML, see the following articles:
* [Implementing routing to the Gateway](../../extend/extend-apiml/implementing-routing-to-the-api-gateway)
* [Routing Requests to REST API](./routing-requests-to-rest-apis)
* [Implementing routing to the Gateway](../../extend/extend-apiml/implementing-routing-to-the-api-gateway.md)
* [Routing Requests to REST API](./routing-requests-to-rest-apis.md)

:::tip
* For information about how to use GraphQL, see [GraphQL Best Practices](https://graphql.org/learn/best-practices/) in the GraphQL product documentation.
Expand Down
Loading
Loading