Skip to content
Snippets Groups Projects
Commit 3395e90b authored by David Schwarzmann's avatar David Schwarzmann
Browse files

Merge branch 'migrate-schemas-to-new-site' into 'main'

Migrate schema & spec to schema.fitko.de

See merge request fit-connect/api!64
parents db017790 5242770d
No related branches found
No related tags found
1 merge request!64Migrate schema & spec to schema.fitko.de
......@@ -38,7 +38,7 @@ build:spec:
- npm install -g @apidevtools/swagger-cli
- mkdir dist
script:
- cp metadata-schema/antragsmetadaten.schema.json dist/
- cp metadata-schema/antragsmetadaten.schema.json dist/metadata.schema.json
- swagger-cli bundle -t yaml -o dist/zustelldienst.yml spec/zustelldienst.yml
artifacts:
expose_as: 'Built API spec'
......@@ -110,8 +110,9 @@ upload:spec:
- *pre-deploy-uber-space-setup
script:
- sed -i "s,API_VERSION,$CI_COMMIT_TAG,g" dist/zustelldienst.yml
- sed -i "s,API_VERSION,$CI_COMMIT_TAG,g" dist/antragsmetadaten.schema.json
- rsync -rLvz --size-only --checksum -e "ssh -o CheckHostIP=no" --ipv4 --progress ./dist/. fitko@dorado.uberspace.de:html/$CI_COMMIT_TAG/
- sed -i "s,API_VERSION,$CI_COMMIT_TAG,g" dist/metadata.schema.json
- rsync -Lvz -e "ssh -o CheckHostIP=no" ./dist/zustelldienst.yml fitko@dorado.uberspace.de:schema.fitko.de/fit-connect/openapi/$CI_COMMIT_TAG/
- rsync -Lvz -e "ssh -o CheckHostIP=no" ./dist/metadata.schema.json fitko@dorado.uberspace.de:schema.fitko.de/fit-connect/metadata/$CI_COMMIT_TAG/
stop:doc:review:
stage: .post
......@@ -125,23 +126,3 @@ stop:doc:review:
- *pre-deploy-uber-space-setup
script:
- ssh fitko@dorado.uberspace.de "rm -rf html/preview/fit-connect/$CI_COMMIT_REF_SLUG"
#release-new-api-version:
# stage: release
# image: registry.gitlab.com/gitlab-org/release-cli:latest
# needs:
# - job: build
# artifacts: true
# only:
# refs:
# - main
# - tags
# variables:
# - $CI_COMMIT_TAG
# script:
# - release-cli -v
# - echo "Releasing new API version"
# - release-cli create --name "$CI_COMMIT_TAG" --description './docs/changelog.md'
# --tag-name $CI_COMMIT_TAG
# --assets-link '{"name":"combined-$CI_COMMIT_TAG","url":"https://fitko.uber.space/$CI_COMMIT_TAG/zustelldienst.yml"}'
......@@ -3,7 +3,7 @@ title: Metadaten
sidebar_position: 5
---
Die Antragsmetadaten beschreiben die Struktur der Einreichung und dessen Inhalte, wie beispielsweise Anhänge oder die Fachdaten. Zusätzlich können weitere Informationen über den/die AntragsstellerInnen hinterlegt werden. Eine genaue Definition ist unter XYZ zu finden bzw. direkt im [Schema](https://fitko.uber.space/0.9.2/antragsmetadaten.schema.json) zu finden.
Die Antragsmetadaten beschreiben die Struktur der Einreichung und dessen Inhalte, wie beispielsweise Anhänge oder die Fachdaten. Zusätzlich können weitere Informationen über den/die AntragsstellerInnen hinterlegt werden. Eine genaue Definition ist in der [Schema-Beschreibung](../../apis/application-metadata.mdx) zu finden.
Im Folgenden wird nun beschrieben, wie für das Versenden einer Einreichung das Schema aufgebaut und befüllt wird, sowie beim Empfangen einer Einreichung dieser entschlüsselt und gegen das Schema validiert wird.
......
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://fitko.uber.space/API_VERSION/antragsmetadaten.schema.json",
"$id": "https://schema.fitko.de/fit-connect/metadata/API_VERSION/metadata.schema.json",
"type": "object",
"title": "Antragsmetadaten",
"description": "",
......
......@@ -7,7 +7,7 @@ import BrowserOnly from '@docusaurus/BrowserOnly'
import useAsync from '@site/src/hooks/useAsync'
const SCHEMA_BASE_URL = 'https://docs.fitko.de'
const SCHEMA_BASE_URL = 'https://schema.fitko.de/fit-connect/openapi'
const getLatestVersion = async (siteVersion) => {
return axios.get('https://git.fitko.de/api/v4/projects/1/repository/tags')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment