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.

Sign up for GitHub

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

feat: add some admonitions #59

Merged
merged 1 commit into from
Jan 10, 2024
Merged

feat: add some admonitions #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions docs/01-without_versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ At this point we have our first customer : **John Doe** who uses our API with th

## TL;DR: What will you learn in this chapter?

This chapter covers the following topics:

1. How to start the platform
2. Adding a non-breaking change and see how it doesn't impact the API Contract
> [!IMPORTANT]
> This chapter covers the following topics:
> 1. How to start the platform
> 2. Adding a non-breaking change and see how it doesn't impact the API Contract
>

## Prerequisites

Expand Down
13 changes: 8 additions & 5 deletions docs/02-first_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

## TL;DR: What will you learn in this chapter?

This chapter covers the following topics:
> [!IMPORTANT]
> This chapter covers the following topics:
> 1. Pinpoint the impacts of the versioning in the OPENAPI Description file
> 2. Implement a URL Based versioning
> 3. Implement a header based versioning
> 4. Deploy and configure a default version for your API
>


1. Pinpoint the impacts of the versioning in the OPENAPI Description file
2. Implement a URL Based versioning
3. Implement a header based versioning
4. Deploy and configure a default version for your API

## Prerequisites
We will define in this chapter our first version in the URI and in a header mixing in the gateway & the apps.
Expand Down
9 changes: 5 additions & 4 deletions docs/03-second_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

## TL;DR: What are you going to learn in this chapter?

This chapter covers the following topics:

1. Creating a new version (it will be a copy of the rest-book module)
2. Add a new breaking change functionality to the last version
> [!IMPORTANT]
> This chapter covers the following topics:
> 1. Creating a new version (it will be a copy of the rest-book module)
> 2. Add a new breaking change functionality to the last version
>

## A new functionality for a new customer

Expand Down
10 changes: 7 additions & 3 deletions docs/04-scm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

## TL;DR: What are you going to learn in this chapter?

This chapter covers the following topics:

1. Pinpoint Configuration management issues due to API Versioning
2. Exposing the two versions on the API Gateway

> [!IMPORTANT]
> This chapter covers the following topics:
> 1. Pinpoint Configuration management issues due to API Versioning
> 2. Exposing the two versions on the API Gateway



## Preamble
You can configure your services either during deployment using CI tooling, such as [Gitlab Environments](https://docs.gitlab.com/ee/ci/environments/), or any other [Infra As Code](https://en.wikipedia.org/wiki/Infrastructure_as_code) tool ([Istio](https://istio.io/), [Ansible](https://www.ansible.com/),...) or using a configuration server.
Expand Down
5 changes: 3 additions & 2 deletions docs/05-conflicts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

## TL;DR: What are you going to learn in this chapter?

This chapter covers the following topics:

1. Dig into Backward compatibility hassle and implement a solution to make both of the two versions work
> [!IMPORTANT]
> This chapter covers the following topics:
> 1. Dig into Backward compatibility hassle and implement a solution to make both of the two versions work

## Preamble

Expand Down
8 changes: 5 additions & 3 deletions docs/06-authorization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

## TL;DR: What are you going to learn in this chapter?

This chapter covers the following topics:

1. Pinpointing the impacts on authorization
2. Enforcing API versions restrictions with OAUTHv2 scopes
> [!IMPORTANT]
> This chapter covers the following topics:
> 1. Pinpointing the impacts on authorization
> 2. Enforcing API versions restrictions with OAUTHv2 scopes
>

While versioning secured APIs, there is usually one impact we miss at the beginning: security, especially authorization.
If you apply authorization policies on your whole platform using for instance, [ABAC](https://en.wikipedia.org/wiki/Attribute-based_access_control) or [RBAC](https://en.wikipedia.org/wiki/Role-based_access_control) approaches, you must take care about it.
Expand Down
3 changes: 1 addition & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ Here is how this repository is organised and a short explanation:

### :computer: Infrastructure

:warning: The required infrastructure is available by
running [Docker containers](https://www.docker.com/resources/what-container/).
:warning: The required infrastructure is available by running [Docker containers](https://www.docker.com/resources/what-container/).

You can start the whole by running [Docker compose](https://docs.docker.com/compose/).

Expand Down