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

adding bump.sh's train travel api #25

Merged
merged 1 commit into from
Nov 23, 2024
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
40 changes: 40 additions & 0 deletions artifacts/bump.sh/bump.sh.package.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
apiVersion: mocks.microcks.io/v1alpha1
kind: APIPackage
metadata:
name: bump.sh
displayName: Bump.sh APIs
categories: Transportation
source: Community
provider:
name: Bump.sh
createdAt: '2024-10-29 17:00:00'
updatedAt: '2024-10-29 17:00:00'
description:
icon:
- base64data: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAIAAADYYG7QAAACZUlEQVR4nOzXy2sTQRwH8NlH0hLRutYeugQiHgJBcIN4SAJpbhVqwP/AgwfBQwVrG9GKUMGTioo3e1FvPg4BKxjIyRwitehBMSJUSGzDmlAHa2v3kZ0R2uBmQ+wMtRktzPeSZPa3mU92Jvlt5P79A+B/ivivAe3hIFI4iBQOIoWDSOEgUmRihaZpx4aH2wYbTqNU+pjP523b7ngW3jOIDyZRzz7w7YtUKQjm8raBotFoJjPR8VC1Wp3IXMjlcp5RQQQjF/HRk8gCjmGjtYa5suKbvev/9IgG9FdLpqrqwwf347GYx3PiChg6DcT1j4rXh+Re48g5M5TuOggAIEmS5/oNHBBTp1p07lPj0Bks+rsOAgAkEoldgUATEB0BouQewy4L+/vs/igLkCRJexWlCdq9ye0exn6FBcg0zXq93pxzqdJJsvEgiGs6C9CLXM6yrObUb59j82cLomWm1QUZvu86CEI4NXXVfb1cQ08nAfZyBAAcK/DmmoCd7oJez80dT6crFe8yzT4GT8aB+cNdqlU9UBiXl97RvKdA/NcRCoU0TWsbRMiZn/9cKpX+dBaWe7F6GPf0Cd91of6B5trQghhnBzbXcDjc1hzo4yC0uLhQLL4yDGPbQPF4/OaN61sDbQRCODZ2/tnMDE0xiyVTFGV6+l4qlaIpZrSHZFm+c/uWz+cjVrLb1MFgMEaxF5l+y1R1kFjDFKTrX4k17EC1Wq1YLBLL2IEuTV7+fVOwSViAIISjo2ez2SxNMbmXRSKRoWRyaxSEULlcflko0P9S8+ZKCgeRwkGkcBApHEQKB5HyKwAA//8dEMgpImCtowAAAABJRU5ErkJggg==
mediatype: image/png
spec:
maturity: beta
description: |
### What is Bump.sh?

Bump.sh helps you build a branded single source of truth, documenting and
cataloging all your APIs. Teams and customers now have a reference point for
building and consuming APIs whether with OpenAPI, Swagger or AsyncAPI.

### Stunning documentation

Designed with Developer Experience in mind: we make sure your readers will
enjoy every bit of your technical content. Blazing fast load times, sleek
user interface, single-page experience, easy sharing & highlighting,
generated examples.

### API changes are automatically detected

Collaborate directly from GitHub, Gitlab or Bitbucket. Get the best of
automation while keeping control of your changelog: Bump.sh detects and
summarizes changes for you. You decide when to publish them to your users.

apis:
- name: train-travel
currentVersion: '1.0'
57 changes: 57 additions & 0 deletions artifacts/bump.sh/train-travel/1.0/train-travel.1.0.api.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
apiVersion: mocks.microcks.io/v1alpha1
kind: APIVersion
metadata:
name: train-travel.1.0
displayName: Train Travel API
createdAt: '2020-01-03 19:01:00'
description: |
Everyone working with OpenAPI will have come across the PetStore at some
point. It's a sample OpenAPI description for an imaginary Pet Store with an
API, but the OpenAPI is old, and the API it describes is pretty far from
best practices. We thought it was time for a refresh, so we're bringing you
the Train Travel API, a new sample OpenAPI you can use for your tooling and
testing.

### Introducing the Train Travel API

The OpenAPI description document is on the train-travel-api GitHub
repository, and comes in the form of a single openapi.yaml that you can use
as a sample for any documentation, validation, mocking, or whatever tools
that you maintain and want to show a working demo with something less
contrived than a "Todo API" or the Pet Store.

It's an open-source project licensed as Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International.

### Describes a Realistic API

This API builds off of various open data sources and public APIs that have
all proven the concepts and patterns used in the design of this API.

The concept of Stations is based on [Stations - A Database of European Train
Stations](https://github.com/trainline-eu/stations), maintained by
[Trainline EU](https://github.com/trainline-eu/), and powered by
[OpenStreetMap](https://www.openstreetmap.org/), [SNCF
OpenData](https://ressources.data.sncf.com/explore/dataset/referentiel-gares-voyageurs/),
[Digitraffic.fi](http://rata.digitraffic.fi/api/v1/metadata/stations),
[OpenTransportData.swiss](https://opentransportdata.swiss/en/dataset/bhlist/resource/035c4d98-df6c-49b4-988a-3822823f0bf9),
[admin.ch](https://www.bav.admin.ch/bav/fr/home/themes-a-z/geoinformation/geodonnees-de-base/arrets-des-transports-publics.html).

icon:
- base64data: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAIAAADYYG7QAAACZUlEQVR4nOzXy2sTQRwH8NlH0hLRutYeugQiHgJBcIN4SAJpbhVqwP/AgwfBQwVrG9GKUMGTioo3e1FvPg4BKxjIyRwitehBMSJUSGzDmlAHa2v3kZ0R2uBmQ+wMtRktzPeSZPa3mU92Jvlt5P79A+B/ivivAe3hIFI4iBQOIoWDSOEgUmRihaZpx4aH2wYbTqNU+pjP523b7ngW3jOIDyZRzz7w7YtUKQjm8raBotFoJjPR8VC1Wp3IXMjlcp5RQQQjF/HRk8gCjmGjtYa5suKbvev/9IgG9FdLpqrqwwf347GYx3PiChg6DcT1j4rXh+Re48g5M5TuOggAIEmS5/oNHBBTp1p07lPj0Bks+rsOAgAkEoldgUATEB0BouQewy4L+/vs/igLkCRJexWlCdq9ye0exn6FBcg0zXq93pxzqdJJsvEgiGs6C9CLXM6yrObUb59j82cLomWm1QUZvu86CEI4NXXVfb1cQ08nAfZyBAAcK/DmmoCd7oJez80dT6crFe8yzT4GT8aB+cNdqlU9UBiXl97RvKdA/NcRCoU0TWsbRMiZn/9cKpX+dBaWe7F6GPf0Cd91of6B5trQghhnBzbXcDjc1hzo4yC0uLhQLL4yDGPbQPF4/OaN61sDbQRCODZ2/tnMDE0xiyVTFGV6+l4qlaIpZrSHZFm+c/uWz+cjVrLb1MFgMEaxF5l+y1R1kFjDFKTrX4k17EC1Wq1YLBLL2IEuTV7+fVOwSViAIISjo2ez2SxNMbmXRSKRoWRyaxSEULlcflko0P9S8+ZKCgeRwkGkcBApHEQKB5HyKwAA//8dEMgpImCtowAAAABJRU5ErkJggg==
mediatype: image/png
spec:
version: '1.0'
capabilities: Full Mocks
contracts:
- type: openapi
url: https://raw.githubusercontent.com/bump-sh-examples/train-travel-api/main/.microcks/openapi.yaml
links:
- name: Train Travel API on Github
url: https://github.com/bump-sh-examples/train-travel-api
maintainers:
- email: [email protected]
name: Christophe Dujarric
keywords:
- travel
- train