Skip to content

Commit

Permalink
chore: Fix API references and ApiList
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Oct 24, 2020
1 parent da36dd2 commit e9a0ca6
Show file tree
Hide file tree
Showing 8 changed files with 42 additions and 50 deletions.
9 changes: 0 additions & 9 deletions docs/.vuepress/components/ButtonContact.vue

This file was deleted.

1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ module.exports = {
docsBranch: "production",
api: require("./public/api.json"),
smoothScroll: true,
lastUpdated: 'Last updated',
algolia: {
apiKey: "f8a038207e461aaac0e2fd16403c2b01",
indexName: "ts_ed"
Expand Down
26 changes: 13 additions & 13 deletions docs/.vuepress/styles/style.css
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
.hero-banner {
overflow: hidden;
overflow: hidden;
}

.animate-hero {
transform: scale(1.1);
transition: all ease-in-out 0.5s;
transition-delay: 0.5s;
transform: scale(1.1);
transition: all ease-in-out 0.5s;
transition-delay: 0.5s;
}

@screen sm {
.animate-hero {
transform: scale(1.2) translateY(50px) translateX(30px)
}
.animate-hero {
transform: scale(1.2) translateY(50px) translateX(30px)
}
}

@screen md {
.animate-hero {
transform: scale(1.1);
}
.animate-hero {
transform: scale(1.1);
}

.hero-banner:hover .animate-hero {
transform: scale(1.3) translateY(-20px) translateX(-20px) rotate(5deg);
}
.hero-banner:hover .animate-hero {
transform: scale(1.3) translateY(-20px) translateX(-20px) rotate(5deg);
}
}
4 changes: 2 additions & 2 deletions docs/docs/controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ map every corresponding request to this handler. Since we've declared a prefix f

Ts.ED provides a decorator for each HTTP verb which can be used to handle a request:

<ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
<ApiList query="tags:decorator AND tags:httpMethod" />

Other decorators are provided to describe your route with OpenSpec, adding middlewares, adding some constraints or adding headers:

Expand Down Expand Up @@ -412,4 +412,4 @@ Then, on your child controller:

## Decorators

<ApiList query="status.includes('decorator') && (status.includes('operation') || status.includes('controller'))" />
<ApiList query="tags: decorator AND operation OR controller"/>
2 changes: 1 addition & 1 deletion docs/docs/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,4 +206,4 @@ export class Server {

## Provided middlewares

<ApiList query="symbolType === 'class' && status.indexOf('middleware') > -1" />
<ApiList query="symbolType: class AND tags: middleware" />
10 changes: 5 additions & 5 deletions docs/tutorials/swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ meta:
---
# Swagger

<Banner src="https://swagger.io/swagger/media/assets/images/swagger_logo.svg" href="https://swagger.io/" :height="180" />
<Banner src="https://swagger.io/swagger/media/assets/images/swagger_logo.svg" href="https://swagger.io/" :height="200" />


This page shows you how you can configure Swagger-ui with Ts.ED. Swagger uses the OpenApi
Expand Down Expand Up @@ -123,17 +123,17 @@ document.addEventListener('swagger.init', (evt) => {

These decorators already add a documentation on Swagger:

<ApiList query="['Header', 'Status'].indexOf(symbolName) > -1 || (status.includes('decorator') && status.includes('schema'))" />
<ApiList query="((symbolName: Header OR Status) OR (tags: schema)) AND tags: decorator" />

In addition, the Ts.ED Swagger plugin gives some decorators to manage documentation:

<ApiList query="module === '@tsed/swagger' && symbolType === 'decorator'" />
<ApiList query="(symbolName: Docs OR Hidden) AND symbolType: decorator" />


## Authors

<GithubContributors users="['vologab', 'Romakita']"/>
<GithubContributors :users="['vologab', 'Romakita']"/>

## Maintainers

<GithubContributors users="['Romakita']"/>
<GithubContributors :users="['Romakita']"/>
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"consolidate": "0.16.0"
},
"devDependencies": {
"@tsed/markdown-it-symbols": "3.0.2",
"@tsed/markdown-it-symbols": "3.1.2",
"@tsed/monorepo-utils": "1.11.0",
"@typedproject/ts-doc": "4.0.9",
"@types/chai": "4.2.12",
Expand Down Expand Up @@ -122,7 +122,7 @@
"typescript": "4.0.2",
"vue-analytics": "5.22.1",
"vuepress": "1.7.1",
"vuepress-theme-tsed": "^3.1.0"
"vuepress-theme-tsed": "^3.1.2"
},
"directories": {
"packages": "packages",
Expand Down
36 changes: 18 additions & 18 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2325,10 +2325,10 @@
resolved "https://registry.yarnpkg.com/@tsed/markdown-it-symbols/-/markdown-it-symbols-2.15.0.tgz#0e1a1f0b72d6ae5e655228913befe617a5407dad"
integrity sha512-0l8P4k6bcRqwxzy8piMoDdS3fqgTw2gMO0xyI/woIqHm7yhbpmrleh2OAmc0bi5SJrrZv1aDUyeyeFoYP8B53g==

"@tsed/markdown-it-symbols@3.0.2":
version "3.0.2"
resolved "https://registry.yarnpkg.com/@tsed/markdown-it-symbols/-/markdown-it-symbols-3.0.2.tgz#a2139f38faad2b66b5d15c1ac62055f9a8154604"
integrity sha512-OmDap8xegZ7BsnLJB8QvmaXYZqx7bt0EeZSQ79t5g9sUCJhW02vn0TooDnqCaUovDr0zmFYFxWlD8nwoHI2wbA==
"@tsed/markdown-it-symbols@3.1.2":
version "3.1.2"
resolved "https://registry.yarnpkg.com/@tsed/markdown-it-symbols/-/markdown-it-symbols-3.1.2.tgz#429a415e4763ac3349c32d0efe60efe957083ab7"
integrity sha512-0Mvwfuf9Ein01F904YOMjAfc2PJKm1f8JoE/zo25284ya/xssXaFaOFgpMde+kDAHUrQ96JeryEGf+67d4t58w==

"@tsed/[email protected]":
version "1.11.0"
Expand All @@ -2352,10 +2352,10 @@
read-package-json "2.1.1"
semver "7.3.2"

"@tsed/[email protected].0":
version "3.1.0"
resolved "https://registry.yarnpkg.com/@tsed/vuepress-common/-/vuepress-common-3.1.0.tgz#fb49cd70e03977d69506fbebbf166a02a510203f"
integrity sha512-AjC6tiWPMv4CfToYQAA0TPfp5PguhPip7W+6F6K84CiyvJTvjIr5VYxaOh3cupNQTOfOjO82lCOTPUsc+1UAWA==
"@tsed/[email protected].2":
version "3.1.2"
resolved "https://registry.yarnpkg.com/@tsed/vuepress-common/-/vuepress-common-3.1.2.tgz#e87ade07e67575f1b96facb62740da731f1ffa0d"
integrity sha512-kAk403VE4ra3yHEOcIko98vdUDDB7Kfzy2OkptwdVqhfPqOKKGmKH8o4Irj83cT3CBMCgYYzqoWzEQ7/QLJp3A==
dependencies:
"@docsearch/css" "1.0.0-alpha.28"
"@docsearch/js" "1.0.0-alpha.28"
Expand All @@ -2366,10 +2366,10 @@
normalize.css "8.0.1"
prismjs "1.21.0"

"@tsed/[email protected].0":
version "3.1.0"
resolved "https://registry.yarnpkg.com/@tsed/vuepress-tailwind-config/-/vuepress-tailwind-config-3.1.0.tgz#4329ce76b019938c22c7c1689f5b2db08fadcc86"
integrity sha512-dUM73P1lfxm7qVMUebXtXYqZRtrn0kV1WVmeN85d7rgzn5un/EyluZL640Kv4kAkWbg1cF8uYiW+DpJ4lm1YlA==
"@tsed/[email protected].2":
version "3.1.2"
resolved "https://registry.yarnpkg.com/@tsed/vuepress-tailwind-config/-/vuepress-tailwind-config-3.1.2.tgz#b7b77fd0dbad07ee3bcffa2cfdf717c78358c230"
integrity sha512-Grt5q4wD0zfkxFwhSFR0fNCGHDWTj0sV6yb4aQMk7dqSYvmI3myWHR9DPcv9R7i5jS6AJVlH32H2fjECZ4MqLg==
dependencies:
tailwindcss "1.4.6"

Expand Down Expand Up @@ -16678,18 +16678,18 @@ vuepress-plugin-smooth-scroll@^0.0.9:
dependencies:
smoothscroll-polyfill "^0.4.4"

vuepress-theme-tsed@^3.1.0:
version "3.1.0"
resolved "https://registry.yarnpkg.com/vuepress-theme-tsed/-/vuepress-theme-tsed-3.1.0.tgz#cae2bd77efdbfa635563e7b0fa8197a2b7bf9111"
integrity sha512-w5paS66HEF8H+zD5dfogtGaY+N/HGH0ZgGfbAi97c15BPDW4dzoV9SWl5ZtTyiJcTwrfqAJmNEsVBrbS8rLXng==
vuepress-theme-tsed@^3.1.2:
version "3.1.2"
resolved "https://registry.yarnpkg.com/vuepress-theme-tsed/-/vuepress-theme-tsed-3.1.2.tgz#287fa3124a098570a4955b4a6a564c1adf26135c"
integrity sha512-a1MWd4uqGRKny7PrD3m3iIlcwy5Q16OU+PfMSJDD+a9PnN4hicQArKxNeciwO1iojKmDZ6mTcgv8Q/QVF6koZA==
dependencies:
"@docsearch/css" "1.0.0-alpha.28"
"@docsearch/js" "1.0.0-alpha.28"
"@sass-collective/sass-rem" "^1.4.1"
"@silvanite/vuepress-plugin-tailwind" "^1.3.0"
"@tsed/markdown-it-symbols" "2.15.0"
"@tsed/vuepress-common" "3.1.0"
"@tsed/vuepress-tailwind-config" "3.1.0"
"@tsed/vuepress-common" "3.1.2"
"@tsed/vuepress-tailwind-config" "3.1.2"
"@vuepress/plugin-active-header-links" "1.2.0"
"@vuepress/plugin-nprogress" "1.6.0"
"@vuepress/plugin-search" "1.2.0"
Expand Down

0 comments on commit e9a0ca6

Please sign in to comment.